Squirrel/Server/Functions/Pickups/InstantRespawn

Revision as of 16:52, 23 October 2010

This Pickup class member returns/sets whether the given pickup respawns when you hit it.

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

Bool pickup.InstantRespawn

pickup.InstantRespawn = bool bRespawn

bRespawn - A boolean representing whether the given pickup respawns when you hit it.

This will tell the player the current InstantRespawn state of the collected pickup

 
function onPickupPickedUp( pPlayer, pPickup )
{
	MessagePlayer( "Pickup Instant Respawn: " + pPickup.Instant Respawn, 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 collected pickup to Instant Respawn.

 
function onPickupPickedUp( pPlayer, pPickup )
{
	pPickup.InstantRespawn = true;
	
	return 1;
}

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

@@ Line 12: / Line 12: @@
 * '''bRespawn''' - A boolean representing whether the given pickup respawns when you hit it.
-== Example ==
+== Example 1. Returning ==
-{{Squirrel/NeedsExample}}
+This will tell the player the current InstantRespawn state of the collected pickup
-Explanation for the example
 <code lang="squirrel">
--- Todo
+function onPickupPickedUp( pPlayer, pPickup )
+{
+	MessagePlayer( "Pickup Instant Respawn: " + pPickup.Instant Respawn, pPlayer );
+	return 1;
+}
 </code>
 === Notes ===
--- List of used functions and other notes here.
+The function [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]] and event [[Squirrel/Server/Events/Pickup/onPickupPickedUp|onPickupPickedUp]] were used in this example. More info about them in the corresponding pages.
+== Example 2. Setting ==
+This will set the collected pickup to Instant Respawn.
+<code lang="squirrel">
+function onPickupPickedUp( pPlayer, pPickup )
+{
+	pPickup.InstantRespawn = true;
+	return 1;
+}
+</code>
+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}}