GetCreatureProperty - Revision history

Sunjammer: Fixing parameters

2015-01-11T13:02:17Z

Fixing parameters

Sunjammer: Adding category

2015-01-11T12:27:12Z

Adding category

Sunjammer: Adding links, correcting text

2015-01-11T12:26:15Z

Adding links, correcting text

Sunjammer: Updating link

2011-08-03T18:14:40Z

Updating link

BryanDerksen: looks okay, removing tag, formatting, adding a link

2010-03-02T18:02:19Z

looks okay, removing tag, formatting, adding a link

Sunjammer: Generated by Sunjammer's Dragon Age Script Paser

2009-07-31T22:37:17Z

Generated by Sunjammer's Dragon Age Script Paser

BryanDerksen: 1 revision: re-import with default parameter value parameters set

2009-07-31T22:08:21Z

1 revision: re-import with default parameter value parameters set

BryanDerksen: 1 revision: Importing auto-generated function articles

2009-07-29T15:49:29Z

1 revision: Importing auto-generated function articles

Sunjammer: Generated by Sunjammer's Dragon Age Script Paser

2009-07-29T01:40:43Z

Generated by Sunjammer's Dragon Age Script Paser

New page

{{Generated}}
{{dafunction
|name=GetCreatureProperty
|brief=Get the specified attribute from oCreature
|param1type=object
|param1name=oCreature
|param1desc=the creature whose stat is being requested
|param2type=int
|param2name=nProperty
|param2desc=the property (stat) we want to know about
|param3type=int
|param3name=nValueType
|param3desc=the type of value of the property we want to know about (TOTAL, BASE, CURRENT, MODIFIER)
|returntype=float
|returndesc=Returns oCreature's Attribute Value
|sourcefile=script.ldf
|sourcemodule=
}}

== 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.










[[Category: Stats functions]]

@@ Line 1: / Line 1: @@
 {{dafunction
 |name          = GetCreatureProperty
-|brief         = Get the specified property from oCreature
+|brief         = Returns the value of the specified property from a creature.
 |param1type    = object
 |param1name    = oCreature
-|param1desc    = the creature whose stat is being requested
+|param1desc    = the creature whose property is being requested
 |param1default =
 |param2type    = int
 |param2name    = nProperty
-|param2desc    = the property (stat) we want to know about
+|param2desc    = the property whose value is being requested
 |param2default =
 |param3type    = int
 |param3name    = nValueType
-|param3desc    = the type of value of the property we want to know about (TOTAL, BASE, CURRENT, MODIFIER)
+|param3desc    = the type of property value to be returned (TOTAL, BASE, CURRENT, MODIFIER)
 |param3default = PROPERTY_VALUE_TOTAL
 |returntype    = float
-|returndesc    = Returns oCreature's property value
+|returndesc    = Returns a creature's property value
 |sourcefile    = script.ldf
 |sourcemodule  =

← Older revision		Revision as of 12:27, 11 January 2015
Line 40:		Line 40:
	* [[PROPERTY_VALUE_*]]		* [[PROPERTY_VALUE_*]]

		+	[[Category:Creature functions]]
	[[Category:Stats functions]]		[[Category:Stats functions]]

@@ Line 1: / Line 1: @@
 {{dafunction
-|name=GetCreatureProperty
+|name          = GetCreatureProperty
-|brief=Get the specified attribute from oCreature
+|brief         = Get the specified property from oCreature
-|param1type=object
+|param1type    = object
-|param1name=oCreature
+|param1name    = oCreature
-|param1desc=the creature whose stat is being requested
+|param1desc    = the creature whose stat is being requested
-|param1default=
+|param1default =
-|param2type=int
+|param2type    = int
-|param2name=nProperty
+|param2name    = nProperty
-|param2desc=the property (stat) we want to know about
+|param2desc    = the property (stat) we want to know about
-|param2default=
+|param2default =
-|param3type=int
+|param3type    = int
-|param3name=nValueType
+|param3name    = nValueType
-|param3desc=the type of value of the property we want to know about (TOTAL, BASE, CURRENT, MODIFIER)
+|param3desc    = the type of value of the property we want to know about (TOTAL, BASE, CURRENT, MODIFIER)
-|param3default=PROPERTY_VALUE_TOTAL
+|param3default = PROPERTY_VALUE_TOTAL
-|returntype=float
+|returntype    = float
-|returndesc=Returns oCreature's Attribute Value
+|returndesc    = Returns oCreature's property value
-|sourcefile=script.ldf
+|sourcefile    = script.ldf
-|sourcemodule=
+|sourcemodule  =
 }}
 == Description ==
 <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
-Get oCreature's Property value.
+Get oCreature's property value.
-Property types have slightly different definitions of each of the 4 value types.
+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.
+* 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 plues the 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.
+* 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]].
 <!-- == Remarks == -->
 <!-- This section contains additional comments, observations and known issues. -->
 <!-- == Examples == -->
 <!-- This section contains examples transcluded from the snippet library. -->
 == See also ==
 <!-- This section contains links to articles, functions or constant groups. -->
+* [[SetCreatureProperty]]
-[[PROPERTY_VALUE_*]]
+* [[UpdateCreatureProperty]]
 [[Category:Stats functions]]

@@ Line 41: / Line 41: @@
 <!-- This section contains links to articles, functions or constant groups. -->
-[[PROPERTY_VALUE*]]
+[[PROPERTY_VALUE_*]]
-[[Category: Stats functions]]
+[[Category:Stats functions]]

← Older revision	Revision as of 22:08, 31 July 2009
(No difference)

← Older revision	Revision as of 15:49, 29 July 2009
(No difference)