GetStreamedObjects: Difference between revisions

From Onset Developer Wiki
28days (talk | contribs)
No edit summary
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Gets the streamed in objects for the local player.}}


{{FuncSyntax|GetStreamedObjects( [, bGetAttached])}}
{{FuncSyntax|GetStreamedObjects( [, bGetAttached])}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam||__EDIT_ME__}}
{{FuncParamOptional|bGetAttached|Get the attached objects}}
{{FuncParamOptional|bGetAttached|__EDIT_ME__}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns a table with streamed in object identifiers as values.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
for k, v in pairs(GetStreamedNPC()) do
    AddPlayerChat("Table key "..k..": npcid: "..v)
end
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}

Latest revision as of 15:53, 8 January 2021

GetStreamedObjects

Type: Function
Context: Client
Introduced: v1.0

Description

Gets the streamed in objects for the local player.

Syntax

GetStreamedObjects( [, bGetAttached])

Parameters

  • bGetAttached (optional)
    Get the attached objects

Return Value

  • Returns a table with streamed in object identifiers as values.

Example

for k, v in pairs(GetStreamedNPC()) do
    AddPlayerChat("Table key "..k..": npcid: "..v)
end

See also