Class OwnershipModel

Class for abstracting the concept of ownership regarding a networked object or component.
A component that is owned by another user can not be modified through networking (the server will reject changes)

Index

Constructors

Accessors

hasOwnership isConnected isOwned

Methods

destroy freeOwnership requestOwnership requestOwnershipAsync requestOwnershipIfNotOwned updateIsOwned

Constructors

constructor

new OwnershipModel(connection: NetworkConnection, guid: string): OwnershipModel
Parameters
- connection: NetworkConnection
- guid: string
Returns OwnershipModel

Accessors

hasOwnership

get hasOwnership(): boolean
Returns boolean

isConnected

get isConnected(): boolean
Checks if Needle Engine networking is connected to a websocket. Note that this is not equal to being connected to a room. If you want to check if Needle Engine is connected to a networking room use the isInRoom property.

Returns boolean
true if connected to the websocket.

isOwned

get isOwned(): undefined | boolean
Returns undefined | boolean
true of anyone has ownership

Methods

destroy

destroy(): void
Returns void

freeOwnership

freeOwnership(): OwnershipModel
Returns OwnershipModel

requestOwnership

requestOwnership(): OwnershipModel
Returns OwnershipModel

requestOwnershipAsync

requestOwnershipAsync(): Promise<OwnershipModel>
Returns Promise<OwnershipModel>

requestOwnershipIfNotOwned

requestOwnershipIfNotOwned(): OwnershipModel
Returns OwnershipModel

updateIsOwned

updateIsOwned(): void
Returns void