SetNpcIdVisible

setNpcIdVisible

AVAILABLE FROM UPDATE 0.1.2

This function is available in G1R:MP 0.1.2 and later. The contract below includes the compatibility guarantees introduced in that update.

Shows or hides the numeric identifier in a resource-owned NPC's nameplate.

Syntax

bool setNpcIdVisible(int npcId, bool visible)

Parameters

Name	Type	Required	Description
npcId	int	yes	The server-assigned NPC identifier returned by spawnNpc or getNpcs.
visible	bool	yes	True to show the numeric NPC ID or false to hide it.

Returns

Returns true when the visibility change is accepted and replicated; otherwise returns false.

Examples

Hide an NPC's technical identifier while keeping its display name:

if setNpcIdVisible(npcId, false) then
    outputDebugString("NPC ID hidden")
end

Notes

• Available only in server-side resource scripts.
• Only the resource that created the NPC may change this field.
• The state is exposed as getNpcData(npcId).nameplateIdVisible and is replayed during relevance entry and late join.
• When the value changes, the server emits onNpcIdVisibilityChange(npcId, previousVisible, visible, sourceResource). Repeating the current value remains a successful no-op and does not emit the event.
• setNpcNameplateIdVisible is a compatibility alias for this function; use setNpcIdVisible in new resources.