Squirrel/Server/Events/Vehicle/onVehicleRespawn

Latest revision as of 13:14, 11 November 2010

This is called whenever a vehicle is respawned.

function onVehicleRespawn( Vehicle vehicle )

This event does not handle return values.

This example will print a message to the console whenever a vehicle respawns.

 
function onVehicleRespawn( vehicle )
{
     print( "Vehicle " + vehicle.ID + " has respawned." );
     
     return 1;
}

The functions Vehicle.ID and print were used in this example. More info about them can be found in the corresponding pages.

@@ Line 1: / Line 1: @@
-__NOTOC__
+{{Squirrel/Title|onVehicleRespawn}}
-This is called whenever a vehicle is respawned, for any reason EXCEPT respawn after explosion
+This is called whenever a vehicle is respawned.
 == Syntax ==
-<code>function onVehicleRespawn( vehicle )</code>
+<code>function onVehicleRespawn( Vehicle vehicle )</code>
-== Parameters ==
+=== Arguments ===
-* '''vehicle''' - The vehicle pointer
+* '''vehicle''' - The vehicle which respawned
+=== Returns ===
+This event does not handle return values.
 == Example ==
-This example will print a message to the console whenever a vehicle is respawned
+This example will print a message to the console whenever a vehicle respawns.
 <code lang="squirrel">
 function onVehicleRespawn( vehicle )
 {
-     print( "Vehicle " + vehicle.ID() + " has respawned." );
+     print( "Vehicle " + vehicle.ID + " has respawned." );
+    return 1;
 }
 </code>
@@ Line 23: / Line 29: @@
 === Notes ===
-The function [[Squirrel/Server/Functions/Vehicles/ID|vehicle.ID]] was used in in this example. More info about it can be found in the corresponding page.
+The functions [[Squirrel/Server/Functions/Vehicles/ID|Vehicle.ID]] and [[Squirrel/Server/Functions/Misc/print|print]] were used in this example. More info about them can be found in the corresponding pages.
 == Related Events ==
 {{Squirrel/Server/Events/Vehicle}}