IsPlayerStreamedIn: Difference between revisions
From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|IsPlayerStreamedIn(player, otherid)}} {{FuncParameters}} {{FuncParam|player|__EDIT_ME__}} {{FuncPa...") |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Info|Function|Server|1.0}} | {{Info|Function|Server|1.0}} | ||
{{FuncDescription| | {{FuncDescription|Check if the player B (otherid) is streamed in for player A (player).}} | ||
{{FuncSyntax|IsPlayerStreamedIn(player, otherid)}} | {{FuncSyntax|IsPlayerStreamedIn(player, otherid)}} | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|player| | {{FuncParam|player|The player identifier for which the other player should be streamed in.}} | ||
{{FuncParam|otherid| | {{FuncParam|otherid|The player identifier for the player which will be streamed in.}} | ||
{{FuncReturnValue| | {{FuncReturnValue|The function returns '''true''' on success.}} | ||
== Example == | == Example == | ||
<syntaxhighlight lang="Lua"> | |||
if IsPlayerStreamedIn(playerId, otherId) then | |||
AddPlayerChat(playerId, "You have just streamed in other player.") | |||
end | |||
</syntaxhighlight> | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
{{PlayerFunctions}} | |||
Revision as of 19:47, 31 December 2019
Description
Check if the player B (otherid) is streamed in for player A (player).
Syntax
IsPlayerStreamedIn(player, otherid)
Parameters
- 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.
Return Value
- The function returns true on success.
Example
if IsPlayerStreamedIn(playerId, otherId) then
AddPlayerChat(playerId, "You have just streamed in other player.")
end
