GetCreatureProperty

This page was generated by Sunjammer's Dragon Age Script Parser.

The parser extracted and matched all the information required to the best of its ability however the parser relies on the source file, and especially a function's comments, to be correctly formatted. If the source file was not correctly formatted the information presented may be incomplete.

This page should be reviewed by a knowledgeable scripter as it may require updating. If an issue with the source file is identified it should be reported to BioWare.

Please remove the {{Generated}} tag once the page has been confirmed or corrected.

Get the specified attribute 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 Attribute 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 doesnt 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 plues 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.