Difference between revisions of "Ambient OverrideBehaviour"
From Dragon Age Toolset Wiki
(Created page with '{{dafunction |name=Ambient_OverrideBehaviour |brief=Overrides a creature's predefined ambient behaviour. |param1type=object |param1name=oCreature |param1desc=The creature perform...') |
|||
| Line 1: | Line 1: | ||
{{dafunction | {{dafunction | ||
| − | |name=Ambient_OverrideBehaviour | + | |name = Ambient_OverrideBehaviour |
| − | |brief=Overrides a creature's predefined ambient behaviour. | + | |brief = Overrides a creature's predefined ambient behaviour. |
| − | |param1type=object | + | |param1type = object |
| − | |param1name=oCreature | + | |param1name = oCreature |
| − | |param1desc=The creature performing the ambient behaviour. | + | |param1desc = The creature performing the ambient behaviour. |
| − | |param2type= | + | |param2type = |
| − | |param2name=nAnimPattern | + | |param2name = nAnimPattern |
| − | |param2desc=The name of the integer variable to store | + | |param2desc = The name of the integer variable to store |
| − | |param3type=float | + | |param3type = float |
| − | |param3name=fAnimFreq | + | |param3name = fAnimFreq |
| − | |param3desc=The override animation frequency | + | |param3desc = The override animation frequency |
| − | |param4type=float | + | |param4type = float |
| − | |param4name=fAnimFreq | + | |param4name = fAnimFreq |
| − | |param4desc=The number of times the override animation pattern is to be played (-1 for infinite). | + | |param4desc = The number of times the override animation pattern is to be played (-1 for infinite). |
| − | |returntype= | + | |returntype = |
| − | |returndesc= | + | |returndesc = |
| − | |sourcefile= sys_ambient_h | + | |sourcefile = sys_ambient_h |
|sourcemodule= | |sourcemodule= | ||
}} | }} | ||
| Line 22: | Line 22: | ||
== Description == | == Description == | ||
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | ||
| + | Overrides the ambient behaviour animation pattern and animation frequency defined by the creature template. -1.0 to play all animations in order | ||
== Remarks == | == Remarks == | ||
| Line 28: | Line 29: | ||
<!-- == Examples == --> | <!-- == Examples == --> | ||
<!-- This section contains examples transcluded from the snippet library. --> | <!-- This section contains examples transcluded from the snippet library. --> | ||
| + | |||
== See also == | == See also == | ||
<!-- This section contains links to articles, functions or constant groups. --> | <!-- This section contains links to articles, functions or constant groups. --> | ||
Revision as of 13:19, 31 January 2011
Overrides a creature's predefined ambient behaviour.
[[ keyword|]] Ambient_OverrideBehaviour(
object oCreature,
[[ keyword|]] nAnimPattern,
float fAnimFreq,
float fAnimFreq
);
object oCreature,
[[ keyword|]] nAnimPattern,
float fAnimFreq,
float fAnimFreq
);
- Parameters:
- oCreature
- The creature performing the ambient behaviour.
- nAnimPattern
- The name of the integer variable to store
- fAnimFreq
- The override animation frequency
- fAnimFreq
- The number of times the override animation pattern is to be played (-1 for infinite).
- Returns:
- [Undocumented]
- Source:
- sys_ambient_h
Description
Overrides the ambient behaviour animation pattern and animation frequency defined by the creature template. -1.0 to play all animations in order
