GetStreamedPlayers: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|GetStreamedPlayers()}} {{FuncParameters}} {{FuncNoParam}} {{FuncReturnValue|__EDIT_ME__}} == Exa...")
 
m (Add example and documentation)
 
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Returns a table of player identifiers streamed in for the client.}}


{{FuncSyntax|GetStreamedPlayers()}}
{{FuncSyntax|GetStreamedPlayers()}}
Line 8: Line 8:
{{FuncNoParam}}
{{FuncNoParam}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|A table with player identifiers if any else nil.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang='Lua'>
for k, v in ipairs(GetStreamedPlayers()) do
    SetPlayerClothingPreset(v, 1)
end
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
_EDIT_ME_

Latest revision as of 18:04, 21 February 2020

GetStreamedPlayers

Type: Function
Context: Client
Introduced: v1.0

Description

Returns a table of player identifiers streamed in for the client.

Syntax

GetStreamedPlayers()

Parameters

  • This function has no parameters.

Return Value

  • A table with player identifiers if any else nil.

Example

for k, v in ipairs(GetStreamedPlayers()) do
    SetPlayerClothingPreset(v, 1)
end

See also

_EDIT_ME_