ActionMoveToObject

From NWN Lexicon
Revision as of 09:58, 21 August 2012 by Dood (talk | contribs) (Created page with " =ActionMoveToObject(object, int, float)= Cause action subject to move to a certain distance of a target object. void  ActionMoveToObject(     ...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search



ActionMoveToObject(object, int, float)

Cause action subject to move to a certain distance of a target object.

 void  ActionMoveToObject(
     object  oTarget,
     int  bRun = FALSE,
     float  fRange = 1.0f
);

Parameters

oTarget

Object to move action subject to.

bRun

If this is TRUE, the action subject will run rather than walk. (Default: FALSE)

fRange

The desired distance between the action subject and oTarget. (Default: 1.0f)


Description

The action subject will move to within fRange of oTarget. If there is no path to oTarget, the function will do nothing. The function call waits for the subject to reach oTarget before executing further actions in the action queue.
If an error occurs the log file will contain "ActionMoveToObject failed."



Remarks

Move to object functions (ActionForceMoveToObject, ActionMoveToObject) actually do path finding, unlike their move to location (ActionForceMoveToLocation, ActionMoveToLocation) counterparts.


Known Bugs

PCs ignore the value of bRun and always run to the target object. If you want a PC to walk rather than run, you must use ActionMoveToLocation instead.


Version

1.61

See Also

functions: 

ActionMoveToLocation



 author: Ryan Hunt, editor: Lilac Soul, additional contributor(s): Harold Myles, Lilac Soul