Difference between revisions of "PathToReference - Actor"
Jump to navigation
Jump to search
imported>Scornett m (Reverted edits by Scornett-Bot (talk) to last revision by Rhavlovick) |
imported>Catwheezle |
||
| Line 32: | Line 32: | ||
== See Also == | == See Also == | ||
*[[Actor Script]] | *[[Actor Script]] | ||
*[[MoveToMyEditorLocation - ObjectReference]] | |||
*[[MoveToInteractionLocation - ObjectReference]] | |||
*[[MoveTo - ObjectReference]] | |||
*[[SetPosition - ObjectReference]] | |||
Latest revision as of 22:19, 14 February 2012
Member of: Actor Script
Makes the actor path to the target reference at a given speed.
Syntax[edit | edit source]
bool Function PathToReference(ObjectReference aTarget, float afWalkRunPercent) nativeParameters[edit | edit source]
- aTarget: The target reference to path to.
- afWalkRunPercent: The speed to move with, as a percentage of the walk/run speeds (valid range 0 -> 1)
Return Value[edit | edit source]
Whether the actor completed the path. Reasons for failure include:
- Not being able to build a path to the target
- The path being interrupted by another path request (possibly from AI/Package code)
- The speed parameter isn't in the valid range 0->1
Examples[edit | edit source]
; Make actor path to the player at half speed
Bob.PathToReference(Game.GetPlayer(), 0.5)Notes[edit | edit source]
- This function is latent. It will suspend the script's execution until the path is either complete or failed/was interrupted.