GetCreatureProperty

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)

Returns:

Returns a creature'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_*