HorseSummonPaladinMount(int)

Action - Summon a Paladin mount.

object HorseSummonPaladinMount(
    int bPHBDuration = FALSE
);

Parameters

bPHBDuration

If TRUE, the mount will use the Players Handbook 3.0 edition rules for the duration that the mount will stay around. The default is 24 hours.

Description

This function causes the calling object to summon a Paladin mount.

It returns the object id of the new horse created.

Remarks

This is an Action which must be added to the caller's queue. As with all Actions, it is not executed immediately.

As it returns an object, it needs to be wrapped in an action that accepts an object as a parameter (see example for one way to do this).

If the caller has less than 5 levels in Paladin, or already has a paladin mount, the function returns OBJECT_INVALID.

The mount is created close to the caller.

The mount is not assigned to the caller. You can use HorseSetOwner to assign the mount (see example), even though a Paladin mount cannot be owned.

Since the action takes time to execute, you need a delay on any subsequent command that references the summoned horse (see example).

Requirements

#include "x3_inc_horse"

Version

1.69

Example

#include "x3_inc_horse"


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

  AssignCommand(oPC, SetLocalObject(oPC, "PaladinMount", HorseSummonPaladinMount()));
  
  DelayCommand(2.0, HorseSetOwner(GetLocalObject(oPC, "PaladinMount"), oPC, TRUE));
}

functions:	HorseUnsummonPaladinMount \| HorseGetPaladinMount \| HorseCreateHorse
categories:	Horse Functions