GetCreatureProperty

Get the specified property from oCreature

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

Parameters:

oCreature

the creature whose stat is being requested

nProperty

the property (stat) we want to know about

nValueType

the type of value of the property we want to know about (TOTAL, BASE, CURRENT, MODIFIER)

Returns:

Returns oCreature's property value

Source:

script.ldf

Description

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.

See also

• SetCreatureProperty
• UpdateCreatureProperty
• PROPERTY_VALUE_*