Class MultiplayerObjectRuntimeBehavior

The MultiplayerObjectRuntimeBehavior represents a behavior that can be added to objects to make them synchronized over the network.

Hierarchy

RuntimeBehavior
- MultiplayerObjectRuntimeBehavior

Properties

actionOnPlayerDisconnect

actionOnPlayerDisconnect: string

name

name: string

owner

owner: RuntimeObject

playerNumber

playerNumber: number = 0

type

type: string

Methods

activate

activate(enable: boolean): void

Inherited from RuntimeBehavior.activate
- Defined in GDJS/Runtime/runtimebehavior.ts:157
De/Activate the behavior

Parameters
- enable: boolean
  
  true to enable the behavior, false to disable it
Returns void

activated

activated(): boolean

Inherited from RuntimeBehavior.activated
- Defined in GDJS/Runtime/runtimebehavior.ts:182
Return true if the behavior is activated

Returns boolean

doStepPostEvents

doStepPostEvents(): void

Overrides RuntimeBehavior.doStepPostEvents
- Defined in Extensions/Multiplayer/multiplayerobjectruntimebehavior.ts:248
This method is called each tick after events are done.

Returns void

doStepPreEvents

doStepPreEvents(instanceContainer: RuntimeInstanceContainer): void

Inherited from RuntimeBehavior.doStepPreEvents
- Defined in GDJS/Runtime/runtimebehavior.ts:201
This method is called each tick before events are done.

Parameters
- instanceContainer: RuntimeInstanceContainer
  
  The instanceContainer owning the object
Returns void

enableBehaviorSynchronization

enableBehaviorSynchronization(behaviorName: string, enable: boolean): void

- Defined in Extensions/Multiplayer/multiplayerobjectruntimebehavior.ts:638
Parameters
- behaviorName: string
- enable: boolean
Returns void

enableSynchronization

enableSynchronization(enable: boolean): void

Inherited from RuntimeBehavior.enableSynchronization
- Defined in GDJS/Runtime/runtimebehavior.ts:238
Parameters
- enable: boolean
Returns void

getActionOnPlayerDisconnect

getActionOnPlayerDisconnect(): string

- Defined in Extensions/Multiplayer/multiplayerobjectruntimebehavior.ts:634
Returns string

getName

getName(): string

Inherited from RuntimeBehavior.getName
- Defined in GDJS/Runtime/runtimebehavior.ts:105
Get the name of the behavior.

Returns string
The behavior's name.

getNameId

getNameId(): number

Inherited from RuntimeBehavior.getNameId
- Defined in GDJS/Runtime/runtimebehavior.ts:113
Get the name identifier of the behavior.

Returns number
The behavior's name identifier.

getNetworkSyncData

getNetworkSyncData(): BehaviorNetworkSyncData

Inherited from RuntimeBehavior.getNetworkSyncData
- Defined in GDJS/Runtime/runtimebehavior.ts:80
Returns BehaviorNetworkSyncData

getPlayerObjectOwnership

getPlayerObjectOwnership(): number

- Defined in Extensions/Multiplayer/multiplayerobjectruntimebehavior.ts:617
Returns number

isObjectOwnedByCurrentPlayer

isObjectOwnedByCurrentPlayer(): boolean

- Defined in Extensions/Multiplayer/multiplayerobjectruntimebehavior.ts:621
Returns boolean

isSyncedOverNetwork

isSyncedOverNetwork(): boolean

Inherited from RuntimeBehavior.isSyncedOverNetwork
- Defined in GDJS/Runtime/runtimebehavior.ts:242
Returns boolean

onActivate

onActivate(): void

Inherited from RuntimeBehavior.onActivate
- Defined in GDJS/Runtime/runtimebehavior.ts:190
Reimplement this method to do extra work when the behavior is activated (after it has been deactivated, see onDeActivate).

Returns void

onCreated

onCreated(): void

Inherited from RuntimeBehavior.onCreated
- Defined in GDJS/Runtime/runtimebehavior.ts:177
Reimplement this to do extra work when the behavior is created (i.e: an object using it was created), after the object is fully initialized (so you can use this.owner without risk).

Returns void

onDeActivate

onDeActivate(): void

Inherited from RuntimeBehavior.onDeActivate
- Defined in GDJS/Runtime/runtimebehavior.ts:195
Reimplement this method to do extra work when the behavior is deactivated.

Returns void

