Difference between revisions of "ForceFlee"
Jump to navigation
Jump to search
imported>Geckbot m (Robot: Automated text replacement (-\[\[Category:(.*?)\(GECK 1.0\)\]\] +Category:\1(GECK 1.1))) |
imported>Ez0n3 |
||
| Line 1: | Line 1: | ||
{{Function | |||
|CSWikiPage = ForceFlee | |||
|origin = GECK1 | |||
[ | |summary = Causes the actor to analyze its surroundings for potential threats, and flee if a threat is found. | ||
|name = ForceFlee | |||
|returnType = void | |||
|referenceType = [ActorRefID] | |||
|arguments = | |||
{{FunctionArgument | |||
|Name = CellID | |||
|Type = ref | |||
|Optional = y | |||
}}{{FunctionArgument | |||
|Name = ObjectRefID | |||
|Type = ref | |||
|Optional = y | |||
}} | |||
|example = ForceFlee Vault101Exterior | |||
ForceFlee Vault101Exterior, FFEU57Vault101Marker | |||
}} | |||
==Notes== | ==Notes== | ||
*If called with no parameters, the actor will choose where to flee and will decide when to stop fleeing in the same way that actors normally do. If there is not hostile threat to the actor, he will simply stand still for a few moments and then resume his normal AI package. | *If called with no parameters, the actor will choose where to flee and will decide when to stop fleeing in the same way that actors normally do. If there is not hostile threat to the actor, he will simply stand still for a few moments and then resume his normal AI package. | ||
*If called with a CellID, the actor will flee until it reaches the specified cell. | *If called with a CellID, the actor will flee until it reaches the specified cell. | ||
*If called with a ObjectRefID, the actor will flee until it reaches the specified reference (in this case CellID will be ignored, although a valid cell is still required for the script to compile). | *If called with a ObjectRefID, the actor will flee until it reaches the specified reference (in this case CellID will be ignored, although a valid cell is still required for the script to compile). | ||
*A useful side effect of this function is that calling it with no parameters on an actor who is engaged in conversation will immediately end the conversation, causing both participants to resume their normal packages. | *A useful side effect of this function is that calling it with no parameters on an actor who is engaged in conversation will immediately end the conversation, causing both participants to resume their normal packages. | ||
Revision as of 08:35, 15 January 2011
< [[::Category:Functions|Category:Functions]]
Link to TES4 Construction Set Wiki: ForceFlee.
A function included in the GECK version 1.1.0.36.
Description
Causes the actor to analyze its surroundings for potential threats, and flee if a threat is found.
Syntax
[ActorRefID].ForceFlee CellID:ref ObjectRefID:ref
Example
ForceFlee Vault101Exterior
ForceFlee Vault101Exterior, FFEU57Vault101Marker
Notes
- If called with no parameters, the actor will choose where to flee and will decide when to stop fleeing in the same way that actors normally do. If there is not hostile threat to the actor, he will simply stand still for a few moments and then resume his normal AI package.
- If called with a CellID, the actor will flee until it reaches the specified cell.
- If called with a ObjectRefID, the actor will flee until it reaches the specified reference (in this case CellID will be ignored, although a valid cell is still required for the script to compile).
- A useful side effect of this function is that calling it with no parameters on an actor who is engaged in conversation will immediately end the conversation, causing both participants to resume their normal packages.