Squirrel/Server/Functions/Pickups/RespawnTime

Latest revision as of 18:29, 16 March 2011

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 seconds.

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

 
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 = 10;
	
	return 1;
}

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

@@ Line 10: / Line 10: @@
 == Arguments ==
-* '''iRespawnTime''' - This is the new respawn time for the pickup as a Integer in '''milliseconds'''.
+* '''iRespawnTime''' - This is the new respawn time for the pickup as a Integer in '''seconds'''.
 == Example 1. Returning ==
-This will tell the player how long it will take the pickup to respawn in milliseconds.
+This will tell the player how long it will take the pickup to respawn in seconds.
 <code lang="squirrel">
@@ Line 36: / Line 36: @@
 function onPickupPickedUp( pPlayer, pPickup )
 {
- pPickup.RespawnTime = 10000;
+ pPickup.RespawnTime = 10;
  return 1;