HorseSetPhenotype

From NWN Lexicon
Jump to: navigation, search


HorseSetPhenotype(object, int)

Set a creature to the riding phenotype.

void HorseSetPhenotype(
    object oRider,
    int bJoust = FALSE
);

Parameters

oRider

The creature whose phenotype is to be changed to the riding position.

bJoust

If TRUE, it will set the rider to the mounted jousting phenotype. This is a special phenotype with differing animation sets, designed to hold the lance in a very specific way.


Description

This function will set oRider to the correct mounted phenotype for riding a horse.



Remarks

When mounted, this function can be used to switch the rider in and out of Joust mode.

By default, it will set oRider to the normal mounted phenotype.

It is only needed in connection with jousting, because the normal mounted phenotype is the default for other functions.

If the rider is dismounted, it will make them look as though they are riding an invisible horse, but in all other respects they remain dismounted.

It is more convenient than SetPhenotype , because there is no need to check whether the dismounted phenotype is normal or large.


Requirements

#include " x3_inc_horse "

Version

1.69

Example

// This script will ensure that the PC adopts the normal mount posture.
#include "x3_inc_horse"
 
 
void main()
{
  object oPC = GetPCSpeaker();
 
  if(HorseGetIsMounted(oPC))
  {
     HorseSetPhenotype(oPC, FALSE);
  }     
}

See Also

functions: 

HorseCreateHorse

constants: 

PHENOTYPE_* Constants



author: Proleric, editor: Mistress