SetObjectStreamDistance: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
 
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|Set the specified object's stream distance.}}
{{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)}}
Line 7: Line 7:
{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|object|The object identifier.}}
{{FuncParam|object|The object identifier.}}
{{FuncParam|distance|The stream distance.}}
{{FuncParam|distance|The stream distance. The distance can not be greater than the global stream distance.}}


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

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