Class PlatformerObjectRuntimeBehavior

PlatformerObjectRuntimeBehavior represents a behavior allowing objects to be considered as a platform by objects having PlatformerObject Behavior.

Hierarchy (view full)

RuntimeBehavior
- PlatformerObjectRuntimeBehavior

Index

Constructors

constructor

new PlatformerObjectRuntimeBehavior(instanceContainer, behaviorData, owner): PlatformerObjectRuntimeBehavior
Parameters
- instanceContainer: RuntimeInstanceContainer
- behaviorData: any
- owner: RuntimeObject
Returns PlatformerObjectRuntimeBehavior
Overrides RuntimeBehavior.constructor
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:184

Properties

name

name: string

owner

owner: RuntimeObject

The object owning the behavior

type

type: string

`Static` `Private` `Readonly` epsilon

epsilon: number = ...

A very small value compare to 1 pixel, yet very huge compare to rounding errors.

Methods

abortJump

abortJump(): void
Abort the current jump.

When the character is not in the jumping state this method has no effect.

Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1631

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

canGrabPlatforms

canGrabPlatforms(): boolean
Check if the Platformer Object can grab the platforms.

Returns boolean
Returns true if the object can grab the platforms.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1487

canJump

canJump(): boolean
Check if the Platformer Object can jump.

Returns boolean
Returns true if the object can jump.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1495

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/PlatformBehavior/platformerobjectruntimebehavior.ts:550

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/PlatformBehavior/platformerobjectruntimebehavior.ts:399

enableSynchronization

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

getAcceleration

getAcceleration(): number
Get the acceleration value of the Platformer Object.

Returns number
The current acceleration.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1411

getCurrentFallSpeed

getCurrentFallSpeed(): number
Get the speed at which the object is falling. It is 0 when the object is on a floor, and non 0 as soon as the object leaves the floor.

Returns number
The current fall speed.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1451

getCurrentJumpSpeed

getCurrentJumpSpeed(): number
Get the current jump speed of the Platformer Object.

Returns number
The current jump speed.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1479

getCurrentSpeed

getCurrentSpeed(): number
Get the current speed of the Platformer Object.

Returns number
The current speed.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1459

getDeceleration

getDeceleration(): number
Get the deceleration of the Platformer Object.

Returns number
The current deceleration.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1419

getGravity

getGravity(): number
Get the gravity of the Platformer Object.

Returns number
The current gravity.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1379

getJumpSpeed

getJumpSpeed(): number
Get the jump speed of the Platformer Object.

Returns number
The jump speed.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1435

getJumpSustainTime

getJumpSustainTime(): number
Get the jump sustain time of the Platformer Object.

Returns number
The jump sustain time.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1443

getLadderClimbingSpeed

getLadderClimbingSpeed(): number
Get the speed used to move on Y axis when climbing a ladder.

Returns number
The speed of ladder climbing.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1403

getMaxFallingSpeed

getMaxFallingSpeed(): number
Get the maximum falling speed of the Platformer Object.

Returns number
The maximum falling speed.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1395

getMaxSpeed

getMaxSpeed(): number
Get the maximum speed of the Platformer Object.

Returns number
The maximum speed.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1427

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(): PlatformerObjectNetworkSyncData
Returns PlatformerObjectNetworkSyncData
Overrides RuntimeBehavior.getNetworkSyncData
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:224

getSlopeMaxAngle

getSlopeMaxAngle(): number
Get maximum angle of a slope for the Platformer Object to run on it as a floor.

Returns number
the slope maximum angle, in degrees.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1387

ignoreDefaultControls

ignoreDefaultControls(ignore): void
Ignore the default controls of the Platformer Object.
Parameters
- ignore: boolean
  Enable / Disable default controls.
Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1668

isFalling

isFalling(): boolean
Check if the Platformer Object is "going down", either because it's in the falling state or because it's jumping but reached the jump peak and is now going down (because the jump speed can't compensate anymore the falling speed).

If you want to check if the object is falling outside of a jump (or because the jump is entirely finished and there is no jump speed applied to the object anymore), consider using isFallingWithoutJumping.

Returns boolean
Returns true if it is "going down" and false if not.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1805

isFallingWithoutJumping

isFallingWithoutJumping(): boolean
Check if the Platformer Object is in the falling state. This is false if the object is jumping, even if the object is going down after reaching the jump peak.

Returns boolean
Returns true if it is falling and false if not.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1789

isGrabbingPlatform

isGrabbingPlatform(): boolean
Check if the Platformer Object is grabbing a platform.

Returns boolean
Returns true if a platform is grabbed and false if not.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1779

isJumping

isJumping(): boolean
Check if the Platformer Object is jumping.

Returns boolean
Returns true if jumping and false if not.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1771

isMoving

isMoving(): boolean
Check if the Platformer Object is moving.

When walking or climbing on a ladder, a speed of less than one pixel per frame won't be detected.

Returns boolean
Returns true if it is moving and false if not.

Deprecated
use isMovingEvenALittle instead
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1822

isMovingEvenALittle

isMovingEvenALittle(): boolean
Check if the Platformer Object is moving.

Returns boolean
Returns true if it is moving and false if not.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1835

isOnFloor

isOnFloor(): boolean
Check if the Platformer Object is on a floor.

Returns boolean
Returns true if on a floor and false if not.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1743

isOnFloorObject

isOnFloorObject(object): boolean
Check if the Platformer Object is on the given object.
Parameters
- object: RuntimeObject
Returns boolean
Returns true if on the object and false if not.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1751

isOnLadder

isOnLadder(): boolean
Check if the Platformer Object is on a ladder.

Returns boolean
Returns true if on a ladder and false if not.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1763

isSyncedOverNetwork

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

isUsingControl

isUsingControl(input): boolean
.
Parameters
- input: string
  The control to be tested [Left,Right,Up,Down,Ladder,Jump,Release,Release Ladder].
Returns boolean
true if the key was used since the last doStepPreEvents call.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1347

onActivate

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

Returns void
Inherited from RuntimeBehavior.onActivate
- Defined in GDJS/Runtime/runtimebehavior.ts:190

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
Inherited from RuntimeBehavior.onDeActivate
- Defined in GDJS/Runtime/runtimebehavior.ts:195

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
Inherited from RuntimeBehavior.onDestroy
- Defined in GDJS/Runtime/runtimebehavior.ts:216

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

setAcceleration

setAcceleration(acceleration): void
Set the acceleration of the Platformer Object.
Parameters
- acceleration: number
  The new acceleration.
Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1545

setCanGrabPlatforms

setCanGrabPlatforms(enable): void
Set if the Platformer Object can grab platforms.
Parameters
- enable: boolean
  Enable / Disable grabbing of platforms.
Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1657

setCanJump

setCanJump(): void
Allow the Platformer Object to jump again.

Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1613

setCanNotAirJump

setCanNotAirJump(): void
Forbid the Platformer Object to air jump.

Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1620

setCurrentFallSpeed

setCurrentFallSpeed(currentFallSpeed): void
Set the current fall speed.

When the character is not in the falling state this method has no effect.
Parameters
- currentFallSpeed: number
Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1643

setCurrentSpeed

setCurrentSpeed(currentSpeed): void
Set the current speed of the Platformer Object.
Parameters
- currentSpeed: number
  The current speed.
Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1467

setDeceleration

setDeceleration(deceleration): void
Set the deceleration of the Platformer Object.
Parameters
- deceleration: number
  The new deceleration.
Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1553

setGravity

setGravity(gravity): void
Set the gravity of the Platformer Object.
Parameters
- gravity: number
  The new gravity.
Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1503

setJumpSpeed

setJumpSpeed(jumpSpeed): void
Set the jump speed of the Platformer Object.
Parameters
- jumpSpeed: number
  The new jump speed.
Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1569

setJumpSustainTime

setJumpSustainTime(jumpSustainTime): void
Set the jump sustain time of the Platformer Object.
Parameters
- jumpSustainTime: number
  The new jump sustain time.
Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1577

setLadderClimbingSpeed

setLadderClimbingSpeed(ladderClimbingSpeed): void
Set the speed used to move on Y axis when climbing a ladder.
Parameters
- ladderClimbingSpeed: number
  The speed of ladder climbing.
Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1537

setMaxFallingSpeed

setMaxFallingSpeed(maxFallingSpeed, tryToPreserveAirSpeed?): void
Set the maximum falling speed of the Platformer Object.
Parameters
- maxFallingSpeed: number
  The maximum falling speed.
- tryToPreserveAirSpeed: boolean = false
  If true and if jumping, tune the current jump speed to preserve the overall speed in the air.
Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1512

setMaxSpeed

setMaxSpeed(maxSpeed): void
Set the maximum speed of the Platformer Object.
Parameters
- maxSpeed: number
  The new maximum speed.
Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1561

setSlopeMaxAngle

setSlopeMaxAngle(slopeMaxAngle): void
Set the maximum slope angle of the Platformer Object.
Parameters
- slopeMaxAngle: number
  The new maximum slope angle.
Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1585

shouldIgnoreDefaultControls

shouldIgnoreDefaultControls(): boolean
Check if the default controls of the Platformer Object are ignored.

Returns boolean
true if the default controls are ignored.
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1676

simulateControl

simulateControl(input): void
Simulate a control action in the Platformer Object by specifying an input.
Parameters
- input: string
  The string expression of the control action [Left,Right,Up,Down,Ladder,Jump,Release,Release Ladder].
Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1323

simulateDownKey

simulateDownKey(): void
Simulate the "Down" control of the Platformer Object.

Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1721

simulateJumpKey

simulateJumpKey(): void
Simulate the "Jump" control of the Platformer Object.

Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1728

simulateLadderKey

simulateLadderKey(): void
Simulate the "Ladder" control of the Platformer Object.

Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1700

simulateLeftKey

simulateLeftKey(): void
Simulate the "Left" control of the Platformer Object.

Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1686

simulateReleaseLadderKey

simulateReleaseLadderKey(): void
Simulate the "Release Ladder" control of the Platformer Object.

Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1707

simulateReleasePlatformKey

simulateReleasePlatformKey(): void
Simulate the "Release" control of the Platformer Object.

Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1735

simulateRightKey

simulateRightKey(): void
Simulate the "Right" control of the Platformer Object.

Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1693

simulateUpKey

simulateUpKey(): void
Simulate the "Up" control of the Platformer Object.

Returns void
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:1714

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/PlatformBehavior/platformerobjectruntimebehavior.ts:345

updateFromNetworkSyncData

updateFromNetworkSyncData(networkSyncData): void
Update the behavior properties using the provided data.
Parameters
- networkSyncData: PlatformerObjectNetworkSyncData
  The new properties of the behavior.
Returns void
Overrides RuntimeBehavior.updateFromNetworkSyncData
- Defined in Extensions/PlatformBehavior/platformerobjectruntimebehavior.ts:258

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 PlatformerObjectRuntimeBehavior

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PlatformerObjectRuntimeBehavior

Properties

name

owner

type

Static Private Readonly epsilon

Methods

abortJump

Returns void

activate

Parameters

Returns void

activated

Returns boolean

canGrabPlatforms

Returns boolean

canJump

Returns boolean

doStepPostEvents

Parameters

Returns void

doStepPreEvents

Parameters

Returns void

enableSynchronization

Parameters

Returns void

getAcceleration

Returns number

getCurrentFallSpeed

Returns number

getCurrentJumpSpeed

Returns number

getCurrentSpeed

Returns number

getDeceleration

Returns number

getGravity

Returns number

getJumpSpeed

Returns number

getJumpSustainTime

Returns number

getLadderClimbingSpeed

Returns number

getMaxFallingSpeed

Returns number

getMaxSpeed

Returns number

getName

Returns string

getNameId

Returns number

getNetworkSyncData

Returns PlatformerObjectNetworkSyncData

getSlopeMaxAngle

Returns number

ignoreDefaultControls

Parameters

Returns void

isFalling

Returns boolean

isFallingWithoutJumping

Returns boolean

isGrabbingPlatform

Returns boolean

isJumping

Returns boolean

isMoving

Returns boolean

Deprecated

`Static` `Private` `Readonly` epsilon