SetObjectStreamDistance: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetObjectStreamDistance(object, distance)}} {{FuncParameters}} {{FuncParam|object|__EDIT_ME__}} {{...")
 
No edit summary
 
(One intermediate revision by one other user not shown)
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. The distance can not be greater than the global stream distance. If you like to view objects from far away you can spawn them on client.}}


{{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. The distance can not be greater than the global 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}}

Latest revision as of 09:59, 17 April 2020

SetObjectStreamDistance

Type: Function
Context: Server
Introduced: v1.0

Description

Set the specified object's stream distance. The distance can not be greater than the global stream distance. If you like to view objects from far away you can spawn them on client.

Syntax

SetObjectStreamDistance(object, distance)

Parameters

  • object
    The object identifier.
  • distance
    The stream distance. The distance can not be greater than the global stream distance.

Return Value

  • This function returns true on success.

Example

SetObjectStreamDistance(objectId, 10000)

See also