Squirrel/Server/Functions/Spheres/Radius

Revision as of 04:11, 8 March 2010

This Sphere class member returns or sets the radius of the given sphere.

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

float Sphere.Radius

Sphere.Radius = float fRadius

 
function onPlayerFootSphereHit( player, sphere )
{
	MessagePlayer( "The current radius of this sphere is: " + sphere.Radius, player )
}

This example will message the player with the current radius of the sphere.

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

This example will increase the radius of the sphere by 1 every time a player enters it.

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

@@ Line 13: / Line 13: @@
 == Example 1. Returning ==
-{{Squirrel/NeedsExample}}
 <code lang="squirrel">
--- todo
+function onPlayerFootSphereHit( player, sphere )
+{
+ MessagePlayer( "The current radius of this sphere is: " + sphere.Radius, player )
+}
 </code>
-=== Notes ===
+This example will message the player with the current radius of the sphere.
--- Example notes/used functions here
 == Example 2. Setting ==
-{{Squirrel/NeedsExample}}
 <code lang="squirrel">
--- todo
+function onPlayerFootSphereHit( player, sphere )
+{
+ sphere.Radius += 1;
+}
 </code>
+This example will increase the radius of the sphere by 1 every time a player enters it.
 === Notes ===
--- Example notes/used functions here
+The call [[Squirrel/Server/Events/Player/onPlayerFootSphereHit|onPlayerFootSphereHit]] was used in in this example. More info about this in the corresponding page.
 == Related Functions ==
 {{Squirrel/Server/Functions/Spheres}}