SetObjectStreamDistance: Difference between revisions

From Onset Developer Wiki
Newer edit →
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetObjectStreamDistance(object, distance)}} {{FuncParameters}} {{FuncParam|object|__EDIT_ME__}} {{..."
 
28days (talk | contribs)
833 edits
No edit summary
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Set the specified object's stream distance.}}


{{FuncSyntax|SetObjectStreamDistance(object, distance)}}
{{FuncSyntax|SetObjectStreamDistance(object, distance)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|object|__EDIT_ME__}}
{{FuncParam|object|The object identifier.}}
{{FuncParam|distance|__EDIT_ME__}}
{{FuncParam|distance|The stream distance.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|This function returns '''true''' on success.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
SetObjectStreamDistance(objectId, 10000)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{ObjectFunctions}}

Revision as of 19:44, 31 December 2019

SetObjectStreamDistance

Type: Function
Context: Server
Introduced: v1.0

Description

Set the specified object's stream distance.

Syntax

SetObjectStreamDistance(object, distance)

Parameters

  • object
    The object identifier.
  • distance
    The stream distance.

Return Value

  • This function returns true on success.

Example

SetObjectStreamDistance(objectId, 10000)

See also

Retrieved from "https://dev.playonset.com/index.php?title=SetObjectStreamDistance&oldid=3405"