IsNPCStreamedIn: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|IsNPCStreamedIn(player, npc)}} {{FuncParameters}} {{FuncParam|player|__EDIT_ME__}} {{FuncParam|npc..."
 
28days (talk | contribs)
833 edits
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|Checks if stated NPC is streamed in for the player}}


{{FuncSyntax|IsNPCStreamedIn(player, npc)}}
{{FuncSyntax|IsNPCStreamedIn(player, npc)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|player|__EDIT_ME__}}
{{FuncParam|player|Player which you want to check}}
{{FuncParam|npc|__EDIT_ME__}}
{{FuncParam|npc|NPC which you want to check}}


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


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
function npcCheck(player)
  local x, y, z = GetPlayerLocation(player)
  local npc = CreateNPC(1, x, y, z, 0)
 
  if IsNPCStreamedIn(player, npc) then
      AddPlayerChat('npc has been created and streamed in')
  end
end
</syntaxhighlight>
 


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

Latest revision as of 17:17, 13 December 2019

IsNPCStreamedIn

Type: Function
Context: Server
Introduced: v1.0

Description

Checks if stated NPC is streamed in for the player

Syntax

IsNPCStreamedIn(player, npc)

Parameters

  • player
    Player which you want to check
  • npc
    NPC which you want to check

Return Value

  • Returns true on success.

Example

function npcCheck(player)
   local x, y, z = GetPlayerLocation(player)
   local npc = CreateNPC(1, x, y, z, 0)

   if IsNPCStreamedIn(player, npc) then
      AddPlayerChat('npc has been created and streamed in')
   end
end


See also

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