Interface PlayerLocalObjectPlayer

Readonlyname

findObject

• findObject(name: string): PlayerLocalObject | null

  Gets the handle of the child object of this object, by specified name.

  This method ignores the objects with Item component and its children. Use ClusterScript or SubNode to control the object with Item component.

  Parameters

  • name: string

  Returns PlayerLocalObject | null

  The handle of the object with specified name, or null if not found

getEnabled

• getEnabled(): boolean

  Gets the activeness of the object.

  Returns null if the value cannot be obtained.

  Returns boolean

getTotalEnabled

• getTotalEnabled(): boolean

  Gets the total activeness of the object. Returns true if the object itself and all its parent objects are active.

  Returns null if the value cannot be obtained.

  Returns boolean

getUnityComponent

• getUnityComponent(type: string): UnityComponent | null

  Gets the handle of the Unity component attached to this object by type name. The available type names are defined in UnityComponent.

  If the object has multiple components, returns first component.

  This method throws error if the object is a parent or child of Item. This is a restriction to avoid control conflicts with Item components and Scriptable Item.

  Parameters

  • type: string

  Returns UnityComponent | null

  The component specified by type name, or null if not found

polyline

• polyline(id: string): PolylineHandle

  Gets the handle of a Polyline attached to this PlayerLocalObject. This Polyline is displayed only to the player running the PlayerScript, and is not synchronized to other players.

  The total number of points and the number of Polylines attached to PlayerLocalObjects are subject to the same upper limits as the item that called ClusterScript.setPlayerScript. See PolylineHandle.setPoints for the upper limit of the number of points per line.

  Parameters

  • id: string

    The identifier of the Polyline. It must be 64 characters or less, and can contain only alphanumeric characters and some symbols (apostrophe, comma, hyphen, period, and underscore)

  Returns PolylineHandle

setEnabled

• setEnabled(v: boolean): void

  Sets the object's activeness. When the object is inactive, the object and all its children will not be rendered.

  This method throws error if the object is a parent or child of Item. This is a restriction to avoid control conflicts with Item components and Scriptable Item.

  Parameters

  • v: boolean

    true to activate the object, false otherwise

  Returns void