Difference between revisions of "ForceFlee"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Khadir
(Documenting actor functions ...)
imported>Vswe
m (Added Search Terms)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{ActorFunction}}
'''Syntax:'''
'''Syntax:'''
  [''ActorID''.]ForceFlee
  [''ActorID''.]ForceFlee
Line 9: Line 8:
   ForceFlee ChorrolTheGreyMare, BongondRef  
   ForceFlee ChorrolTheGreyMare, BongondRef  


Causes the actor to flee, whether or not the actor is currently in combat.  
Causes the actor to analyze its surroundings for potential threats, and flee if a threat is found.  


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


[[Category: Functions]]
[[Category: Functions]]
[[Category:Functions (CS)]]
[[Category: Functions (CS 1.0)]]
[[Category: AI Functions]]
[[Category: AI Functions]]
[[Category: AI Functions (CS 1.0)]]
[[Category: Actor Functions]]
[[Category: Actor Functions (CS 1.0)]]
<!-- Begin Search Terms
Force
Flee
End Search Terms -->

Latest revision as of 08:06, 20 June 2008

Syntax:

[ActorID.]ForceFlee
[ActorID.]ForceFlee CellID
[ActorID.]ForceFlee CellID, ObjectRefID

Example:

 ForceFlee ChorrolTheGreyMare 
 ForceFlee ChorrolTheGreyMare, BongondRef 

Causes the actor to analyze its surroundings for potential threats, and flee if a threat is found.

Notes[edit | edit source]

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