Squirrel/Server/Functions/Vehicles/SetWheelStatus

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(Example)
m (Fixed a typo (tyre -> tire))
 
Line 10: Line 10:
 
* '''status''' - The [[Squirrel/Server/Constants#Vehicle_Wheel_States|status code]] of the wheel:
 
* '''status''' - The [[Squirrel/Server/Constants#Vehicle_Wheel_States|status code]] of the wheel:
 
** WHEELSTATUS_OK - The wheel is fine
 
** WHEELSTATUS_OK - The wheel is fine
** WHEELSTATUS_FLAT - Flat tyre
+
** WHEELSTATUS_FLAT - Flat tire
 
** WHEELSTATUS_FUCKED - Completely missing a wheel
 
** WHEELSTATUS_FUCKED - Completely missing a wheel
  

Latest revision as of 05:53, 17 November 2012

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

This Vehicle class method will set the status of the given wheel.

[edit] Syntax

  1. bool Vehicle.SetWheelStatus( int wheel, int status )

[edit] Arguments

  • wheel - The wheel you wish to set the status of. A list of vehicle wheel constants can be found from here
  • status - The status code of the wheel:
    • WHEELSTATUS_OK - The wheel is fine
    • WHEELSTATUS_FLAT - Flat tire
    • WHEELSTATUS_FUCKED - Completely missing a wheel

[edit] Example

  1.  
  2. function onPlayerCommand( pPlayer, szCommand, szText )
  3. {
  4. if ( szCommand == "setwheel" )
  5. {
  6. if ( pPlayer.Vehicle ) pPlayer.Vehicle.SetWheelStatus( WHEEL_FRONTLEFT, WHEELSTATUS_FLAT );
  7. }
  8. return 1;
  9. }
  10.  

[edit] Notes

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

[edit] Related Functions

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox