Preparing search index...

    Meant to be a very simple interface for a synced entity and its RealtimeStore. It doesn’t do any behaviors on its own, so it can be used just for storing and retrieving synced values.

    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
    onOwnerUpdated: EventWrapper<[UserInfo]> = ...
    onSetupFinished: EventWrapper<[void]> = ...
    onStoreCreated: EventWrapper<
        [
            session: MultiplayerSession,
            store: GeneralDataStore,
            ownerInfo: UserInfo,
            creationInfo: RealtimeStoreCreationInfo,
        ],
    > = ...
    onStoreDeleted: EventWrapper<
        [
            session: MultiplayerSession,
            store: GeneralDataStore,
            deleteInfo: RealtimeStoreDeleteInfo,
        ],
    > = ...
    onStoreOwnershipUpdated: EventWrapper<
        [
            session: MultiplayerSession,
            store: GeneralDataStore,
            ownerInfo: UserInfo,
            ownershipUpdateInfo: RealtimeStoreOwnershipUpdateInfo,
        ],
    > = ...
    onStoreUpdated: EventWrapper<
        [
            session: MultiplayerSession,
            store: GeneralDataStore,
            key: string,
            updateInfo: RealtimeStoreUpdateInfo,
        ],
    > = ...
    sceneObject: SceneObject

    The SceneObject this component is on.

    syncEntity: SyncEntity = ...
    uniqueIdentifier: string
    updatePriority: number

    Methods

    • Returns boolean

      True if the current user can modify the store

    • Returns boolean

      True if the store is owned by the current user

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

      Parameters

      • type: string

      Returns boolean

    • Returns boolean

      True if the store is owned by any user

    • Returns boolean

      True if the store is ready