Difference between revisions of "SetVehicleDamage"

From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetVehicleDamage(vehicle, damageIndex, damage)}} {{FuncParameters}} {{FuncParam|vehicle|__EDIT_ME_...")
 
 
Line 1: Line 1:
 
{{Info|Function|Server|1.0}}
 
{{Info|Function|Server|1.0}}
  
{{FuncDescription|__EDIT_ME__}}
+
{{FuncDescription|Sets the vehicle damage for a specific part/region of the vehicle. }}
  
 
{{FuncSyntax|SetVehicleDamage(vehicle, damageIndex, damage)}}
 
{{FuncSyntax|SetVehicleDamage(vehicle, damageIndex, damage)}}
  
 
{{FuncParameters}}
 
{{FuncParameters}}
{{FuncParam|vehicle|__EDIT_ME__}}
+
{{FuncParam|vehicle|Vehicle identifier.}}
{{FuncParam|damageIndex|__EDIT_ME__}}
+
{{FuncParam|damageIndex|Damage part of the vehicle between 1-8, depending on the vehicle.}}
{{FuncParam|damage|__EDIT_ME__}}
+
{{FuncParam|damage|Value between 0.0 (no damage) and 1.0 (full damage).}}
  
{{FuncReturnValue|__EDIT_ME__}}
+
{{FuncReturnValue|Returns '''true''' on success.}}
  
 
== Example ==
 
== Example ==

Latest revision as of 09:50, 7 October 2019

SetVehicleDamage

Type: Function
Context: Server
Introduced: v1.0

Description

Sets the vehicle damage for a specific part/region of the vehicle.

Syntax

SetVehicleDamage(vehicle, damageIndex, damage)

Parameters

  • vehicle
    Vehicle identifier.
  • damageIndex
    Damage part of the vehicle between 1-8, depending on the vehicle.
  • damage
    Value between 0.0 (no damage) and 1.0 (full damage).

Return Value

  • Returns true on success.

Example

__EDIT_ME__

See also

__EDIT_ME__