Difference between revisions of "SetCreatureProperty"
From Dragon Age Toolset Wiki
m (Adding links and category, fixing text) |
m (Fixing parameters) |
||
| Line 1: | Line 1: | ||
{{dafunction | {{dafunction | ||
|name = SetCreatureProperty | |name = SetCreatureProperty | ||
| − | |brief = Set the | + | |brief = Set the value of the specified property on a creature. |
|param1type = object | |param1type = object | ||
|param1name = oCreature | |param1name = oCreature | ||
| − | |param1desc = the creature whose property | + | |param1desc = the creature whose property will be modified |
|param1default = | |param1default = | ||
|param2type = int | |param2type = int | ||
|param2name = nProperty | |param2name = nProperty | ||
| − | |param2desc = the property | + | |param2desc = the property whose value will be modified |
|param2default = | |param2default = | ||
|param3type = float | |param3type = float | ||
|param3name = fNewValue | |param3name = fNewValue | ||
| − | |param3desc = the value | + | |param3desc = the value to be used |
|param3default = | |param3default = | ||
|param4type = int | |param4type = int | ||
|param4name = nValueType | |param4name = nValueType | ||
| − | |param4desc = the type of value of the property | + | |param4desc = the type of value of the property to modify (BASE, CURRENT, MODIFIER) |
|param4default = PROPERTY_VALUE_BASE | |param4default = PROPERTY_VALUE_BASE | ||
|returntype = void | |returntype = void | ||
| − | |returndesc = | + | |returndesc = |
|sourcefile = script.ldf | |sourcefile = script.ldf | ||
|sourcemodule = | |sourcemodule = | ||
Latest revision as of 14:02, 11 January 2015
Set the value of the specified property on a creature.
void SetCreatureProperty(
object oCreature,
int nProperty,
float fNewValue,
int nValueType = PROPERTY_VALUE_BASE
);
object oCreature,
int nProperty,
float fNewValue,
int nValueType = PROPERTY_VALUE_BASE
);
- Parameters:
- oCreature
- the creature whose property will be modified
- nProperty
- the property whose value will be modified
- fNewValue
- the value to be used
- nValueType
- the type of value of the property to modify (BASE, CURRENT, MODIFIER)
- Returns:
- Nothing.
- Source:
- script.ldf
Description
Sets the specified value of the selected property on a creature.
It does not work for TOTAL values: use the BASE value instead. See GetCreatureProperty for more details.
