SetNPCDimension: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|Sets the dimension of this npc. Players can only see npcs in the same dimension. * Default dimension: 0 * Maximum dimension: 4...")
 
No edit summary
 
Line 11: Line 11:
{{FuncParam|dimension|The new dimension to set.}}
{{FuncParam|dimension|The new dimension to set.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' on success.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
SetNPCDimension(npc, 0) -- Set the NPC dimension to 0
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{NPCFunctions}}

Latest revision as of 15:10, 7 January 2020

SetNPCDimension

Type: Function
Context: Server
Introduced: v1.0

Description

Sets the dimension of this npc. Players can only see npcs in the same dimension.

  • Default dimension: 0
  • Maximum dimension: 4294967295

Syntax

SetNPCDimension(npc, dimension)

Parameters

  • npc
    The npc identifier.
  • dimension
    The new dimension to set.

Return Value

  • Returns true on success.

Example

SetNPCDimension(npc, 0) -- Set the NPC dimension to 0

See also