SetNPCFollowPlayer: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetNPCFollowPlayer(npc, player [, speed])}} {{FuncParameters}} {{FuncParam|npc|__EDIT_ME__}} {{Fun..."
 
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|Set a NPC to follow the specified player.}}


{{FuncSyntax|SetNPCFollowPlayer(npc, player [, speed])}}
{{FuncSyntax|SetNPCFollowPlayer(npc, player [, speed])}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|npc|__EDIT_ME__}}
{{FuncParam|npc|The NPC identifier.}}
{{FuncParam|player |__EDIT_ME__}}
{{FuncParam|player |The player identifier.}}
{{FuncParamOptional|speed|__EDIT_ME__}}
{{FuncParamOptional|speed|The speed.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|This function returns nothing.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
AddCommand("follow", function(player)
  SetNPCFollowPlayer(npc, player)
end)
</syntaxhighlight>


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

Latest revision as of 14:26, 26 June 2021

SetNPCFollowPlayer

Type: Function
Context: Server
Introduced: v1.0

Description

Set a NPC to follow the specified player.

Syntax

SetNPCFollowPlayer(npc, player [, speed])

Parameters

  • npc
    The NPC identifier.
  • player
    The player identifier.
  • speed (optional)
    The speed.

Return Value

  • This function returns nothing.

Example

AddCommand("follow", function(player)
  SetNPCFollowPlayer(npc, player)
end)

See also