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...') |
m (Added sourcemodule) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| 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 = int |
| − | |param2name=nAnimPattern | + | |param2name = nAnimPattern |
| − | |param2desc=The | + | |param2desc = The override animation pattern (index into [[ambient_ai.xls]]). |
| − | |param3type=float | + | |param3type = float |
| − | |param3name=fAnimFreq | + | |param3name = fAnimFreq |
| − | |param3desc=The override animation frequency | + | |param3desc = The override animation frequency. |
| − | |param4type= | + | |param4type = int |
| − | |param4name= | + | |param4name = nOverrideCount |
| − | |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 = void |
| − | |returndesc= | + | |returndesc = |
| − | |sourcefile= sys_ambient_h | + | |sourcefile = sys_ambient_h |
| − | |sourcemodule= | + | |sourcemodule = Core Game Resources |
}} | }} | ||
== 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 == --> | ||
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
| − | + | <!-- | |
| − | <!-- == 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. --> | ||
Latest revision as of 22:54, 3 August 2011
Overrides a creature's predefined ambient behaviour.
void Ambient_OverrideBehaviour(
object oCreature,
int nAnimPattern,
float fAnimFreq,
int nOverrideCount
);
object oCreature,
int nAnimPattern,
float fAnimFreq,
int nOverrideCount
);
- Parameters:
- oCreature
- The creature performing the ambient behaviour.
- nAnimPattern
- The override animation pattern (index into ambient_ai.xls).
- fAnimFreq
- The override animation frequency.
- nOverrideCount
- The number of times the override animation pattern is to be played (-1 for infinite).
- Returns:
- Nothing.
- Source:
- Core Game Resources.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
