Squirrel/Server/Functions/Vehicles/Locked

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
m (Fixed a typo)
 
Line 10: Line 10:
 
== Arguments ==
 
== Arguments ==
  
−
* '''locked''' - A boolean representing whether the vehicles doors should be locled (''true'') or unlocked (''false'')
+
* '''locked''' - A boolean representing whether the vehicles doors should be locked (''true'') or unlocked (''false'')
  
 
== Example 1. Returning ==
 
== Example 1. Returning ==

Latest revision as of 18:33, 1 October 2010

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

This Vehicle class member returns whether the vehicle's doors are locked or locks/unlocks the doors.

[edit] Syntax

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

  1. bool Vehicle.Locked
  1. Vehicle.Locked = bool locked

[edit] Arguments

  • locked - A boolean representing whether the vehicles doors should be locked (true) or unlocked (false)

[edit] Example 1. Returning 

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. 	if ( szCommand == "lock" )
  5. 	{
  6. 		if ( pPlayer.Vehicle ) MessagePlayer( "Your lock state is currently set to " + pPlayer.Vehicle.Locked, 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 

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. 	if ( szCommand == "lock2" )
  5. 	{
  6. 		if ( pPlayer.Vehicle ) pPlayer.Vehicle.Locked = true;
  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/Locked&oldid=1796"
Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox