HorseForceJump

From NWN Lexicon
Jump to: navigation, search


HorseForceJump(object, object, float, int)

Force a creature to jump to an object.

void HorseForceJump(
    object oJumper,
    object oDestination,
    float fRange = 2.0,    
    int nTimeOut = 10
);

Parameters

oJumper

The creature to jump.

oDestination

The object to jump close to.

fRange

The acceptable distance from the target in meters. (Default: 2.0)

nTimeout

The maximum number of attempts permitted. (Default: 10)


Description

This function forces the creature to jump within the specified distance from the target, subject to a maximum number of attempts.



Remarks

This is similar to ActionJumpToObject , except that it actually checks that the creature arrives at or near the destination.

On failure, it will try again, until the number of attempts specified in nTimeOut is exhausted.

As it potentially involves recursive delayed actions of unknown duration, this is not a function to include in an action queue or a set of delayed commands.

It isn't horse-specific in any way.


Requirements

#include " x3_inc_horse "

Version

1.69

Example

// Used in a conversation to move oPC to the specified waypoint.  	
 
#include "x3_inc_horse"
void main()
{
  object oPC = GetPCSpeaker();
  object oWaypoint = GetObjectByTag("enter waypoint tag here");
 
  HorseForceJump(oPC, oWaypoint);
}

See Also

functions: 

ActionJumpToLocation



author: Proleric, editor: Mistress