Difference between revisions of "IsObjectStreamedIn"

From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|IsObjectStreamedIn(player, object)}} {{FuncParameters}} {{FuncParam|player|__EDIT_ME__}} {{FuncPar...")
 
 
Line 1: Line 1:
 
{{Info|Function|Server|1.0}}
 
{{Info|Function|Server|1.0}}
  
{{FuncDescription|__EDIT_ME__}}
+
{{FuncDescription|CHeck whether the specified object is streamed in or not for the player.}}
  
 
{{FuncSyntax|IsObjectStreamedIn(player, object)}}
 
{{FuncSyntax|IsObjectStreamedIn(player, object)}}
  
 
{{FuncParameters}}
 
{{FuncParameters}}
{{FuncParam|player|__EDIT_ME__}}
+
{{FuncParam|player|The player identifier.}}
{{FuncParam|object|__EDIT_ME__}}
+
{{FuncParam|object|The object identifier.}}
  
{{FuncReturnValue|__EDIT_ME__}}
+
{{FuncReturnValue|This function returns '''true''' on success.}}
  
 
== Example ==
 
== Example ==
__EDIT_ME__
+
<syntaxhighlight lang="Lua">
 +
if IsObjectStreamedIn(playerId, objectId) then
 +
    print("The object is streamed in for the player.")
 +
end
 +
</syntaxhighlight>
  
 
{{RelatedFunctions}}
 
{{RelatedFunctions}}
__EDIT_ME__
+
{{ObjectFunctions}}

Latest revision as of 10:02, 29 December 2019

IsObjectStreamedIn

Type: Function
Context: Server
Introduced: v1.0

Description

CHeck whether the specified object is streamed in or not for the player.

Syntax

IsObjectStreamedIn(player, object)

Parameters

  • player
    The player identifier.
  • object
    The object identifier.

Return Value

  • This function returns true on success.

Example

if IsObjectStreamedIn(playerId, objectId) then
    print("The object is streamed in for the player.")
end

See also