HorseInstantDismount(object)

Dismount instantly.

void HorseInstantDismount(
    object oRider
);

Parameters

oRider

The creature who is to dismount.

Description

This function is used to dismount a rider rapidly, without producing a horse object.

Its intended usage is with cutscenes and similar situations.

It does not protect saddlebags, so it is recommended this only be used in conjunction with HorseInstantMount.

If you need to protect saddlebag contents use HorseDismount().

Remarks

In effect, this destroys the horse and returns the rider to their normal dismounted appearance.

Requirements

#include "x3_inc_horse"

Version

1.69

Example

#include "x3_inc_horse"


void main()
{
  object oPC = GetEnteringObject();

  HorseInstantDismount(oPC);
}

functions:	HorseInstantMount \| HorseDismount
categories:	Horse Functions