Difference between revisions of "GetCreatureProperty"

Latest revision as of 14:02, 11 January 2015

Returns the value of the specified property from a creature.

float GetCreatureProperty(
    object oCreature,
    int nProperty,
    int nValueType = PROPERTY_VALUE_TOTAL
);

Parameters:

oCreature: the creature whose property is being requested
nProperty: the property whose value is being requested
nValueType: the type of property value to be returned (TOTAL, BASE, CURRENT, MODIFIER)

Get oCreature's property value.

Property types have slightly different definitions of each of the 4 value types:

A SIMPLE or DERIVED property has a BASE and TOTAL value as the same number and doesn't have CURRENT or MODIFIER.
An ATTRIBUTE property has a BASE value and a MODIFIER value. Its TOTAL value is the clamped (between its min and max) sum of the BASE plus the MODIFIER.
A DEPLETABLE property is similar to an ATTRIBUTE property but in addition has a CURRENT value, which must be between the property min and the TOTAL value.

Properties are defined in Properties.xls.

@@ Line 1: / Line 1: @@
 {{dafunction
 |name          = GetCreatureProperty
-|brief         = Get the specified property from oCreature
+|brief         = Returns the value of the specified property from a creature.
 |param1type    = object
 |param1name    = oCreature
-|param1desc    = the creature whose stat is being requested
+|param1desc    = the creature whose property is being requested
 |param1default =
 |param2type    = int
 |param2name    = nProperty
-|param2desc    = the property (stat) we want to know about
+|param2desc    = the property whose value is being requested
 |param2default =
 |param3type    = int
 |param3name    = nValueType
-|param3desc    = the type of value of the property we want to know about (TOTAL, BASE, CURRENT, MODIFIER)
+|param3desc    = the type of property value to be returned (TOTAL, BASE, CURRENT, MODIFIER)
 |param3default = PROPERTY_VALUE_TOTAL
 |returntype    = float
-|returndesc    = Returns oCreature's property value
+|returndesc    = Returns a creature's property value
 |sourcefile    = script.ldf
 |sourcemodule  =