NPCs

NPCs created by server scripts. Every NPC has an id from gmp.getMaxSlots() up, and all Players functions work for it too (name, attributes, items, position, combat...). The functions below work only for server-side NPCs: they control the NPC's AI and routine actions, which make no sense for a player - called with a player id they return false.

Creation and removalKopiuj link do sekcji

createNpcKopiuj link do sekcji

gmp.createNpc(class, x, y, z, angle)

Creates a server-side NPC and returns its id right away. The NPC appears in the game of every player (each game creates it asynchronously, usually within about a second). It is created exactly as the game makes it - with the stats, skills, inventory, appearance and AI of its class.

local guard = gmp.createNpc("CharacterDefinition_Human_OC_GRD_Jackal_201", 1200, -350, 80, 90)
gmp.setPlayerName(guard, "Jackal")
gmp.setNpcRelation(guard, pid, gmp.enum.Relation.Hostile)

Returns: integer - Id of the new NPC (gmp.getMaxSlots() or above).

destroyNpcKopiuj link do sekcji

gmp.destroyNpc(npcId)

Removes a server-side NPC from the world of every player. Its id becomes free.

Returns: boolean - false when the id is not an existing server-side NPC.

isNpcKopiuj link do sekcji

gmp.isNpc(id)

Tells whether the id belongs to an existing server-side NPC.

Returns: boolean - false for player ids and for ids of removed or never created NPCs.

AIKopiuj link do sekcji

setNpcPassiveKopiuj link do sekcji

gmp.setNpcPassive(npcId, passive)

Makes the NPC's AI passive: it does not react to threats - does not attack and does not flee.

Returns: boolean

setNpcInteractableKopiuj link do sekcji

gmp.setNpcInteractable(npcId, interactable)

Enables or disables talking to the NPC and searching it.

Returns: boolean

setNpcRelationKopiuj link do sekcji

gmp.setNpcRelation(npcId, targetId, relation)

Sets how the NPC treats another character - whether its AI takes it as a target (attacks it, starts combat music). The relation is ONE-WAY and applies to the NPC's own decisions.

gmp.setNpcRelation(guard, pid, gmp.enum.Relation.Hostile)   -- the guard attacks the player

Returns: boolean

getNpcRelationKopiuj link do sekcji

gmp.getNpcRelation(npcId, targetId)

Returns how the NPC treats another character (one-way, see setNpcRelation).

Returns: gmp.enum.Relation | nil

Routine actionsKopiuj link do sekcji

The NPC uses the nearest world object of the right kind within maxDistance (default 1000 cm): it is placed in front of the object and the game performs the interaction with its animations. An NPC busy with another interaction cannot start a new one (stand up or leave the ladder first).

npcSitDownKopiuj link do sekcji

gmp.npcSitDown(npcId, maxDistance?)

Sits the NPC down on the nearest free bench or chair. It stays seated until npcStandUp.

Returns: boolean - false when there is no free seat within the radius or the game rejected it.

npcStandUpKopiuj link do sekcji

gmp.npcStandUp(npcId)

Makes a seated NPC stand up.

Returns: boolean - false when the NPC is not sitting.

npcUseLadderKopiuj link do sekcji

gmp.npcUseLadder(npcId, fast?, maxDistance?)

Makes the NPC climb the nearest ladder from the side it stands at, to the other end, and get off.

Returns: boolean - false when there is no ladder within the radius or the game rejected it.

setNpcLadderFastKopiuj link do sekcji

gmp.setNpcLadderFast(npcId, fast)

Speeds up or slows down an NPC that is on a ladder.

Returns: boolean - false when the NPC is not on a ladder.

npcLightTorchKopiuj link do sekcji

gmp.npcLightTorch(npcId, maxDistance?)

Makes the NPC light the nearest roadside torch or fire basket. As in the game, the NPC needs a torch in hand.

Returns: boolean - false when there is no torch within the radius or the game rejected it.

npcExtinguishTorchKopiuj link do sekcji

gmp.npcExtinguishTorch(npcId, maxDistance?)

Makes the NPC extinguish the nearest roadside torch or fire basket.

Returns: boolean - false when there is no torch within the radius or the game rejected it.