IsObjectStreamedIn: Difference between revisions

Revision as of 08:02, 29 December 2019

IsObjectStreamedIn

Type: Function
Context: Server
Introduced: v1.0

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

IsObjectStreamedIn(player, object)

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

@@ Line 1: / Line 1: @@
 {{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)}}
 {{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 ==
-__EDIT_ME__
+<syntaxhighlight lang="Lua">
+if IsObjectStreamedIn(playerId, objectId) then
+    print("The object is streamed in for the player.")
+end
+</syntaxhighlight>
 {{RelatedFunctions}}
-__EDIT_ME__
+{{ObjectFunctions}}