Squirrel/Server/Functions/Spheres/CreateSphere

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(Syntax)
(Arguments)
Line 11: Line 11:
 
* '''pos''' - The location the sphere will spawn at
 
* '''pos''' - The location the sphere will spawn at
 
* '''radius''' - The radius of the sphere
 
* '''radius''' - The radius of the sphere
* '''col''' - The spheres colour
+
* '''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
  
 
== Example ==
 
== Example ==

Revision as of 23:47, 8 November 2010

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This function adds a new sphere to the game.

Syntax

  1. sphere CreateSphere( Vector pos, float radius, [ Colour col ] )
  1. sphere CreateSphere( Vector pos, float radius, [ int red, int green, int blue ] )

Arguments

  • pos - The location the sphere will spawn at
  • radius - The radius of the sphere
  • 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

Example

This will create a sphere for everyone aroud the player when they type '/globalsphere'

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. if ( szCommand == "globalsphere" )
  5. {
  6. CreateSphere( pPlayer.Pos, 5.00, 0 );
  7. }
  8. return 1;
  9. }
  10.  

Notes

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

Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox