Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PathfindingRuntimeBehavior

PathfindingRuntimeBehavior represents a behavior allowing objects to follow a path computed to avoid obstacles.

Hierarchy

Index

Methods

Constructors

Properties

Methods

activate

  • activate(enable: boolean): void

  • De/Activate the behavior

    Parameters

    • enable: boolean

      true to enable the behavior, false to disable it

    Returns void

activated

  • activated(): boolean

allowDiagonals

  • allowDiagonals(allow: boolean): void

  • Parameters

    • allow: boolean

    Returns void

destinationReached

  • destinationReached(): boolean

  • Return true if the object reached its destination.

    Returns boolean

diagonalsAllowed

  • diagonalsAllowed(): boolean

  • Returns boolean

doStepPostEvents

doStepPreEvents

Static euclideanDistance

  • euclideanDistance(a: FloatPoint, b: FloatPoint): number

  • Compute the euclidean distance between two positions.

    memberof

    gdjs.PathfindingRuntimeBehavior

    Parameters

    • a: FloatPoint
    • b: FloatPoint

    Returns number

getAcceleration

  • getAcceleration(): number

  • Returns number

getAngleOffset

  • getAngleOffset(): number

  • Returns number

getAngularMaxSpeed

  • getAngularMaxSpeed(): number

  • Returns number

getCellHeight

  • getCellHeight(): number

  • Returns number

getCellWidth

  • getCellWidth(): number

  • Returns number

getDestinationX

  • getDestinationX(): number

  • Returns number

getDestinationY

  • getDestinationY(): number

  • Returns number

getExtraBorder

  • getExtraBorder(): number

  • Returns number

getGridOffsetX

  • getGridOffsetX(): number

  • Returns number

getGridOffsetY

  • getGridOffsetY(): number

  • Returns number

getLastNodeX

  • getLastNodeX(): number

  • Returns number

getLastNodeY

  • getLastNodeY(): number

  • Returns number

getMaxSpeed

  • getMaxSpeed(): number

  • Returns number

getMovementAngle

  • getMovementAngle(): number

  • Returns number

getName

  • getName(): string

getNameId

  • getNameId(): number

  • Get the name identifier of the behavior.

    Returns number

    The behavior's name identifier.

getNextNodeIndex

  • getNextNodeIndex(): number

  • Returns number

getNextNodeX

  • getNextNodeX(): number

  • Returns number

getNextNodeY

  • getNextNodeY(): number

  • Returns number

getNodeCount

  • getNodeCount(): number

  • Returns number

getNodeX

  • getNodeX(index: number): number

  • Parameters

    • index: number

    Returns number

getNodeY

  • getNodeY(index: number): number

  • Parameters

    • index: number

    Returns number

getSpeed

  • getSpeed(): number

  • Returns number

isObjectRotated

  • isObjectRotated(): boolean

  • Returns boolean

Static manhattanDistance

  • manhattanDistance(a: FloatPoint, b: FloatPoint): number

  • Compute the taxi distance between two positions.

    memberof

    gdjs.PathfindingRuntimeBehavior

    Parameters

    • a: FloatPoint
    • b: FloatPoint

    Returns number

moveTo

  • Compute and move on the path to the specified destination.

    Parameters

    Returns void

movementAngleIsAround

  • movementAngleIsAround(degreeAngle: number, tolerance: number): boolean

  • Parameters

    • degreeAngle: number
    • tolerance: number

    Returns boolean

onActivate

  • onActivate(): void

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

    Returns void

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

onDeActivate

  • onDeActivate(): void

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

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

pathFound

  • pathFound(): boolean

  • Return true if the latest call to moveTo succeeded.

    Returns boolean

setAcceleration

  • setAcceleration(acceleration: number): void

  • Parameters

    • acceleration: number

    Returns void

setAngleOffset

  • setAngleOffset(angleOffset: number): void

  • Parameters

    • angleOffset: number

    Returns void

setAngularMaxSpeed

  • setAngularMaxSpeed(angularMaxSpeed: number): void

  • Parameters

    • angularMaxSpeed: number

    Returns void

setCellHeight

  • setCellHeight(height: number): void

  • Parameters

    • height: number

    Returns void

setCellWidth

  • setCellWidth(width: number): void

  • Parameters

    • width: number

    Returns void

setExtraBorder

  • setExtraBorder(extraBorder: any): void

  • Parameters

    • extraBorder: any

    Returns void

setGridOffsetX

  • setGridOffsetX(gridOffsetX: number): void

  • Parameters

    • gridOffsetX: number

    Returns void

setGridOffsetY

  • setGridOffsetY(gridOffsetY: number): void

  • Parameters

    • gridOffsetY: number

    Returns void

setMaxSpeed

  • setMaxSpeed(maxSpeed: number): void

  • Parameters

    • maxSpeed: number

    Returns void

setRotateObject

  • setRotateObject(allow: boolean): void

  • Parameters

    • allow: boolean

    Returns void

setSpeed

  • setSpeed(speed: number): void

  • Parameters

    • speed: number

    Returns void

stepPostEvents

  • Called at each frame after events. Call doStepPostEvents.
    Behaviors writers: Please do not redefine this method. Redefine doStepPreEvents instead.

    Parameters

    Returns void

stepPreEvents

  • Called at each frame before events. Call doStepPreEvents.
    Behaviors writers: Please do not redefine this method. Redefine doStepPreEvents instead.

    Parameters

    Returns void

updateFromBehaviorData

  • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): 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
    • newBehaviorData: any

    Returns boolean

    true if the behavior was updated, false if it could not (i.e: hot-reload is not supported).

Constructors

constructor

Properties

name

name: string

owner

owner: RuntimeObject

type

type: string

Generated using TypeDoc