Squirrel/Server/Functions/Pickups/RespawnTime
From Liberty Unleashed Wiki
(Difference between revisions)
Line 31: | Line 31: | ||
== Example 2. Setting == | == Example 2. Setting == | ||
− | + | This will set the respawn time of the collected pickup to 10 seconds. | |
<code lang="squirrel"> | <code lang="squirrel"> | ||
− | + | function onPickupPickedUp( pPlayer, pPickup ) | |
+ | { | ||
+ | pPickup.RespawnTime = 10000; | ||
+ | |||
+ | return 1; | ||
+ | } | ||
</code> | </code> | ||
=== Notes === | === Notes === | ||
− | + | The event [[Squirrel/Server/Events/Pickup/onPickupPickedUp|onPickupPickedUp]] was used in this example. More info about this in the corresponding page. | |
== Related Functions == | == Related Functions == | ||
{{Squirrel/Server/Functions/Pickups}} | {{Squirrel/Server/Functions/Pickups}} |
Revision as of 18:39, 23 October 2010
This Pickup class member returns or sets the respawn time of the given pickup.
Syntax
You can either return or set a new value using this member:
Integer pickup.RespawnTime
pickup.RespawnTime = integer iRespawnTime
Arguments
- iRespawnTime - This is the new respawn time for the pickup as a Integer in milliseconds.
Example 1. Returning
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; }
Notes
The function MessagePlayer and event onPickupPickedUp were used in this example. More info about them in the corresponding pages.
Example 2. Setting
This will set the respawn time of the collected pickup to 10 seconds.
function onPickupPickedUp( pPlayer, pPickup ) { pPickup.RespawnTime = 10000; return 1; }
Notes
The event onPickupPickedUp was used in this example. More info about this in the corresponding page.