Skip to content
KCKingdoms Connected Scripting APIScripting guides and API
GuideMaintainer authored

Give a horse an owner

Make a horse a player's own, decide who may ride it, and choose whether it leaves with its owner or waits for them to come back.

A horse can belong to a player. Every client then treats it as that player’s horse in the game’s own terms, so riding it is never horse theft, and by default it is removed when its owner disconnects.

const horse = Horse.spawn(player.position, player.rotation, "pebbles", `${player.nickname}'s horse`);
horse.giveTo(player);

Give a horse away

Section titled “Give a horse away”
horse.giveTo(target); // target owns it now
horse.giveTo(null);   // nobody does


horse.owner;          // the Player it belongs to, or null
horse.ownerId;        // that player's id, or 0

giveTo throws when target is not a connected player, and horseOwnerChanged fires after it. A spawned horse belongs to nobody until you give it to someone. The owner is not necessarily the rider: read horse.rider for who is in the saddle.

Decide who may ride it

Section titled “Decide who may ride it”

Owning a horse does not stop anyone else riding it. To make that the rule, refuse the mount in horseMounting:

Events.on("horseMounting", (horse, rider) => {
  if (horse.owner && horse.owner.id !== rider.id) {
    Chat.sendToPlayer(rider, `That is ${horse.owner.nickname}'s horse.`);
    return false;
  }
});

The player’s game has already started climbing on, so a refusal plays the get-off. Ownerless horses stay free for anyone here.

When the owner leaves

Section titled “When the owner leaves”

destroyWithOwner decides what happens to the horse when its owner disconnects:

destroyWithOwner On disconnect
true (default) The horse is removed: horseDestroy fires, with the owner still readable.
false The horse stays where it is, ownerless: horseOwnerChanged fires with null.

A removed horse’s rider is taken off first, with horseDismount. Keeping horses across a server restart is up to you: nothing about them is saved.

Example: a stable that remembers

Section titled “Example: a stable that remembers”

/stable gives each player one horse. It stays in the world when they leave and becomes theirs again when they come back.

src/server/stable.ts
const stabled = new Map<string, number>(); // nickname -> horse id


Events.on("playerCommand", (player, command) => {
  if (command !== "stable") return;
  if (!player.ready) {
    Chat.sendToPlayer(player, "Wait until you have spawned.");
    return;
  }


  const old = stabled.get(player.nickname);
  if (old !== undefined) Horse.getById(old)?.destroy();


  const horse = Horse.spawn(player.position, player.rotation, undefined, `${player.nickname}'s horse`);
  horse.destroyWithOwner = false; // wait for them instead
  horse.giveTo(player);
  stabled.set(player.nickname, horse.id);
});


Events.on("playerSpawned", (player) => {
  const id = stabled.get(player.nickname);
  const horse = id === undefined ? null : Horse.getById(id);
  if (horse) horse.giveTo(player);
  else stabled.delete(player.nickname);
});


Events.on("horseMounting", (horse, rider) => {
  // A waiting horse has no owner, so only its stable entry says whose it is.
  for (const [nickname, id] of stabled) {
    if (id === horse.id && nickname !== rider.nickname) return false;
  }
});

The map holds ids, not handles, because the horse can be killed and removed in the meantime; getById then returns null. Nicknames are not accounts, so a real server keys this on whatever identifies its players.

Owner events

Section titled “Owner events”
Event Arguments When
horseOwnerChanged horse, player After giveTo, or when the owner left a horse with destroyWithOwner off. player is null for no owner.
horseDestroy horse While a horse is removed, including with its owner. owner still reads. 
Events.on("horseOwnerChanged", (horse, owner) => {
  console.log(`${horse.name || horse.id} now belongs to ${owner?.nickname ?? "nobody"}`);
});
Section titled “Related”