Preparing search index...

    Enables or disables groups of SceneObjects whenever ownership of the SyncEntity changes. When the SyncEntity becomes owned by the local user, the objects in nonOwnerObjects become disabled, and objects in ownerObjects become enabled. When the SyncEntity becomes not owned by the local user, the objects in ownerObjects become disabled, and objects in nonOwnerObjects become enabled.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    api: Record<string, any>

    Generic object accessible by other instances of ScriptComponent. Use this object to store references to properties and methods that need to be accessible from other ScriptComponents.

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    isEnabledInHierarchy: boolean

    Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

    name: string
    sceneObject: SceneObject

    The SceneObject this component is on.

    uniqueIdentifier: string
    updatePriority: number

    Methods

    • Initializes the component by setting up the appropriate event listeners and updating the ownership state.

      Returns void

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns void

    • Sets the enabled state of all objects in the array.

      Parameters

      • objects: SceneObject[]

        The array of SceneObjects.

      • enabled: boolean

        The enabled state to set.

      Returns void

    • Updates the enabled state of the owner and non-owner objects based on the ownership of the target.

      Parameters

      • ownerInfo: UserInfo

        Information about the owner.

      Returns void