Squirrel/Server/Functions/Spheres/Colour

Revision as of 23:50, 8 November 2010

This Sphere class member returns or sets the colour ID of the sphere.

You can either return or set a new value using this member:

Colour Sphere.Colour

Sphere.Colour = Colour col

 
function onPlayerFootSphereHit( player, sphere )
{
	MessagePlayer( "This sphere currently has the colour: " + sphere.Colour, player );
}

This will message the player with the spheres colour when they hit it.

The call onPlayerFootSphereHit was used in in this example. More info about this in the corresponding page.

 
function onPlayerFootSphereHit( player, sphere )
{
	sphere.Colour = 1;
}

This will set the sphere to colour 1 when it is hit.

The call onPlayerFootSphereHit was used in in this example. More info about this in the corresponding page.

@@ Line 9: / Line 9: @@
 == Arguments ==
-* '''newcol''' - This is the new colour for the sphere as an integer
+* '''col''' - This is the pointer to a pre-defined RGB colour object.
 == Example 1. Returning ==