Runtime classServer APIGenerated

Dog

Defined in: server/api.d.ts:3639

Replicated KCD2 dog companion handle.

Extends

Entity

Constructors

Constructor

new Dog(id): Dog

Defined in: server/api.d.ts:3644

Creates a script wrapper for an existing dog with this ID; use Dog.spawn() to spawn one.

Parameters

id

number

Network entity identifier.

Returns

Dog

Inherited from

Entity.constructor

Methods

destroy()

destroy(): void

Defined in: server/api.d.ts:3695

Despawns this dog on every client after emitting dogDestroy.

Returns

void

giveTo()

giveTo(player): void

Defined in: server/api.d.ts:3701

Hands this dog to another player. Every client re-possesses the body onto the new master’s soul, and authority over its pose moves with it. Throws when player is not a connected player.

Parameters

player

Player | null

The dog’s new master, or null to leave it masterless.

Returns

void

setVirtualWorld()

setVirtualWorld(world): void

Defined in: server/api.d.ts:8797

Moves this entity into another virtual world.

Parameters

world

number

Virtual-world identifier used to partition replication and visibility.

Returns

void

Inherited from

Entity.setVirtualWorld

setVisibleTo()

setVisibleTo(player): void

Defined in: server/api.d.ts:8803

Restricts replication of this entity to one owning connection while preserving normal range and visibility checks.

Parameters

player

Entity | null

Player-owned entity whose connection should exclusively receive this entity, or null to clear the restriction.

Returns

void

Inherited from

Entity.setVisibleTo

toString()

toString(): string

Defined in: server/api.d.ts:3690

Formats this dog handle for logging and debugging.

Returns

string

The dog ID, its soul, its owner and its mode.

Inherited from

Entity.toString

all()

static all(): Dog[]

Defined in: server/api.d.ts:3718

Lists every dog the server currently has.

Returns

Dog[]

One handle per live dog, in no particular order.

getById()

static getById(id): Dog | null

Defined in: server/api.d.ts:3725

Looks a dog up by its network entity ID.

Parameters

id

number

Network entity identifier.

Returns

Dog | null

The dog’s handle, or null when no live dog has that ID.

spawn()

static spawn(owner, position?, rotation?, soul?, name?): Dog

Defined in: server/api.d.ts:3712

Spawns and replicates a dog companion for a player.

Parameters

owner

Player

The player the dog belongs to. A dog is somebody’s from the moment it exists.

position?

Vector3 | Partial<Vector3>

Optional world-space spawn position; omitted spawns the dog on its owner.

rotation?

Vector3 | Quaternion

Optional initial orientation: a Quaternion, or a Vector3 of Euler angles in degrees.

soul?

string

Optional soul GUID from the game’s tables; omitted spawns the generic dog.

name?

string

Optional name every client shows for the dog; omitted leaves the name its soul carries.

Returns

Dog

The newly spawned dog handle.

Properties

destroyWithOwner

destroyWithOwner: boolean

Defined in: server/api.d.ts:3669

Whether this dog is despawned when its owner disconnects. True by default. Set it to false to keep the dog in the world: it is left masterless instead (dogOwnerChanged with a null player), and with nobody’s game running its brain it stands where it was until giveTo hands it to someone. Saving it across server restarts is the script’s own business.

id

readonly id: number

Defined in: server/api.d.ts:8765

Immutable network entity identifier.

Inherited from

Entity.id

mode

mode: number

Defined in: server/api.d.ts:3674

The dog’s companion mode: 0 Wait, 1 Follow, 2 Free, 3 Aggressive, 4 Search, 5 Hunt, 6 Guard, 7 Ambush. Assignment applies it on every client.

morale

readonly morale: number

Defined in: server/api.d.ts:3684

The dog’s morale as its owner last read it off the game, or 0 before any report. Below the game’s own threshold the dog stops obeying commands. Owner-reported, so read-only.

name

name: string

Defined in: server/api.d.ts:3654

Name every client shows for this dog. Assignment renames it on all of them; empty means the name its soul carries stands.

objective

readonly objective: number

Defined in: server/api.d.ts:3679

What the owner’s game currently has this dog doing, as an E_DogObjective ordinal: 0 Wait, 2 Bark, 4 Follow, 5 FollowHeel, 7 Search, 8 MeleeCombat, 9 Fetch, 10 Hunt, 19 Eat, 21 Distract, 22 Pet, 25 Invalid when idle. Reported by the owner, so read-only.

owner

readonly owner: Player | null

Defined in: server/api.d.ts:3664

The player this dog belongs to, or null when it has no master.

ownerId

readonly ownerId: number

Defined in: server/api.d.ts:3659

Network ID of the player this dog belongs to, or 0 when it has no master.

position

position: Vector3

Defined in: server/api.d.ts:8775

Authoritative world-space position; assignment forces replicated state.

Inherited from

Entity.position

rotation

rotation: Vector3 | Quaternion

Defined in: server/api.d.ts:8780

Authoritative rotation; reads return a quaternion and assignments accept a quaternion or Euler angles in degrees.

Inherited from

Entity.rotation

soul

readonly soul: string

Defined in: server/api.d.ts:3649

GUID of the soul this dog was spawned against, which decides its appearance.

state

readonly state: StateBag

Defined in: server/api.d.ts:8785

Arbitrary key/value state carried by this entity. The server writes it and every client that can see the entity receives it; see StateBag.

Inherited from

Entity.state

virtualWorld

readonly virtualWorld: number

Defined in: server/api.d.ts:8770

Current virtual-world identifier.

Inherited from

Entity.virtualWorld