Class PathfindingObstacleRuntimeBehavior

PathfindingObstacleRuntimeBehavior represents a behavior allowing objects to be considered as a obstacle by objects having Pathfinding Behavior.

Hierarchy (view full)

RuntimeBehavior
- PathfindingObstacleRuntimeBehavior

Constructors

constructor

new PathfindingObstacleRuntimeBehavior(instanceContainer, behaviorData, owner): PathfindingObstacleRuntimeBehavior
Parameters
- instanceContainer: RuntimeInstanceContainer
- behaviorData: any
- owner: RuntimeObject
Returns PathfindingObstacleRuntimeBehavior
Overrides RuntimeBehavior.constructor
- Defined in Extensions/PathfindingBehavior/pathfindingobstacleruntimebehavior.ts:113

Properties

currentRBushAABB

currentRBushAABB: null | BehaviorRBushAABB<PathfindingObstacleRuntimeBehavior> = null

name

name: string

owner

owner: RuntimeObject

The object owning the behavior

type

type: string

Methods

activate

activate(enable): void
De/Activate the behavior
Parameters
- enable: boolean
  true to enable the behavior, false to disable it
Returns void
Inherited from RuntimeBehavior.activate
- Defined in GDJS/Runtime/runtimebehavior.ts:157

activated

activated(): boolean
Return true if the behavior is activated

Returns boolean
Inherited from RuntimeBehavior.activated
- Defined in GDJS/Runtime/runtimebehavior.ts:182

doStepPostEvents

doStepPostEvents(instanceContainer): void
This method is called each tick after events are done.
Parameters
- instanceContainer: RuntimeInstanceContainer
  The instanceContainer owning the object
Returns void
Overrides RuntimeBehavior.doStepPostEvents
- Defined in Extensions/PathfindingBehavior/pathfindingobstacleruntimebehavior.ts:173

doStepPreEvents

doStepPreEvents(instanceContainer): void
This method is called each tick before events are done.
Parameters
- instanceContainer: RuntimeInstanceContainer
  The instanceContainer owning the object
Returns void
Overrides RuntimeBehavior.doStepPreEvents
- Defined in Extensions/PathfindingBehavior/pathfindingobstacleruntimebehavior.ts:143

enableSynchronization

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

getAABB

getAABB(): AABB
Returns AABB
- Defined in Extensions/PathfindingBehavior/pathfindingobstacleruntimebehavior.ts:175

getCost

getCost(): number
Returns number
- Defined in Extensions/PathfindingBehavior/pathfindingobstacleruntimebehavior.ts:195

getName

getName(): string
Get the name of the behavior.

Returns string
The behavior's name.
Inherited from RuntimeBehavior.getName
- Defined in GDJS/Runtime/runtimebehavior.ts:105

getNameId

getNameId(): number
Get the name identifier of the behavior.

Returns number
The behavior's name identifier.
Inherited from RuntimeBehavior.getNameId
- Defined in GDJS/Runtime/runtimebehavior.ts:113

getNetworkSyncData

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

isImpassable

isImpassable(): boolean
Returns boolean
- Defined in Extensions/PathfindingBehavior/pathfindingobstacleruntimebehavior.ts:203

isSyncedOverNetwork

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

onActivate

onActivate(): void
Reimplement this method to do extra work when the behavior is activated (after it has been deactivated, see onDeActivate).

Returns void
Overrides RuntimeBehavior.onActivate
- Defined in Extensions/PathfindingBehavior/pathfindingobstacleruntimebehavior.ts:179

onCreated

onCreated(): void
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
Inherited from RuntimeBehavior.onCreated
- Defined in GDJS/Runtime/runtimebehavior.ts:177

onDeActivate

onDeActivate(): void
Reimplement this method to do extra work when the behavior is deactivated.

Returns void
Overrides RuntimeBehavior.onDeActivate
- Defined in Extensions/PathfindingBehavior/pathfindingobstacleruntimebehavior.ts:187

onDestroy

onDestroy(): void
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
Overrides RuntimeBehavior.onDestroy
- Defined in Extensions/PathfindingBehavior/pathfindingobstacleruntimebehavior.ts:137

onObjectHotReloaded

onObjectHotReloaded(): void
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
Inherited from RuntimeBehavior.onObjectHotReloaded
- Defined in GDJS/Runtime/runtimebehavior.ts:223

setCost

setCost(cost): void
Parameters
- cost: number
Returns void
- Defined in Extensions/PathfindingBehavior/pathfindingobstacleruntimebehavior.ts:199

setImpassable

setImpassable(impassable): void
Parameters
- impassable: boolean
Returns void
- Defined in Extensions/PathfindingBehavior/pathfindingobstacleruntimebehavior.ts:207

stepPostEvents

stepPostEvents(instanceContainer): void
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
Inherited from RuntimeBehavior.stepPostEvents
- Defined in GDJS/Runtime/runtimebehavior.ts:140

stepPreEvents

stepPreEvents(instanceContainer): void
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
Inherited from RuntimeBehavior.stepPreEvents
- Defined in GDJS/Runtime/runtimebehavior.ts:122

updateFromBehaviorData

updateFromBehaviorData(oldBehaviorData, newBehaviorData): boolean
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.
Parameters
- oldBehaviorData: any
  The previous data for the behavior.
- newBehaviorData: any
  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).

See
gdjs.RuntimeBehavior#onObjectHotReloaded
Overrides RuntimeBehavior.updateFromBehaviorData
- Defined in Extensions/PathfindingBehavior/pathfindingobstacleruntimebehavior.ts:127

updateFromNetworkSyncData

updateFromNetworkSyncData(networkSyncData): void
Update the behavior properties using the provided data.
Parameters
- networkSyncData: BehaviorNetworkSyncData
  The new properties of the behavior.
Returns void
Inherited from RuntimeBehavior.updateFromNetworkSyncData
- Defined in GDJS/Runtime/runtimebehavior.ts:93

usesLifecycleFunction

usesLifecycleFunction(): boolean
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
Inherited from RuntimeBehavior.usesLifecycleFunction
- Defined in GDJS/Runtime/runtimebehavior.ts:234

Class PathfindingObstacleRuntimeBehavior

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PathfindingObstacleRuntimeBehavior

Properties

currentRBushAABB

name

owner

type

Methods

activate

Parameters

Returns void

activated

Returns boolean

doStepPostEvents

Parameters

Returns void

doStepPreEvents

Parameters

Returns void

enableSynchronization

Parameters

Returns void

getAABB

Returns AABB

getCost

Returns number

getName

Returns string

getNameId

Returns number

getNetworkSyncData

Returns BehaviorNetworkSyncData

isImpassable

Returns boolean

isSyncedOverNetwork

Returns boolean

onActivate

Returns void

onCreated

Returns void

onDeActivate

Returns void

onDestroy

Returns void

onObjectHotReloaded

Returns void

setCost

Parameters

Returns void

setImpassable

Parameters

Returns void

stepPostEvents

Parameters

Returns void

stepPreEvents

Parameters

Returns void

updateFromBehaviorData

Parameters

Returns boolean

See

updateFromNetworkSyncData

Parameters

Returns void

usesLifecycleFunction

Returns boolean

Settings

Member Visibility

Theme

On This Page