IsPlayerStreamedIn: Difference between revisions

Latest revision as of 14:45, 26 June 2021

IsPlayerStreamedIn

Type: Function
Context: Server
Introduced: v1.0

Check if the player B (otherid) is streamed in for player A (player).

IsPlayerStreamedIn(player, otherid)

player
The player identifier for which the other player should be streamed in.
otherid
The player identifier for the player which will be streamed in.

if IsPlayerStreamedIn(playerId, otherId) then
    AddPlayerChat(playerId, "You have just streamed in other player.")
end

@@ Line 1: / Line 1: @@
 {{Info|Function|Server|1.0}}
-{{FuncDescription|__EDIT_ME__}}
+{{FuncDescription|Check if the player B (otherid) is streamed in for player A (player).}}
 {{FuncSyntax|IsPlayerStreamedIn(player, otherid)}}
 {{FuncParameters}}
-{{FuncParam|player|__EDIT_ME__}}
+{{FuncParam|player|The player identifier for which the other player should be streamed in.}}
-{{FuncParam|otherid|__EDIT_ME__}}
+{{FuncParam|otherid|The player identifier for the player which will be streamed in.}}
-{{FuncReturnValue|__EDIT_ME__}}
+{{FuncReturnValue|The function returns '''true''' on success.}}
 == Example ==
-__EDIT_ME__
+<syntaxhighlight lang="Lua">
+if IsPlayerStreamedIn(playerId, otherId) then
+    AddPlayerChat(playerId, "You have just streamed in other player.")
+end
+</syntaxhighlight>
 {{RelatedFunctions}}
-__EDIT_ME__
+{{ServerPlayerFunctions}}