Squirrel/Server/Functions/Spheres/Colour
From Liberty Unleashed Wiki
(Difference between revisions)
(New page: __NOTOC__ This ''Sphere'' class member returns or sets the colour ID of the sphere. == Syntax == You can either return or set a new value using this member: <code>int Sphere.Colour</code>...) |
(→Example 1. Returning) |
||
Line 13: | Line 13: | ||
== Example 1. Returning == | == Example 1. Returning == | ||
− | |||
<code lang="squirrel"> | <code lang="squirrel"> | ||
− | + | function onPlayerFootSphereHit( player, sphere ) | |
+ | { | ||
+ | MessagePlayer( "This sphere currently has the colour: " + sphere.Colour, player ); | ||
+ | } | ||
</code> | </code> | ||
+ | |||
+ | This will message the player with the spheres colour when they hit it. | ||
=== Notes === | === Notes === | ||
− | + | The call [[Squirrel/Server/Events/Player/onPlayerFootSphereHit|onPlayerFootSphereHit]] was used in in this example. More info about this in the corresponding page. | |
== Example 2. Setting == | == Example 2. Setting == |
Revision as of 03:54, 8 March 2010
This Sphere class member returns or sets the colour ID of the sphere.
Syntax
You can either return or set a new value using this member:
int Sphere.Colour
Sphere.Colour = int newcol
Arguments
- newcol - This is the new colour for the sphere as an integer
Example 1. Returning
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.
Notes
The call onPlayerFootSphereHit was used in in this example. More info about this in the corresponding page.
Example 2. Setting
This function needs an example. You can help us complete the wiki by writing one, or maybe even more :o
-- todo
Notes
-- Example notes/used functions here