Difference between revisions of "GetVehicleDamage"

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

Latest revision as of 09:45, 7 October 2019

GetVehicleDamage

Type: Function
Context: Server
Introduced: v1.0

Description

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

Syntax

GetVehicleDamage(vehicle, damageIndex)

Parameters

  • vehicle
    The vehicle identifier.
  • damageIndex
    Damage part of the vehicle between 1-8, depending on the vehicle.

Return Value

  • Returns a value between 0.0 (no damage) and 1.0 (full damage).

Example

__EDIT_ME__

See also

__EDIT_ME__