HorseGetMountTail(object)

Retrieves the tail used for a horse.

int HorseGetMountTail(
    object oHorse
);

Parameters

oHorse

The object whose tail model is required.

Description

This function will return the tail that should be used with the specified horse.

Remarks

GetAppearanceType can be used to obtain the dismounted appearance of the horse.

This function returns the tail which, when applied to a rider, makes it appear that the rider is mounted on this horse.

It is primarily useful in conjunction with other horse functions that expect the tail as a parameter.

Not to be confused with GetCreatureTailType, which returns the tail of the target itself (which will be null, in the case of a dismounted horse).

Requirements

#include "x3_inc_horse"

Version

1.69

Example

// A PC is given an instant mount that looks like an existing horse.
#include "x3_inc_horse"


void main()
{
  object oPC    = GetEnteringObject();
  object oHorse = GetObjectByTag("enter tag of an existing horse here");

  HorseInstantMount(oPC, HorseGetMountTail(oHorse));
}

functions:	GetAppearanceType \| GetCreatureTailType \| SetCreatureTailType \| HorseCreateHorse \| HorseInstantMount
categories:	Horse Functions