Squirrel/Server/Functions/Vehicles/SpawnPos

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with '{{Squirrel/Title|Vehicle.SpawnPos}} This ''Vehicle'' class member returns or sets the spawn position of the given vehicle. The vehicle will be teleported to this position after i…')
 
 
Line 14: Line 14:
 
== Example 1. Returning the value ==
 
== Example 1. Returning the value ==
  
−
{{Squirrel/NeedsExample}}
 
 
<code lang="squirrel">
 
<code lang="squirrel">
−
-- todo
+
function onPlayerCommand( pPlayer, szCommand, szText )
 +
{
 +
if ( szCommand == "spawnpos" )
 +
{
 +
if ( pPlayer.Vehicle ) MessagePlayer( "Your vehicle's spawn angle is currently - " + pPlayer.Vehicle.SpawnPos, pPlayer );
 +
}
 +
 +
return 1;
 +
}
 
</code>
 
</code>
  
 
=== Notes ===
 
=== Notes ===
  
−
Example notes and used functions here.
+
The function [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]] and event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.
  
 
== Example 2. Setting a new value ==
 
== Example 2. Setting a new value ==
  
−
{{Squirrel/NeedsExample}}
 
 
<code lang="squirrel">
 
<code lang="squirrel">
−
-- todo
+
function onPlayerCommand( pPlayer, szCommand, szText )
 +
{
 +
if ( szCommand == "spawnpos2" )
 +
{
 +
if ( pPlayer.Vehicle ) pPlayer.Vehicle.SpawnPos = Vector( 100.00, 100.00, 2.00 );
 +
}
 +
 +
return 1;
 +
}
 
</code>
 
</code>
  
 
=== Notes ===
 
=== Notes ===
  
−
Example notes and used functions here.
+
The event [[Squirrel/Server/Events/Player/onPlayerCommand|onPlayerCommand]] was used in this example. More info about this in the corresponding page.
  
 
== Related Functions ==
 
== Related Functions ==
  
 
{{Squirrel/Server/Functions/Vehicles}}
 
{{Squirrel/Server/Functions/Vehicles}}

Latest revision as of 17:41, 29 September 2010

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This Vehicle class member returns or sets the spawn position of the given vehicle. The vehicle will be teleported to this position after it respawns.

[edit] Syntax

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

  1. Vector Vehicle.SpawnPos
  1. Vehicle.SpawnPos = Vector vPos

[edit] Arguments

  • vPos - This is the new spawn position for the vehicle as a vector

[edit] Example 1. Returning the value 

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. 	if ( szCommand == "spawnpos" )
  5. 	{
  6. 		if ( pPlayer.Vehicle ) MessagePlayer( "Your vehicle's spawn angle is currently - " + pPlayer.Vehicle.SpawnPos, pPlayer );
  7. 	}
  8. 	
  9. 	return 1;
  10. }
  11.  

[edit] Notes

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

[edit] Example 2. Setting a new value 

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. 	if ( szCommand == "spawnpos2" )
  5. 	{
  6. 		if ( pPlayer.Vehicle ) pPlayer.Vehicle.SpawnPos = Vector( 100.00, 100.00, 2.00 );
  7. 	}
  8. 	
  9. 	return 1;
  10. }
  11.  

[edit] Notes

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

[edit] Related Functions

Retrieved from "http://liberty-unleashed.co.uk/libertywiki/index.php?title=Squirrel/Server/Functions/Vehicles/SpawnPos&oldid=1782"
Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox