Difference between revisions of "ForceFlee"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
 
imported>Khadir
(Documenting actor functions ...)
Line 1: Line 1:
{{ActorFunction}}
'''Syntax:'''
'''Syntax:'''
  ForceFlee ''CellID (optional)'', ''ObjectRefID (optional)''  
  [''ActorID''.]ForceFlee
[''ActorID''.]ForceFlee ''CellID''
[''ActorID''.]ForceFlee ''CellID'', ''ObjectRefID''
 
'''Example:'''
'''Example:'''
   ForceFlee ChorrolTheGreyMare  
   ForceFlee ChorrolTheGreyMare  

Revision as of 04:27, 28 June 2006

Template:ActorFunction Syntax:

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

Example:

 ForceFlee ChorrolTheGreyMare 
 ForceFlee ChorrolTheGreyMare, BongondRef 

Causes the actor to flee, whether or not the actor is currently in combat.

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