Squirrel/Server/Functions/Pickups/RespawnTime

Revision as of 18:39, 23 October 2010

This Pickup class member returns or sets the respawn time of the given pickup.

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

Integer pickup.RespawnTime

pickup.RespawnTime = integer iRespawnTime

iRespawnTime - This is the new respawn time for the pickup as a Integer in milliseconds.

This will tell the player how long it will take the pickup to respawn in milliseconds.

 
function onPickupPickedUp( pPlayer, pPickup )
{
	MessagePlayer( "Pickup Respawn time: " + pPickup.RespawnTime, pPlayer );
	
	return 1;
}

The function MessagePlayer and event onPickupPickedUp were used in this example. More info about them in the corresponding pages.

This will set the respawn time of the collected pickup to 10 seconds.

 
function onPickupPickedUp( pPlayer, pPickup )
{
	pPickup.RespawnTime = 10000;
	
	return 1;
}

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

@@ Line 31: / Line 31: @@
 == Example 2. Setting ==
-Explanation of what this function does.
+This will set the respawn time of the collected pickup to 10 seconds.
 <code lang="squirrel">
--- Todo
+function onPickupPickedUp( pPlayer, pPickup )
+{
+ pPickup.RespawnTime = 10000;
+ return 1;
+}
 </code>
 === Notes ===
-List of used functions and events including links to their corresponding pages.
+The event [[Squirrel/Server/Events/Pickup/onPickupPickedUp|onPickupPickedUp]] was used in this example. More info about this in the corresponding page.
 == Related Functions ==
 {{Squirrel/Server/Functions/Pickups}}