onDestroy

onDestroy(): void

Overrides RuntimeBehavior.onDestroy
- Defined in Extensions/Multiplayer/multiplayerobjectruntimebehavior.ts:405
This method is called when the owner of the behavior is being removed from the scene and is about to be destroyed/reused later or when the behavior is removed from an object (can happen in case of hot-reloading only. Otherwise, behaviors are just de-activated, not removed. See onDeActivate).

Returns void

onObjectHotReloaded

onObjectHotReloaded(): void

Inherited from RuntimeBehavior.onObjectHotReloaded
- Defined in GDJS/Runtime/runtimebehavior.ts:223
This method is called when the owner of the behavior was hot reloaded, so its position, angle, size can have been changed outside of events.

Returns void

removeObjectOwnership

removeObjectOwnership(): void

- Defined in Extensions/Multiplayer/multiplayerobjectruntimebehavior.ts:625
Returns void

setPlayerObjectOwnership

setPlayerObjectOwnership(newObjectPlayerNumber: number): void

- Defined in Extensions/Multiplayer/multiplayerobjectruntimebehavior.ts:496
Parameters
- newObjectPlayerNumber: number
Returns void

stepPostEvents

stepPostEvents(instanceContainer: RuntimeInstanceContainer): void

Inherited from RuntimeBehavior.stepPostEvents
- Defined in GDJS/Runtime/runtimebehavior.ts:140
Called at each frame after events. Call doStepPostEvents.
Behaviors writers: Please do not redefine this method. Redefine doStepPreEvents instead.

Parameters
- instanceContainer: RuntimeInstanceContainer
  
  The instanceContainer owning the object
Returns void

stepPreEvents

stepPreEvents(instanceContainer: RuntimeInstanceContainer): void

Inherited from RuntimeBehavior.stepPreEvents
- Defined in GDJS/Runtime/runtimebehavior.ts:122
Called at each frame before events. Call doStepPreEvents.
Behaviors writers: Please do not redefine this method. Redefine doStepPreEvents instead.

Parameters
- instanceContainer: RuntimeInstanceContainer
  
  The instanceContainer owning the object
Returns void

takeObjectOwnership

takeObjectOwnership(): void

- Defined in Extensions/Multiplayer/multiplayerobjectruntimebehavior.ts:630
Returns void

updateFromBehaviorData

updateFromBehaviorData(oldBehaviorData: BehaviorData, newBehaviorData: BehaviorData): boolean

Inherited from RuntimeBehavior.updateFromBehaviorData
- Defined in GDJS/Runtime/runtimebehavior.ts:72
Called when the behavior must be updated using the specified behaviorData. This is the case during hot-reload, and is only called if the behavior was modified.

see
gdjs.RuntimeBehavior#onObjectHotReloaded

Parameters
- oldBehaviorData: BehaviorData
  
  The previous data for the behavior.
- newBehaviorData: BehaviorData
  
  The new data for the behavior.
Returns boolean
true if the behavior was updated, false if it could not (i.e: hot-reload is not supported).

updateFromNetworkSyncData

updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

Inherited from RuntimeBehavior.updateFromNetworkSyncData
- Defined in GDJS/Runtime/runtimebehavior.ts:93
Update the behavior properties using the provided data.

Parameters
- networkSyncData: BehaviorNetworkSyncData
  
  The new properties of the behavior.
Returns void

usesLifecycleFunction

usesLifecycleFunction(): boolean

Inherited from RuntimeBehavior.usesLifecycleFunction
- Defined in GDJS/Runtime/runtimebehavior.ts:234
Should return false if the behavior does not need any lifecycle function to be called. Default, hidden, "capability" behaviors set it to false. This avoids useless calls to empty lifecycle functions, which would waste CPU time (and have a sizeable impact for example when lots of static instances are living in the scene).

Returns boolean

Constructors

constructor

new MultiplayerObjectRuntimeBehavior(instanceContainer: RuntimeInstanceContainer, behaviorData: any, owner: RuntimeObject): MultiplayerObjectRuntimeBehavior

Overrides RuntimeBehavior.constructor
- Defined in Extensions/Multiplayer/multiplayerobjectruntimebehavior.ts:73
Parameters
- instanceContainer: RuntimeInstanceContainer
- behaviorData: any
- owner: RuntimeObject
Returns MultiplayerObjectRuntimeBehavior

Generated using TypeDoc