Squirrel/Server/Functions/Spheres/CreateClientSphere

Latest revision as of 23:45, 8 November 2010

This function adds a new sphere to the game for the player specified.

[edit] Syntax

sphere CreateClientSphere( Vector pos, float radius, player plr )

sphere CreateClientSphere( Vector pos, float radius, Colour col, player plr )

sphere CreateClientSphere( Vector pos, float radius, int red, int green, int blue, player plr )

[edit] Arguments

• pos - The location the sphere will spawn at
• radius - The radius of the sphere
• plr - The player to spawn the sphere for
• col - The colour of the sphere as a Colour object. If no colour is used the sphere will default to blue
• red, green, blue - The colour of the sphere as separate RGB values

[edit] Example

This will create a client sphere around the player when they type '/sphere'.

 
function onPlayerCommand( pPlayer, szCommand, szText )
{
	if ( szCommand == "sphere" )
	{
		CreateClientSphere( pPlayer.Pos, 5.00, Colour( 0, 0, 255 ), pPlayer );
	}
	
	return 1;
}
 

[edit] Notes

The event onPlayerCommand was used in this example. More info about this in the corresponding page.

[edit] Related Functions

• CreateClientSphere
• CreateSphere
• FindSphere
• GetSphereCount
• Sphere.Colour
• Sphere.ID
• Sphere.Owner
• Sphere.Pos
• Sphere.Radius
• Sphere.Remove
• Sphere.Type
• Sphere.VirtualWorld