Class NetworkRootInfo

constructor

• new NetworkRootInfo(
      sceneObject: SceneObject,
      networkId: string,
      dataStore: GeneralDataStore,
      locallyCreated: boolean,
      ownerInfo: UserInfo,
      permissivePersistence?: Persistence,
  ): NetworkRootInfo

  Parameters

  • sceneObject: SceneObject

    SceneObject hosting this NetworkRootInfo.
  • networkId: string

    Network id of this instantiated object
  • dataStore: GeneralDataStore

    Store containing information about the prefab instantiation
  • locallyCreated: boolean

    true if this instance was instantiated by the current local user in the current session
  • ownerInfo: UserInfo

    User that owns this instance, or null if unowned
  • OptionalpermissivePersistence: Persistence

    Persistence of the instantiated object

  Returns NetworkRootInfo

callbacks

ReadonlydataStore

instantiatedObject

ReadonlylocallyCreated

ReadonlynetworkId

onDestroyed

onLocalDestroyed

onRemoteDestroyed

ReadonlyownerInfo

Readonlypersistence

ReadonlysceneObject

canIModifyStore

• canIModifyStore(): boolean

  Returns true if the local user is allowed to modify this store

  Returns boolean

  true if the local user is allowed to modify this store

doIOwnStore

• doIOwnStore(): boolean

  Returns true if the local user is allowed to modify this store

  Returns boolean

  true if the local user is allowed to modify this store

finishSetup

• finishSetup(): void

  Used internally for finishing the NetworkRootInfo setup after the child object has been instantiated

  Returns void

getOwnerId

• getOwnerId(): string

  Returns the owner's connectionId if an owner exists, otherwise null

  Returns string

  The owner's connectionId if an owner exists, otherwise null

getOwnerUserId

• getOwnerUserId(): string

  Returns the owner's userId if an owner exists, otherwise null

  Returns string

  The owner's userId if an owner exists, otherwise null

isOwnedBy

• isOwnedBy(connectionId: string): boolean

  Returns true if the instantiated object is owned by a user with the passed in connectionId

  Parameters

  • connectionId: string

    connectionId of a user

  Returns boolean

  true if the instantiated object is owned by a user with the passed in connectionId

isOwnedByUserInfo

• isOwnedByUserInfo(user: UserInfo): boolean

  Returns true if the instantiated object is owned by the user connection

  Parameters

  • user: UserInfo

    userInfo of a user

  Returns boolean

  true if the instantiated object is owned by the user connection