Difference between revisions of "DamageObject"

From GECK

m (Robot: Automated text replacement (-\[\[Category:(.*?)\(GECK 1.0\)\]\] +Category:\1(GECK 1.1)))
 
Line 1: Line 1:
=='''Description'''==
+
{{Function
 +
|origin = GECK1
 +
|summary = Applies damage to a destructible object which is not already destroyed. Does not work for objects which have health (such as weapons). It is called on a reference and takes a float which is the amount of damage to apply.
 +
|name = DamageObject
 +
|alias = DO
 +
|returnType = void
 +
|referenceType = [ObjectRefID]
 +
|arguments =
 +
  {{FunctionArgument
 +
  |Name = Value
 +
  |Type = float
 +
  }}
 +
|example = CarRef.DamageObject 25.4
  
'''DamageObject''' Applies damage to a destructible object which is not already destroyed. Does not work for objects which have health (such as weapons). It is called on a reference and takes a float which is the amount of damage to apply.
+
  carRef.do 25.4
 
+
=='''Syntax'''==
+
 
+
[''ObjectREF''.]DamageObject ''float ''
+
 
+
=='''Examples'''==
+
 
+
  CarRef.DamageObject 25.4
+
 
The car will take 25.4 points of damage.
 
The car will take 25.4 points of damage.
 +
}}
  
carRef.do 25.4
+
==See Also==
 
+
*[[ClearDestruction]]
=='''Notes'''==
+
*None at this time
+
 
+
 
+
=='''See Also'''==
+
[[ClearDestruction]]
+
 
+
=='''Reference'''==
+
None provided.
+
<!-- [[DamageObject_Reference|List of functions that use DamageObject]]  (wiki) -->
+
  
 
[[Category:Functions]]
 
[[Category:Functions]]

Latest revision as of 07:06, 15 January 2011

A function included in the GECK version 1.1.0.36.

Description

Applies damage to a destructible object which is not already destroyed. Does not work for objects which have health (such as weapons). It is called on a reference and takes a float which is the amount of damage to apply.

Syntax

[ObjectRefID].DamageObject Value:float 

Or:

[ObjectRefID].DO Value:float

Example

CarRef.DamageObject 25.4
carRef.do 25.4

The car will take 25.4 points of damage.

See Also

Personal tools