SetNPCLocation: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetNPCLocation(npc, x, y, z)}} {{FuncParameters}} {{FuncParam|npc|__EDIT_ME__}} {{FuncParam|x|__ED..."
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Sets the location of this npc}}


{{FuncSyntax|SetNPCLocation(npc, x, y, z)}}
{{FuncSyntax|SetNPCLocation(npc, x, y, z)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|npc|__EDIT_ME__}}
{{FuncParam|npc|NPC which you want to teleport}}
{{FuncParam|x|__EDIT_ME__}}
{{FuncParam|x|X coordinate}}
{{FuncParam|y|__EDIT_ME__}}
{{FuncParam|y|Y coordinate}}
{{FuncParam|z|__EDIT_ME__}}
{{FuncParam|z|Z coordinate}}


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


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
function bringNPC(player, npc)
  local x,y,z = GetPlayerLocation(player)
  SetNPCLocation(tonumber(npc), x,y,z)
end
AddCommand('bringnpc', bringNPC)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{Template:NPCFunctions}}

Latest revision as of 14:25, 26 June 2021

SetNPCLocation

Type: Function
Context: Server
Introduced: v1.0

Description

Sets the location of this npc

Syntax

SetNPCLocation(npc, x, y, z)

Parameters

  • npc
    NPC which you want to teleport
  • x
    X coordinate
  • y
    Y coordinate
  • z
    Z coordinate

Return Value

  • Returns true on success.

Example

function bringNPC(player, npc)
   local x,y,z = GetPlayerLocation(player)
   SetNPCLocation(tonumber(npc), x,y,z)
end
AddCommand('bringnpc', bringNPC)

See also

Retrieved from "https://dev.playonset.com/index.php?title=SetNPCLocation&oldid=4823"