HorseGetPaladinMount

From NWN Lexicon
Jump to: navigation, search


HorseGetPaladinMount(object)

Retrieves a creature's Paladin mount.

Parameters

oRider

The creature whose Paladin mount is required.


Description

If this rider has a paladin mount, it will be returned as an object id.

If the rider is currently riding their paladin mount, the function will return the rider's object id instead.

If no paladin mount currently exists for oRider it will return OBJECT_INVALID.



Remarks

This may not give the desired result if called too soon after HorseSummonPaladinMount .

The latter is an action, which is queued, so the horse is not created immediately.


Requirements

#include " x3_inc_horse "

Version

1.69

Example

#include "x3_inc_horse"
 
void main()
{
  object oPC = GetPCSpeaker(); 
  object oHorse = HorseGetPaladinMount(oPC);
}

See Also

functions: 

HorseUnsummonPaladinMount



author: Proleric, editor: Mistress