Difference between revisions of "UpdateCreatureProperty"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (Adding title)
m (Fixing parameters)
 
Line 1: Line 1:
 
{{dafunction
 
{{dafunction
 
|name          = UpdateCreatureProperty
 
|name          = UpdateCreatureProperty
|brief        = Update the specified attribute base value on a oCreature
+
|brief        = Update the value of the specified property value on a creature.
 
|param1type    = object
 
|param1type    = object
 
|param1name    = oCreature
 
|param1name    = oCreature
|param1desc    = the creature whose property will be updated
+
|param1desc    = the creature whose property will be modified
 
|param1default =  
 
|param1default =  
 
|param2type    = int
 
|param2type    = int
 
|param2name    = nProperty
 
|param2name    = nProperty
|param2desc    = the property (stat) whose value we want to update
+
|param2desc    = the property whose value will be modified
 
|param2default =  
 
|param2default =  
 
|param3type    = float
 
|param3type    = float
 
|param3name    = fNewValue
 
|param3name    = fNewValue
|param3desc    =  
+
|param3desc    = the value to be added
 
|param3default =  
 
|param3default =  
 
|param4type    = int
 
|param4type    = int
 
|param4name    = nValueType
 
|param4name    = nValueType
|param4desc    = the type of value of the property we want to update (CURRENT, MODIFIER)
+
|param4desc    = the type of value of the property to modify (CURRENT, MODIFIER)
 
|param4default =  
 
|param4default =  
 
|returntype    = void
 
|returntype    = void
|returndesc    = Returns oCreature's Attribute Value
+
|returndesc    =  
 
|sourcefile    = script.ldf
 
|sourcefile    = script.ldf
 
|sourcemodule  =
 
|sourcemodule  =
Line 39: Line 39:
  
 
[[Category:Creature functions]]
 
[[Category:Creature functions]]
[[Category: Stats functions]]
+
[[Category:Stats functions]]

Latest revision as of 14:02, 11 January 2015

Update the value of the specified property value on a creature.

void UpdateCreatureProperty(
object oCreature,
int nProperty,
float fNewValue,
int nValueType
);
Parameters:
oCreature
the creature whose property will be modified
nProperty
the property whose value will be modified
fNewValue
the value to be added
nValueType
the type of value of the property to modify (CURRENT, MODIFIER)
Returns:

Nothing.

Source:

script.ldf

Description

Updates (adds the given value to the current value) the specified value of the selected property of a creature.

Only works for MODFIER and CURRENT values. See GetCreatureProperty for more details.

See also