From d16c13854a8257d722c60e67b1c7bc2e50393741 Mon Sep 17 00:00:00 2001 From: GDevelop documentation CI Date: Fri, 5 Jul 2024 00:11:47 +0000 Subject: [PATCH] Update documentation [skip ci] --- .../classes/gdjs.AbstractDebuggerClient.html | 24 +- .../classes/gdjs.AffineTransformation.html | 46 +- .../classes/gdjs.AnchorRuntimeBehavior.html | 34 +- .../classes/gdjs.AnimatableBehavior.html | 50 +- .../classes/gdjs.AsyncTask.html | 2 +- .../classes/gdjs.AsyncTasksManager.html | 6 +- .../classes/gdjs.BBTextRuntimeObject.html | 348 +++++++------- .../gdjs.BBTextRuntimeObjectPixiRenderer.html | 4 +- .../classes/gdjs.Base3DBehavior.html | 68 +-- .../classes/gdjs.BehaviorRBushAABB.html | 2 +- .../classes/gdjs.BitmapTextRuntimeObject.html | 358 +++++++-------- ...s.BitmapTextRuntimeObjectPixiRenderer.html | 6 +- .../classes/gdjs.Cube3DRuntimeObject.html | 392 ++++++++-------- .../classes/gdjs.CustomRuntimeObject.html | 378 ++++++++-------- .../classes/gdjs.CustomRuntimeObject2D.html | 378 ++++++++-------- ...djs.CustomRuntimeObject2DPixiRenderer.html | 6 +- .../classes/gdjs.CustomRuntimeObject3D.html | 422 ++++++++--------- .../gdjs.CustomRuntimeObject3DRenderer.html | 4 +- ....CustomRuntimeObjectInstanceContainer.html | 70 +-- .../classes/gdjs.DebuggerPixiRenderer.html | 4 +- .../gdjs.DestroyOutsideRuntimeBehavior.html | 38 +- .../gdjs.DraggableRuntimeBehavior.html | 34 +- ...js.DummyWithSharedDataRuntimeBehavior.html | 34 +- .../classes/gdjs.EffectBehavior.html | 44 +- .../classes/gdjs.FlippableBehavior.html | 34 +- .../gdjs.FontFaceObserverFontManager.html | 12 +- .../classes/gdjs.Force.html | 22 +- .../classes/gdjs.HotReloader.html | 6 +- .../classes/gdjs.HowlerSound.html | 46 +- .../classes/gdjs.HowlerSoundManager.html | 12 +- .../classes/gdjs.InGameDebugger.html | 2 +- .../classes/gdjs.InputManager.html | 64 +-- .../classes/gdjs.Inventory.html | 2 +- .../classes/gdjs.InventoryManager.html | 2 +- .../classes/gdjs.JsonManager.html | 14 +- .../classes/gdjs.Layer.html | 86 ++-- .../classes/gdjs.LayerPixiRenderer.html | 18 +- .../classes/gdjs.LightNightPixiFilter.html | 2 +- .../gdjs.LightObstacleRuntimeBehavior.html | 34 +- .../classes/gdjs.LightObstaclesManager.html | 10 +- .../classes/gdjs.LightRuntimeObject.html | 348 +++++++------- .../gdjs.LightRuntimeObjectPixiRenderer.html | 2 +- .../classes/gdjs.LinksManager.html | 8 +- .../classes/gdjs.Logger.html | 10 +- .../classes/gdjs.LongLivedObjectsList.html | 4 +- .../classes/gdjs.ManuallyResolvableTask.html | 4 +- .../classes/gdjs.Model3DManager.html | 10 +- .../classes/gdjs.Model3DRuntimeObject.html | 402 ++++++++--------- ...gdjs.MultiplayerObjectRuntimeBehavior.html | 34 +- .../classes/gdjs.NightPixiFilter.html | 2 +- .../classes/gdjs.OnceTriggers.html | 4 +- .../classes/gdjs.OpacityBehavior.html | 38 +- .../gdjs.PanelSpriteRuntimeObject.html | 358 +++++++-------- .../classes/gdjs.ParticleEmitterObject.html | 344 +++++++------- ...djs.ParticleEmitterObjectPixiRenderer.html | 2 +- ...js.PathfindingObstacleRuntimeBehavior.html | 34 +- .../gdjs.PathfindingObstaclesManager.html | 10 +- ...djs.PathfindingRuntimeBehavior-1.Node.html | 2 +- .../gdjs.PathfindingRuntimeBehavior.html | 44 +- .../classes/gdjs.Physics2RuntimeBehavior.html | 42 +- .../classes/gdjs.Physics2SharedData.html | 14 +- .../classes/gdjs.PhysicsRuntimeBehavior.html | 36 +- .../classes/gdjs.PhysicsSharedData.html | 4 +- .../classes/gdjs.PixiBitmapFontManager.html | 14 +- .../gdjs.PixiFiltersTools.EmptyFilter.html | 14 +- .../gdjs.PixiFiltersTools.PixiFilter.html | 16 +- ...js.PixiFiltersTools.PixiFilterCreator.html | 12 +- .../classes/gdjs.PixiImageManager.html | 26 +- .../classes/gdjs.PlatformObjectsManager.html | 10 +- .../classes/gdjs.PlatformRuntimeBehavior.html | 36 +- .../gdjs.PlatformerObjectRuntimeBehavior.html | 134 +++--- .../classes/gdjs.Polygon.html | 22 +- .../classes/gdjs.Profiler.html | 8 +- .../classes/gdjs.PromiseTask.html | 2 +- .../classes/gdjs.ResizableBehavior.html | 44 +- .../classes/gdjs.ResolveTask.html | 2 +- .../classes/gdjs.ResourceCache.html | 4 +- .../classes/gdjs.ResourceLoader.html | 42 +- .../classes/gdjs.RuntimeBehavior.html | 36 +- .../gdjs.RuntimeCustomObjectLayer.html | 86 ++-- .../classes/gdjs.RuntimeGame.html | 114 ++--- .../classes/gdjs.RuntimeGamePixiRenderer.html | 40 +- .../gdjs.RuntimeInstanceContainer.html | 70 +-- .../classes/gdjs.RuntimeLayer.html | 86 ++-- .../classes/gdjs.RuntimeObject.html | 340 +++++++------- .../classes/gdjs.RuntimeObject3D.html | 386 ++++++++-------- .../classes/gdjs.RuntimeObject3DRenderer.html | 2 +- .../classes/gdjs.RuntimeScene.html | 130 +++--- .../gdjs.RuntimeScenePixiRenderer.html | 8 +- .../classes/gdjs.ScalableBehavior.html | 46 +- .../classes/gdjs.SceneStack.html | 12 +- .../gdjs.ShapePainterRuntimeObject.html | 368 +++++++-------- .../classes/gdjs.ShopifyClientsManager.html | 2 +- .../classes/gdjs.SpineAtlasManager.html | 14 +- .../classes/gdjs.SpineManager.html | 10 +- .../classes/gdjs.SpineRuntimeObject.html | 372 +++++++-------- .../gdjs.SpineRuntimeObjectPixiRenderer.html | 4 +- .../classes/gdjs.SpriteAnimation.html | 4 +- .../gdjs.SpriteAnimationDirection.html | 4 +- .../classes/gdjs.SpriteAnimationFrame.html | 6 +- .../classes/gdjs.SpriteAnimator.html | 30 +- .../classes/gdjs.SpriteRuntimeObject.html | 400 ++++++++-------- .../gdjs.SpriteRuntimeObjectPixiRenderer.html | 8 +- .../classes/gdjs.TaskGroup.html | 4 +- .../classes/gdjs.TextContainerBehavior.html | 38 +- .../classes/gdjs.TextEntryRuntimeObject.html | 334 +++++++------- .../classes/gdjs.TextInputRuntimeObject.html | 358 +++++++-------- .../classes/gdjs.TextRuntimeObject.html | 426 +++++++++--------- ....TileMap.TileMapCollisionMaskRenderer.html | 2 +- .../gdjs.TileMap.TileMapRuntimeManager.html | 8 +- ...s.TileMap.TransformedCollisionTileMap.html | 34 +- ...eMap.TransformedCollisionTileMapLayer.html | 24 +- ...djs.TileMapCollisionMaskRuntimeObject.html | 364 +++++++-------- .../classes/gdjs.TileMapRuntimeObject.html | 354 +++++++-------- ...gdjs.TileMapRuntimeObjectPixiRenderer.html | 4 +- .../gdjs.TiledSpriteRuntimeObject.html | 366 +++++++-------- .../classes/gdjs.TimeManager.html | 12 +- .../classes/gdjs.Timer.html | 16 +- ...timeBehavior-1.IsometryTransformation.html | 4 +- ...Behavior-1.TopDownMovementHookContext.html | 4 +- .../gdjs.TopDownMovementRuntimeBehavior.html | 38 +- .../classes/gdjs.TweenRuntimeBehavior.html | 132 +++--- .../classes/gdjs.Variable.html | 90 ++-- .../classes/gdjs.VariablesContainer.html | 20 +- .../classes/gdjs.VideoRuntimeObject.html | 370 +++++++-------- .../gdjs.VideoRuntimeObjectPixiRenderer.html | 42 +- .../classes/gdjs.WebsocketDebuggerClient.html | 24 +- .../gdjs.WindowMessageDebuggerClient.html | 24 +- .../classes/gdjs.evtTools.p2p.Event.html | 10 +- .../classes/gdjs.evtTools.p2p.EventData.html | 4 +- .../gdjs.evtTools.runtimeScene.WaitTask.html | 4 +- ...s.multiplayerPeerJsHelper.MessageData.html | 2 +- ....multiplayerPeerJsHelper.MessagesList.html | 2 +- .../gdjs.watermark.RuntimeWatermark.html | 2 +- ...js.Cube3DRuntimeObject-1.MaterialType.html | 2 +- ...s.Model3DRuntimeObject-1.MaterialType.html | 2 +- .../enums/gdjs.RuntimeLayerCameraType.html | 2 +- .../enums/gdjs.RuntimeLayerRenderingType.html | 2 +- .../enums/gdjs.SceneChangeRequest.html | 2 +- .../interfaces/gdjs.Animatable.html | 18 +- .../gdjs.AnimationFrameTextureManager.html | 2 +- .../interfaces/gdjs.Base3DHandler.html | 34 +- .../interfaces/gdjs.Cube3DObjectData.html | 12 +- .../interfaces/gdjs.EffectHandler.html | 10 +- .../interfaces/gdjs.EffectsTarget.html | 2 +- .../interfaces/gdjs.Flippable.html | 2 +- .../gdjs.LightNightFilterExtra.html | 2 +- .../interfaces/gdjs.LoggerOutput.html | 2 +- .../interfaces/gdjs.Model3DObjectData.html | 12 +- .../interfaces/gdjs.Object3DData.html | 12 +- .../interfaces/gdjs.Object3DDataContent.html | 2 +- .../interfaces/gdjs.OpacityHandler.html | 4 +- .../gdjs.PathfindingNetworkSyncData.html | 2 +- .../gdjs.Physics2NetworkSyncData.html | 2 +- .../gdjs.PixiFiltersTools.Filter.html | 14 +- .../gdjs.PixiFiltersTools.FilterCreator.html | 2 +- .../gdjs.PlatformerObjectNetworkSyncData.html | 2 +- .../interfaces/gdjs.Resizable.html | 10 +- .../interfaces/gdjs.ResourceManager.html | 6 +- ....RuntimeInstanceContainerPixiRenderer.html | 2 +- .../interfaces/gdjs.Scalable.html | 12 +- .../interfaces/gdjs.TextContainer.html | 4 +- .../interfaces/gdjs.TextInputObjectData.html | 12 +- .../gdjs.TopDownMovementNetworkSyncData.html | 2 +- ...RuntimeBehavior-1.BasisTransformation.html | 2 +- ...RuntimeBehavior-1.TopDownMovementHook.html | 6 +- .../interfaces/gdjs.evtTools.p2p.IEvent.html | 2 +- .../gdjs.evtTools.p2p.IEventData.html | 2 +- .../gdjs.evtTools.tween.TimeSource.html | 2 +- ....multiplayerPeerJsHelper.IMessageData.html | 2 +- ...multiplayerPeerJsHelper.IMessagesList.html | 2 +- .../modules/gdjs.Base3DHandler-1.html | 2 +- .../modules/gdjs.PixiFiltersTools.html | 6 +- .../modules/gdjs.adMob.html | 32 +- .../modules/gdjs.deviceSensors.motion.html | 18 +- .../gdjs.deviceSensors.orientation.html | 14 +- .../modules/gdjs.deviceVibration.html | 6 +- .../modules/gdjs.evtTools.advancedWindow.html | 2 +- .../modules/gdjs.evtTools.camera.html | 16 +- .../modules/gdjs.evtTools.common.html | 70 +-- .../modules/gdjs.evtTools.debuggerTools.html | 6 +- .../gdjs.evtTools.exampleJsExtension.html | 2 +- .../gdjs.evtTools.facebookInstantGames.html | 2 +- ...gdjs.evtTools.firebaseTools.analytics.html | 6 +- .../gdjs.evtTools.firebaseTools.auth.html | 18 +- ...seTools.auth.userManagement.dangerous.html | 12 +- ...ols.firebaseTools.auth.userManagement.html | 26 +- .../gdjs.evtTools.firebaseTools.database.html | 20 +- ...gdjs.evtTools.firebaseTools.firestore.html | 42 +- ...gdjs.evtTools.firebaseTools.functions.html | 2 +- .../modules/gdjs.evtTools.firebaseTools.html | 2 +- ...js.evtTools.firebaseTools.performance.html | 8 +- ...s.evtTools.firebaseTools.remoteConfig.html | 4 +- .../gdjs.evtTools.firebaseTools.storage.html | 8 +- .../modules/gdjs.evtTools.input.html | 14 +- .../modules/gdjs.evtTools.inventory.html | 2 +- .../modules/gdjs.evtTools.leaderboards.html | 4 +- .../modules/gdjs.evtTools.linkedObjects.html | 2 +- .../modules/gdjs.evtTools.network.html | 10 +- .../modules/gdjs.evtTools.object.html | 18 +- .../modules/gdjs.evtTools.p2p.html | 56 +-- .../modules/gdjs.evtTools.platform.html | 2 +- .../modules/gdjs.evtTools.runtimeScene.html | 18 +- .../modules/gdjs.evtTools.shopify.html | 2 +- .../modules/gdjs.evtTools.sound.html | 2 +- .../modules/gdjs.evtTools.spatialSound.html | 2 +- .../modules/gdjs.evtTools.storage.html | 6 +- .../modules/gdjs.evtTools.string.html | 28 +- .../modules/gdjs.evtTools.systemInfo.html | 12 +- .../modules/gdjs.evtTools.tween.html | 32 +- .../modules/gdjs.evtTools.variable.html | 36 +- .../modules/gdjs.evtTools.window.html | 2 +- .../modules/gdjs.fileSystem.html | 44 +- GDJS Runtime Documentation/modules/gdjs.html | 128 +++--- .../modules/gdjs.multiplayer.html | 30 +- .../modules/gdjs.multiplayerComponents.html | 16 +- .../modules/gdjs.multiplayerPeerJsHelper.html | 24 +- .../modules/gdjs.pathfinding.html | 4 +- .../modules/gdjs.physics2.html | 2 +- .../modules/gdjs.playerAuthentication.html | 22 +- .../gdjs.playerAuthenticationComponents.html | 20 +- .../modules/gdjs.scene3d.camera.html | 2 +- .../modules/gdjs.screenshot.html | 2 +- .../modules/gdjs.steamworks.html | 2 +- 224 files changed, 6017 insertions(+), 6017 deletions(-) diff --git a/GDJS Runtime Documentation/classes/gdjs.AbstractDebuggerClient.html b/GDJS Runtime Documentation/classes/gdjs.AbstractDebuggerClient.html index 53dcabe7e..9a58ad711 100644 --- a/GDJS Runtime Documentation/classes/gdjs.AbstractDebuggerClient.html +++ b/GDJS Runtime Documentation/classes/gdjs.AbstractDebuggerClient.html @@ -1,48 +1,48 @@ AbstractDebuggerClient | GDevelop JavaScript game engine
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AbstractDebuggerClient

The base class describing a debugger client, that can be used to inspect a runtime game (dump its state) or alter it.

-

Hierarchy

Index

Methods

Constructors

Methods

call

  • call(path: string[], args: any[]): boolean

Hierarchy

Index

Methods

Constructors

Methods

call

  • call(path: string[], args: any[]): boolean

log

  • log(group: string, message: string, type: "info" | "warning" | "error", internal: boolean): void

log

  • log(group: string, message: string, type: "info" | "warning" | "error", internal: boolean): void

onUncaughtException

  • onUncaughtException(exception: Error): void

sendGamePaused

  • sendGamePaused(): void

onUncaughtException

  • onUncaughtException(exception: Error): void

sendGamePaused

  • sendGamePaused(): void

sendGameResumed

  • sendGameResumed(): void

sendGameResumed

  • sendGameResumed(): void

sendHotReloaderLogs

sendHotReloaderLogs

sendProfilerOutput

Returns void

sendProfilerOutput

sendProfilerStarted

  • sendProfilerStarted(): void

Returns void

sendProfilerStarted

  • sendProfilerStarted(): void

sendProfilerStopped

  • sendProfilerStopped(): void

sendProfilerStopped

  • sendProfilerStopped(): void

sendRuntimeGameDump

  • sendRuntimeGameDump(): void

sendRuntimeGameDump

  • sendRuntimeGameDump(): void

set

  • set(path: string[], newValue: any): boolean

set

  • set(path: string[], newValue: any): boolean

Protected handleCommand

  • handleCommand(data: any): void

Protected handleCommand

  • handleCommand(data: any): void

Constructors

constructor

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AffineTransformation

An affine transformation that can transform points.

-

Hierarchy

  • AffineTransformation

Index

Methods

Constructors

Properties

Methods

concatenate

Hierarchy

  • AffineTransformation

Index

Methods

Constructors

Properties

Methods

concatenate

copyFrom

Returns void

copyFrom

equals

Returns AffineTransformation

equals

flipX

  • flipX(anchorX: number): void

Returns boolean

flipX

  • flipX(anchorX: number): void

flipY

  • flipY(anchorY: number): void

Returns void

flipY

  • flipY(anchorY: number): void

invert

Returns void

invert

isIdentity

  • isIdentity(): boolean

isIdentity

  • isIdentity(): boolean

nearlyEquals

nearlyEquals

preConcatenate

Returns boolean

preConcatenate

rotate

  • rotate(angle: number): void

Returns void

rotate

  • rotate(angle: number): void

rotateAround

  • rotateAround(angle: number, anchorX: number, anchorY: number): void

Returns void

rotateAround

  • rotateAround(angle: number, anchorX: number, anchorY: number): void

  • Concatenate a rotation.

    Parameters

    • angle: number

      The angle of rotation in radians.

      @@ -46,25 +46,25 @@

      The rotation anchor point X.

    • anchorY: number

      The rotation anchor point Y.

      -

    Returns void

scale

  • scale(sx: number, sy: number): void

Returns void

scale

  • scale(sx: number, sy: number): void

setToFlipX

  • setToFlipX(anchorX: number): void

Returns void

setToFlipX

  • setToFlipX(anchorX: number): void

setToFlipY

  • setToFlipY(anchorY: number): void

Returns void

setToFlipY

  • setToFlipY(anchorY: number): void

setToIdentity

  • setToIdentity(): void

Returns void

setToIdentity

  • setToIdentity(): void

setToRotation

  • setToRotation(theta: number): void

setToRotation

  • setToRotation(theta: number): void

setToRotationAround

  • setToRotationAround(angle: number, anchorX: number, anchorY: number): void

setToRotationAround

  • setToRotationAround(angle: number, anchorX: number, anchorY: number): void

  • Reset to a rotation.

    Parameters

    • angle: number

      The angle of rotation in radians.

      @@ -72,29 +72,29 @@

      The rotation anchor point X.

    • anchorY: number

      The rotation anchor point Y.

      -

    Returns void

setToScale

  • setToScale(sx: number, sy: number): void

Returns void

setToScale

  • setToScale(sx: number, sy: number): void

setToTranslation

  • setToTranslation(tx: number, ty: number): void

Returns void

setToTranslation

  • setToTranslation(tx: number, ty: number): void

toString

  • toString(): string

transform

  • transform(source: FloatPoint, destination: FloatPoint): void

toString

  • toString(): string

transform

  • transform(source: FloatPoint, destination: FloatPoint): void

  • Transform a point.

    Parameters

    • source: FloatPoint

      The point to transform.

    • destination: FloatPoint

      The Point to store the transformed coordinates.

      -

    Returns void

translate

  • translate(tx: number, ty: number): void

Returns void

translate

  • translate(tx: number, ty: number): void

Constructors

constructor

Returns void

Constructors

constructor

Properties

Private matrix

matrix: Float32Array

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AnchorRuntimeBehavior

Hierarchy

Index

Properties

Methods

Constructors

Properties

Static HorizontalAnchor

HorizontalAnchor: { NONE: number; PROPORTIONAL: number; WINDOW_LEFT: number; WINDOW_RIGHT: number } = ...

Type declaration

  • NONE: number
  • PROPORTIONAL: number
  • WINDOW_LEFT: number
  • WINDOW_RIGHT: number

Static VerticalAnchor

VerticalAnchor: { NONE: number; PROPORTIONAL: number; WINDOW_BOTTOM: number; WINDOW_TOP: number } = ...

Type declaration

  • NONE: number
  • PROPORTIONAL: number
  • WINDOW_BOTTOM: number
  • WINDOW_TOP: number

name

name: string

owner

owner: RuntimeObject

type

type: string

Methods

activate

  • activate(enable: boolean): void

activated

  • activated(): boolean

doStepPostEvents

doStepPostEvents

doStepPreEvents

doStepPreEvents

enableSynchronization

  • enableSynchronization(enable: boolean): void

getName

  • getName(): string

enableSynchronization

  • enableSynchronization(enable: boolean): void

getName

  • getName(): string

getNameId

  • getNameId(): number

getNameId

  • getNameId(): number

getNetworkSyncData

  • getNetworkSyncData(): BehaviorNetworkSyncData

isSyncedOverNetwork

  • isSyncedOverNetwork(): boolean

onActivate

  • onActivate(): void

getNetworkSyncData

  • getNetworkSyncData(): BehaviorNetworkSyncData

isSyncedOverNetwork

  • isSyncedOverNetwork(): boolean

onActivate

  • onActivate(): void

onCreated

  • onCreated(): void

onCreated

  • onCreated(): void

onDeActivate

  • onDeActivate(): void

onDeActivate

  • onDeActivate(): void

onDestroy

  • onDestroy(): 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

onObjectHotReloaded

  • onObjectHotReloaded(): void

stepPostEvents

stepPostEvents

stepPreEvents

Returns void

stepPreEvents

updateFromBehaviorData

  • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

Returns void

updateFromBehaviorData

  • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

updateFromNetworkSyncData

  • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

updateFromNetworkSyncData

  • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

usesLifecycleFunction

  • usesLifecycleFunction(): boolean

Returns void

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

Constructors

constructor

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AnimatableBehavior

A behavior that forwards the Animatable interface to its object.

-

Hierarchy

Implements

Index

Methods

Constructors

Properties

Methods

activate

  • activate(enable: boolean): void

Hierarchy

Implements

Index

Methods

Constructors

Properties

Methods

activate

  • activate(enable: boolean): void

activated

  • activated(): boolean

Returns void

activated

  • activated(): boolean

doStepPostEvents

doStepPostEvents

doStepPreEvents

doStepPreEvents

enableSynchronization

  • enableSynchronization(enable: boolean): void

getAnimationDuration

  • getAnimationDuration(): number

getAnimationElapsedTime

  • getAnimationElapsedTime(): number

getAnimationIndex

  • getAnimationIndex(): number

enableSynchronization

  • enableSynchronization(enable: boolean): void

getAnimationDuration

  • getAnimationDuration(): number

getAnimationElapsedTime

  • getAnimationElapsedTime(): number

getAnimationIndex

  • getAnimationIndex(): number

getAnimationName

  • getAnimationName(): string

getAnimationName

  • getAnimationName(): string

getAnimationSpeedScale

  • getAnimationSpeedScale(): number

getName

  • getName(): string

getAnimationSpeedScale

  • getAnimationSpeedScale(): number

getName

  • getName(): string

getNameId

  • getNameId(): number

getNameId

  • getNameId(): number

getNetworkSyncData

  • getNetworkSyncData(): BehaviorNetworkSyncData

hasAnimationEnded

  • hasAnimationEnded(): boolean

getNetworkSyncData

  • getNetworkSyncData(): BehaviorNetworkSyncData

hasAnimationEnded

  • hasAnimationEnded(): boolean

isAnimationPaused

  • isAnimationPaused(): boolean

isSyncedOverNetwork

  • isSyncedOverNetwork(): boolean

onActivate

  • onActivate(): void

isAnimationPaused

  • isAnimationPaused(): boolean

isSyncedOverNetwork

  • isSyncedOverNetwork(): boolean

onActivate

  • onActivate(): void

onCreated

  • onCreated(): void

onCreated

  • onCreated(): void

onDeActivate

  • onDeActivate(): void

onDeActivate

  • onDeActivate(): void

onDestroy

  • onDestroy(): 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

onObjectHotReloaded

  • onObjectHotReloaded(): void

pauseAnimation

  • pauseAnimation(): void

resumeAnimation

  • resumeAnimation(): void

setAnimationElapsedTime

  • setAnimationElapsedTime(time: number): void

pauseAnimation

  • pauseAnimation(): void

resumeAnimation

  • resumeAnimation(): void

setAnimationElapsedTime

  • setAnimationElapsedTime(time: number): void

setAnimationIndex

  • setAnimationIndex(animationIndex: number): void

setAnimationIndex

  • setAnimationIndex(animationIndex: number): void

setAnimationName

  • setAnimationName(newAnimationName: string): void

setAnimationName

  • setAnimationName(newAnimationName: string): void

setAnimationSpeedScale

  • setAnimationSpeedScale(ratio: number): void

stepPostEvents

setAnimationSpeedScale

  • setAnimationSpeedScale(ratio: number): void

stepPostEvents

stepPreEvents

Returns void

stepPreEvents

updateFromBehaviorData

  • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

Returns void

updateFromBehaviorData

  • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

updateFromNetworkSyncData

  • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

updateFromNetworkSyncData

  • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

usesLifecycleFunction

  • usesLifecycleFunction(): boolean

Returns void

usesLifecycleFunction

  • usesLifecycleFunction(): boolean

Constructors

constructor

Properties

name

name: string

owner

owner: RuntimeObject

type

type: string

Private object

object: RuntimeObject & Animatable

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AsyncTask

An asynchronous task to be run between frames.

-

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

Abstract update

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

Abstract update

  • Called every frame where the scene is active.

    Parameters

    • runtimeScene: RuntimeScene

      The scene the task runs on.

      diff --git a/GDJS Runtime Documentation/classes/gdjs.AsyncTasksManager.html b/GDJS Runtime Documentation/classes/gdjs.AsyncTasksManager.html index 34d53f81e..c7f5a2437 100644 --- a/GDJS Runtime Documentation/classes/gdjs.AsyncTasksManager.html +++ b/GDJS Runtime Documentation/classes/gdjs.AsyncTasksManager.html @@ -2,15 +2,15 @@

      This stores all asynchronous tasks waiting to be completed, for a given scene.

      see

      RuntimeScene.getAsyncTasksManager.

      -

Hierarchy

  • AsyncTasksManager

Index

Methods

Constructors

Properties

Methods

addTask

Hierarchy

  • AsyncTasksManager

Index

Methods

Constructors

Properties

Methods

addTask

processTasks

Returns void

processTasks

Constructors

constructor

Properties

Private tasksWithCallback

tasksWithCallback: { asyncTask: AsyncTask; callback: any }[] = ...
+

Parameters

Returns void

Constructors

constructor

Properties

Private tasksWithCallback

tasksWithCallback: { asyncTask: AsyncTask; callback: any }[] = ...

Maps a task to the callback to be executed once it is finished.

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BBTextRuntimeObject

Displays a rich text using BBCode markup (allowing to set parts of the text as bold, italic, use different colors and shadows).

-

Hierarchy

Implements

Index

Methods

Properties

Constructors

Methods

activateBehavior

  • activateBehavior(name: string, enable: boolean): void

Hierarchy

Implements

Index

Methods

Properties

Constructors

Methods

activateBehavior

  • activateBehavior(name: string, enable: boolean): void

addEffect

  • addEffect(effectData: EffectData): boolean

Returns void

addEffect

  • addEffect(effectData: EffectData): boolean

addForce

  • addForce(x: number, y: number, multiplier: number): void

Returns boolean

addForce

  • addForce(x: number, y: number, multiplier: number): void

  • Add a force to the object to move it.

    Parameters

    • x: number

      The x coordinates of the force

      @@ -18,7 +18,7 @@

      The y coordinates of the force

    • multiplier: number

      Set the force multiplier

      -

    Returns void

addForceTowardObject

  • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

Returns void

addForceTowardObject

  • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

addForceTowardPosition

  • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

Returns void

addForceTowardPosition

  • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

addNewBehavior

  • addNewBehavior(behaviorData: BehaviorData): boolean

Returns void

addNewBehavior

  • addNewBehavior(behaviorData: BehaviorData): boolean

  • Create the behavior described by the given BehaviorData

    Parameters

    • behaviorData: BehaviorData

      The data to be used to construct the behavior.

    Returns boolean

    true if the behavior was properly created, false otherwise.

    -

addPolarForce

  • addPolarForce(angle: number, len: number, multiplier: number): void

addPolarForce

  • addPolarForce(angle: number, len: number, multiplier: number): void

averageForceAngleIs

  • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

Returns void

averageForceAngleIs

  • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

Returns boolean

true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

-

behaviorActivated

  • behaviorActivated(name: string): boolean

behaviorActivated

  • behaviorActivated(name: string): boolean

clearEffects

  • clearEffects(): boolean

clearEffects

  • clearEffects(): boolean

clearForces

  • clearForces(): void

clearForces

  • clearForces(): void

Static collisionTest

Static collisionTest

  • Return true if the hitboxes of two objects are overlapping

    static

    Parameters

    • obj1: RuntimeObject

      The first runtimeObject

      @@ -78,69 +78,69 @@
    • ignoreTouchingEdges: boolean

      If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

    Returns boolean

    true if obj1 and obj2 are in collision

    -

cursorOnObject

cursorOnObject

deleteFromScene

deleteFromScene

Static distanceTest

Returns void

Static distanceTest

enableEffect

  • enableEffect(name: string, enable: boolean): void

enableEffect

  • enableEffect(name: string, enable: boolean): void

extraInitializationFromInitialInstance

  • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

Returns void

extraInitializationFromInitialInstance

  • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

get3DRendererObject

  • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

getAABB

get3DRendererObject

  • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

getAABB

  • Get the AABB (axis aligned bounding box) for the object.

    The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

    You should probably redefine updateAABB instead of this function.

    Returns AABB

    The bounding box

    -

getAABBBottom

  • getAABBBottom(): number

getAABBBottom

  • getAABBBottom(): number

getAABBCenterX

  • getAABBCenterX(): number

getAABBCenterX

  • getAABBCenterX(): number

getAABBCenterY

  • getAABBCenterY(): number

getAABBCenterY

  • getAABBCenterY(): number

getAABBLeft

  • getAABBLeft(): number

getAABBLeft

  • getAABBLeft(): number

getAABBRight

  • getAABBRight(): number

getAABBRight

  • getAABBRight(): number

getAABBTop

  • getAABBTop(): number

getAABBTop

  • getAABBTop(): number

getAlignment

  • getAlignment(): string

getAngle

  • getAngle(): number

getAlignment

  • getAlignment(): string

getAngle

  • getAngle(): number

getAngleToObject

getAngleToObject

getAngleToPosition

  • getAngleToPosition(targetX: number, targetY: number): number

Returns number

getAngleToPosition

  • getAngleToPosition(targetX: number, targetY: number): number

getAverageForce

Returns number

getAverageForce

getBBText

  • getBBText(): string

getBBText

  • getBBText(): string

getBehavior

getBehavior

  • Get a behavior from its name. If the behavior does not exists, undefined is returned.

    Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -148,61 +148,61 @@

    Parameters

    • name: string

      The behavior name.

    Returns null | RuntimeBehavior

    The behavior with the given name, or undefined.

    -

getCenterX

  • getCenterX(): number

getCenterX

  • getCenterX(): number

  • Return the X position of the object center, relative to the object X position (getDrawableX). Use getCenterXInScene to get the position of the center in the scene.

    Returns number

    the X position of the object center, relative to getDrawableX().

    -

getCenterXInScene

  • getCenterXInScene(): number

getCenterXInScene

  • getCenterXInScene(): number

getCenterY

  • getCenterY(): number

getCenterY

  • getCenterY(): number

  • Return the Y position of the object center, relative to the object position (getDrawableY). Use getCenterYInScene to get the position of the center in the scene.

    Returns number

    the Y position of the object center, relative to getDrawableY().

    -

getCenterYInScene

  • getCenterYInScene(): number

getCenterYInScene

  • getCenterYInScene(): number

getColor

  • getColor(): string

getColor

  • getColor(): string

getDistanceToObject

getDistanceToObject

getDistanceToPosition

  • getDistanceToPosition(targetX: number, targetY: number): number

Returns number

getDistanceToPosition

  • getDistanceToPosition(targetX: number, targetY: number): number

getDrawableX

  • getDrawableX(): number

Returns number

getDrawableX

  • getDrawableX(): number

  • Get the X position of the rendered object.

    For most objects, this will returns the same value as getX(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableX will differ.

    Returns number

    The X position of the rendered object.

    -

getDrawableY

  • getDrawableY(): number

getDrawableY

  • getDrawableY(): number

  • Get the Y position of the rendered object.

    For most objects, this will returns the same value as getY(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableY will differ.

    Returns number

    The Y position of the rendered object.

    -

getElapsedTime

getElapsedTime

getFontFamily

  • getFontFamily(): string

getFontSize

  • getFontSize(): number

getHeight

  • getHeight(): number

Returns number

getFontFamily

  • getFontFamily(): string

getFontSize

  • getFontSize(): number

getHeight

  • getHeight(): number

getHitBoxes

getHitBoxes

getHitBoxesAround

  • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

getHitBoxesAround

  • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

  • Return at least all the hit boxes that overlap a given area.

    The hit boxes don't need to actually overlap the area, (i.e: it's correct to return more hit boxes than those in the specified area) @@ -227,170 +227,170 @@

  • bottom: number

    bound of the area in scene coordinates

Returns Iterable<Polygon>

at least all the hit boxes that overlap a given area.

-

getInstanceContainer

getInstanceContainer

getLayer

  • getLayer(): string

getLayer

  • getLayer(): string

getName

  • getName(): string

getName

  • getName(): string

getNameId

  • getNameId(): number

getNameId

  • getNameId(): number

Static getNameIdentifier

  • getNameIdentifier(name: string): number

Static getNameIdentifier

  • getNameIdentifier(name: string): number

  • Get the identifier associated to an object name. Some features may want to compare objects name a large number of time. In this case, it may be more efficient to compare objects name identifiers.

    -
    static

    Parameters

    • name: string

    Returns number

getNetworkSyncData

getNetworkSyncData

getOpacity

  • getOpacity(): number

getOpacity

  • getOpacity(): number

getParent

getParent

getRendererEffects

  • getRendererEffects(): Record<string, Filter>

getRendererEffects

  • getRendererEffects(): Record<string, Filter>

getRendererObject

  • getRendererObject(): MultiStyleText

getRuntimeScene

getRendererObject

  • getRendererObject(): MultiStyleText

getRuntimeScene

getSqDistanceToObject

getSqDistanceToObject

getSqDistanceToPosition

  • getSqDistanceToPosition(targetX: number, targetY: number): number

Returns number

getSqDistanceToPosition

  • getSqDistanceToPosition(targetX: number, targetY: number): number

getTimerElapsedTimeInSeconds

  • getTimerElapsedTimeInSeconds(timerName: string): number

Returns number

getTimerElapsedTimeInSeconds

  • getTimerElapsedTimeInSeconds(timerName: string): number

  • Get a timer elapsed time.

    This is used by expressions to return 0 when a timer doesn't exist because numeric expressions must always return a number.

    Parameters

    • timerName: string

      The timer name.

    Returns number

    The timer elapsed time in seconds, 0 if the timer doesn't exist.

    -

getTimerElapsedTimeInSecondsOrNaN

  • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

getTimerElapsedTimeInSecondsOrNaN

  • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

getUniqueId

  • getUniqueId(): number

getUniqueId

  • getUniqueId(): number

  • Get the unique identifier of the object.
    The identifier is set by the runtimeScene owning the object.
    You can also use the id property (this._object.id) for increased efficiency instead of calling this method.

    Returns number

    The object identifier

    -

Static getVariableChildCount

  • getVariableChildCount(variable: Variable): number

Static getVariableChildCount

  • getVariableChildCount(variable: Variable): number

Static getVariableNumber

  • getVariableNumber(variable: Variable): number

Static getVariableNumber

  • getVariableNumber(variable: Variable): number

Static getVariableString

  • getVariableString(variable: Variable): string

Static getVariableString

  • getVariableString(variable: Variable): string

getVariables

getVariables

getVisibilityAABB

  • getVisibilityAABB(): null | AABB

getVisibilityAABB

  • getVisibilityAABB(): null | AABB

  • Get the AABB (axis aligned bounding box) to be used to determine if the object is visible on screen. The gdjs.RuntimeScene will hide the renderer object if the object is not visible on screen ("culling").

    The default implementation uses the AABB returned by getAABB.

    If null is returned, the object is assumed to be always visible.

    Returns null | AABB

    The bounding box or null.

    -

getWidth

  • getWidth(): number

getWidth

  • getWidth(): number

getWordWrap

  • getWordWrap(): boolean

getWrappingWidth

  • getWrappingWidth(): number

getWordWrap

  • getWordWrap(): boolean

getWrappingWidth

  • getWrappingWidth(): number

getX

  • getX(): number

getX

  • getX(): number

getXFromAngleAndDistance

  • getXFromAngleAndDistance(angle: number, distance: number): number

getXFromAngleAndDistance

  • getXFromAngleAndDistance(angle: number, distance: number): number

  • Compute the X position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

    Parameters

    • angle: number

      The angle, in degrees.

    • distance: number

      The distance from the object, in pixels

      -

    Returns number

getY

  • getY(): number

Returns number

getY

  • getY(): number

getYFromAngleAndDistance

  • getYFromAngleAndDistance(angle: number, distance: number): number

getYFromAngleAndDistance

  • getYFromAngleAndDistance(angle: number, distance: number): number

  • Compute the Y position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

    Parameters

    • angle: number

      The angle, in degrees.

    • distance: number

      The distance from the object, in pixels

      -

    Returns number

getZOrder

  • getZOrder(): number

Returns number

getZOrder

  • getZOrder(): number

hasBehavior

  • hasBehavior(name: string): boolean

hasBehavior

  • hasBehavior(name: string): boolean

hasEffect

  • hasEffect(name: string): boolean

Returns boolean

hasEffect

  • hasEffect(name: string): boolean

hasNoForces

  • hasNoForces(): boolean

hasNoForces

  • hasNoForces(): boolean

hasVariable

  • hasVariable(name: string): boolean

hasVariable

  • hasVariable(name: string): boolean

hide

  • hide(enable: boolean): void

hide

  • hide(enable: boolean): void

insideObject

  • insideObject(x: number, y: number): boolean

Returns void

insideObject

  • insideObject(x: number, y: number): boolean

  • Return true if the specified position is inside object bounding box.

    The position should be in "world" coordinates, i.e use gdjs.Layer.convertCoords if you need to pass the mouse or a touch position that you get from gdjs.InputManager. To check if a point is inside the object collision mask, you can use isCollidingWithPoint instead.

    -

    Parameters

    • x: number
    • y: number

    Returns boolean

invalidateHitboxes

  • invalidateHitboxes(): void

invalidateHitboxes

  • invalidateHitboxes(): void

isCollidingWithPoint

  • isCollidingWithPoint(pointX: number, pointY: number): boolean

isCollidingWithPoint

  • isCollidingWithPoint(pointX: number, pointY: number): boolean

isEffectEnabled

  • isEffectEnabled(name: string): boolean

isEffectEnabled

  • isEffectEnabled(name: string): boolean

isHidden

  • isHidden(): boolean

isHidden

  • isHidden(): boolean

isIncludedInParentCollisionMask

  • isIncludedInParentCollisionMask(): boolean

isOnLayer

  • isOnLayer(layer: string): boolean

isIncludedInParentCollisionMask

  • isIncludedInParentCollisionMask(): boolean

isOnLayer

  • isOnLayer(layer: string): boolean

isTotalForceAngleAround

  • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

isTotalForceAngleAround

  • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

  • Return true if the angle of the total force applied on the object is in a given range.

    Parameters

    • angle: number
      @@ -399,43 +399,43 @@

      The maximum distance from the given angle.

    Returns boolean

    true if the difference between the force angle the given angle is less or equals the toleranceInDegrees.

    -

isVisible

  • isVisible(): boolean

isVisible

  • isVisible(): boolean

  • Return true if the object is not hidden.

    Note: This is unrelated to the actual visibility of the object on the screen. For this, see getVisibilityAABB to get the bounding boxes of the object as displayed on the scene.

    Returns boolean

    true if the object is not hidden.

    -

notifyBehaviorsObjectHotReloaded

  • notifyBehaviorsObjectHotReloaded(): void

notifyBehaviorsObjectHotReloaded

  • notifyBehaviorsObjectHotReloaded(): void

onCreated

  • onCreated(): void

onCreated

  • onCreated(): void

  • To be called by the child classes in their constructor, at the very end. Notify the behaviors that they have been constructed (this must be done when the object is ready, otherwise behaviors can do operations on the object which could be not initialized yet).

    If you redefine this function, make sure to call the original method (RuntimeObject.prototype.onCreated.call(this);).

    -

    Returns void

onDeletedFromScene

onDeletedFromScene

onDestroyed

  • onDestroyed(): void

onScenePaused

Returns void

onDestroyed

  • onDestroyed(): void

onScenePaused

onSceneResumed

Returns void

onSceneResumed

pauseTimer

  • pauseTimer(timerName: string): void

Returns void

pauseTimer

  • pauseTimer(timerName: string): void

putAround

  • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

Returns void

putAround

  • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

  • Put the object around a position, with a specific distance and angle. The distance and angle are computed between the position and the center of the object.

    Parameters

    • x: number
      @@ -446,7 +446,7 @@

      The distance between the object and the target, in pixels.

    • angleInDegrees: number

      The angle between the object and the target, in degrees.

      -

    Returns void

putAroundObject

  • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

Returns void

putAroundObject

  • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

  • Put the object around another object, with a specific distance and angle. The distance and angle are computed between the centers of the objects.

    Parameters

    • obj: null | RuntimeObject
      @@ -455,7 +455,7 @@

      The distance between the object and the target

    • angleInDegrees: number

      The angle between the object and the target, in degrees.

      -

    Returns void

raycastTest

  • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

raycastTest

  • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

registerDestroyCallback

  • registerDestroyCallback(callback: () => void): void

reinitialize

  • reinitialize(objectData: ObjectData): void

registerDestroyCallback

  • registerDestroyCallback(callback: () => void): void

reinitialize

  • reinitialize(objectData: ObjectData): void

  • Called to reset the object to its default state. This is used for objects that are "recycled": they are dismissed (at which point onDestroyFromScene is called) but still stored in a cache to be reused next time an object must be created. At this point, @@ -481,7 +481,7 @@

  • The _runtimeScene, _nameId, name and type are guaranteed to stay the same and do not need to be set again.
-

Parameters

Returns void

removeBehavior

removeBehavior

removeEffect

removeEffect

removeTimer

Returns boolean

removeTimer

resetTimer

Returns void

resetTimer

Static returnVariable

Returns void

Static returnVariable

rotate

rotate

rotateTowardAngle

rotateTowardAngle

rotateTowardPosition

separateFromObjects

Returns void

rotateTowardPosition

separateFromObjects

separateFromObjectsList

separateFromObjectsList

separateObjectsWithForces

separateObjectsWithForces

separateObjectsWithoutForces

separateObjectsWithoutForces

setAlignment

setAngle

Returns void

setAlignment

setAngle

setBBText

Returns void

setBBText

setCenterPositionInScene

setCenterPositionInScene

setCenterXInScene

Returns void

setCenterXInScene

setCenterYInScene

Returns void

setCenterYInScene

setColor

setEffectBooleanParameter

setColor

setEffectBooleanParameter

setEffectDoubleParameter

Returns boolean

setEffectDoubleParameter

setEffectStringParameter

Returns boolean

setEffectStringParameter

setFontFamily

setFontSize

setHeight

Returns boolean

setFontFamily

setFontSize

setHeight

setIncludedInParentCollisionMask

setLayer

Returns void

setIncludedInParentCollisionMask

setLayer

setOpacity

Returns void

setOpacity

setPosition

Returns void

setPosition

Static setVariableNumber

Returns void

Static setVariableNumber

Static setVariableString

Returns void

Static setVariableString

setWidth

Returns void

setWidth

setWordWrap

setWrappingWidth

Returns void

setWordWrap

setWrappingWidth

setX

Returns void

setX

setY

Returns void

setY

setZOrder

Returns void

setZOrder

stepBehaviorsPostEvents

Returns void

stepBehaviorsPostEvents

stepBehaviorsPreEvents

stepBehaviorsPreEvents

timerElapsedTime

timerElapsedTime

timerPaused

timerPaused

unpauseTimer

unpauseTimer

unregisterDestroyCallback

update

Returns void

unregisterDestroyCallback

update

updateAABB

Returns void

updateAABB

updateAllEffectParameters

updateAllEffectParameters

updateForces

Returns boolean

updateForces

updateFromNetworkSyncData

updateFromNetworkSyncData

updateFromObjectData

updateFromObjectData

updateHitBoxes

updateHitBoxes

updatePreRender

updatePreRender

updateTimers

Returns void

updateTimers

Properties

angle

angle: number = 0

Static forcesGarbage

forcesGarbage: Force[] = []
+

Returns void

Properties

angle

angle: number = 0

Static forcesGarbage

forcesGarbage: Force[] = []

Global container for unused forces, avoiding recreating forces each tick.

-
static

Static getFirstVariableNumber

getFirstVariableNumber: (array: Variable) => number = ...

Type declaration

Static getFirstVariableNumber

getFirstVariableNumber: (array: Variable) => number = ...

Type declaration

    • Shortcut to get the first value of an array variable as a number.

      -

      Parameters

      Returns number

getFirstVariableNumber

getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

Type declaration

getFirstVariableNumber

getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

Type declaration

    • Shortcut to get the first value of an array variable as a number.

      -

      Parameters

      Returns number

Static getFirstVariableString

getFirstVariableString: (array: Variable) => string = ...

Type declaration

Static getFirstVariableString

getFirstVariableString: (array: Variable) => string = ...

Type declaration

    • Shortcut to get the first value of an array variable as a string.

      -

      Parameters

      Returns string

getFirstVariableString

getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

Type declaration

getFirstVariableString

getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

Type declaration

    • Shortcut to get the first value of an array variable as a string.

      -

      Parameters

      Returns string

Static getLastVariableNumber

getLastVariableNumber: (array: Variable) => number = ...

Type declaration

Static getLastVariableNumber

getLastVariableNumber: (array: Variable) => number = ...

Type declaration

    • Shortcut to get the last value of an array variable as a number.

      -

      Parameters

      Returns number

getLastVariableNumber

getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

Type declaration

getLastVariableNumber

getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

Type declaration

    • Shortcut to get the last value of an array variable as a number.

      -

      Parameters

      Returns number

Static getLastVariableString

getLastVariableString: (array: Variable) => string = ...

Type declaration

Static getLastVariableString

getLastVariableString: (array: Variable) => string = ...

Type declaration

    • Shortcut to get the last value of an array variable as a string.

      -

      Parameters

      Returns string

getLastVariableString

getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

Type declaration

getLastVariableString

getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

Type declaration

    • Shortcut to get the last value of an array variable as a string.

      -

      Parameters

      Returns string

getSqDistanceTo

getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

Type declaration

    • (targetX: number, targetY: number): number
    • +

      Parameters

      Returns string

getSqDistanceTo

getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

Type declaration

    • (targetX: number, targetY: number): number

    • Get the squared distance, in pixels, between the center of this object and a position.

      Parameters

      • targetX: number

        Target X position

      • targetY: number

        Target Y position

        -

      Returns number

getVariableBoolean

getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

Type declaration

    • (variable: Variable, compareWith: boolean): boolean
    • +

    Returns number

getVariableBoolean

getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

Type declaration

    • (variable: Variable, compareWith: boolean): boolean

    • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

      -

      Parameters

      Returns boolean

getVariableChildCount

getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

Type declaration

    • +

      Parameters

      Returns boolean

getVariableChildCount

getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

Type declaration

    • Get the number of children from a variable

      static

      Parameters

      • variable: Variable

        The variable to be accessed

      Returns number

      The number of children

      -

getVariableNumber

getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

Type declaration

getVariableNumber

getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

Type declaration

    • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

      static

      Parameters

      • variable: Variable

        The variable to be accessed

      Returns number

      The value of the specified variable

      -

getVariableString

getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

Type declaration

getVariableString

getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

Type declaration

    • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

      static

      Parameters

      • variable: Variable

        The variable to be accessed

      Returns string

      The string of the specified variable

      -

hidden

hidden: boolean

Readonly id

id: number

layer

layer: string = ''

name

name: string

networkId

networkId: null | string = null
+

hidden

hidden: boolean

Readonly id

id: number

layer

layer: string = ''

name

name: string

networkId

networkId: null | string = null

A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

-

persistentUuid

persistentUuid: null | string = null
+

persistentUuid

persistentUuid: null | string = null

An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

-

pick

pick: boolean = false
+

pick

pick: boolean = false

A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

-

returnVariable

returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

Type declaration

returnVariable

returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

Type declaration

    • Return the variable passed as argument without any change. Only for usage by events.

      static

      Parameters

      • variable: Variable

        The variable to be accessed

      Returns Variable

      The specified variable

      -

setVariableBoolean

setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

Type declaration

    • (variable: Variable, newValue: boolean): void
    • +

setVariableBoolean

setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

Type declaration

    • (variable: Variable, newValue: boolean): void

    • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

      Parameters

      Returns void

setVariableNumber

setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

Type declaration

    • (variable: Variable, newValue: number): void
    • +

    Returns void

setVariableNumber

setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

Type declaration

    • (variable: Variable, newValue: number): void

    • Shortcut to set the value of a variable considered as a number

      Parameters

      • variable: Variable

        The variable to be changed

      • newValue: number

        The value to be set

        -

      Returns void

setVariableString

setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

Type declaration

    • (variable: Variable, newValue: string): void
    • +

    Returns void

setVariableString

setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

Type declaration

    • (variable: Variable, newValue: string): void

    • Shortcut to set the value of a variable considered as a string

      Parameters

      • variable: Variable

        The variable to be changed

      • newValue: string

        The value to be set

        -

      Returns void

Static supportsReinitialization

supportsReinitialization: boolean = false

toggleVariableBoolean

toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

Type declaration

    • +

    Returns void

Static supportsReinitialization

supportsReinitialization: boolean = false

toggleVariableBoolean

toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

Type declaration

    • Toggles a variable. This shortcut function is needed for events code generation.

      see

      {gdjs.evtTools.common.toggleVariableBoolean}

      -

      Parameters

      Returns void

type

type: string

valuePush

valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

Type declaration

    • (array: Variable, value: string | number | boolean): void
    • +

      Parameters

      Returns void

type

type: string

valuePush

valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

Type declaration

    • (array: Variable, value: string | number | boolean): void

    • This shortcut function is needed for events code generation.

      -

      Parameters

      • array: Variable
      • value: string | number | boolean

      Returns void

variableChildExists

variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

Type declaration

    • (variable: Variable, childName: string): boolean
    • static

      Parameters

      • variable: Variable
        +

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

variableChildExists

variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

Type declaration

    • (variable: Variable, childName: string): boolean
    • static

      Parameters

      • variable: Variable

        The variable to be tested

      • childName: string

        The name of the child

        -

      Returns boolean

variableClearChildren

variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

Type declaration

variableClearChildren

variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

Type declaration

    • static

      Parameters

      • variable: Variable

        The variable to be cleared

        -

      Returns void

variablePushCopy

variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

Type declaration

variablePushCopy

variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

Type declaration

    • This shortcut function is needed for events code generation.

      -

      Parameters

      Returns void

variableRemoveAt

variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

Type declaration

variableRemoveAt

variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

Type declaration

    • This shortcut function is needed for events code generation.

      -

      Parameters

      Returns void

variableRemoveChild

variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

Type declaration

    • (variable: Variable, childName: string): void
    • static

      Parameters

variableRemoveChild

variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

Type declaration

    • (variable: Variable, childName: string): void
    • static

      Parameters

      • variable: Variable

        The variable to be changed

      • childName: string

        The name of the child

        -

      Returns void

x

x: number = 0

y

y: number = 0

zOrder

zOrder: number = 0

Protected aabb

aabb: AABB = ...

Protected hitBoxes

hitBoxes: Polygon[]

Protected hitBoxesDirty

hitBoxesDirty: boolean = true

Static Private getVariableBoolean

getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

Type declaration

    • (variable: Variable, compareWith: boolean): boolean
    • +

    Returns void

x

x: number = 0

y

y: number = 0

zOrder

zOrder: number = 0

Protected aabb

aabb: AABB = ...

Protected hitBoxes

hitBoxes: Polygon[]

Protected hitBoxesDirty

hitBoxesDirty: boolean = true

Static Private getVariableBoolean

getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

Type declaration

    • (variable: Variable, compareWith: boolean): boolean

    • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

      -

      Parameters

      Returns boolean

Static Private setVariableBoolean

setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

Type declaration

    • (variable: Variable, newValue: boolean): void
    • +

      Parameters

      Returns boolean

Static Private setVariableBoolean

setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

Type declaration

    • (variable: Variable, newValue: boolean): void

    • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

      Parameters

      Returns void

Static Private toggleVariableBoolean

toggleVariableBoolean: (variable: Variable) => void = ...

Type declaration

    • +

    Returns void

Static Private toggleVariableBoolean

toggleVariableBoolean: (variable: Variable) => void = ...

Type declaration

    • Toggles a variable. This shortcut function is needed for events code generation.

      see

      {gdjs.evtTools.common.toggleVariableBoolean}

      -

      Parameters

      Returns void

Static Private valuePush

valuePush: (array: Variable, value: string | number | boolean) => void = ...

Type declaration

    • (array: Variable, value: string | number | boolean): void
    • +

      Parameters

      Returns void

Static Private valuePush

valuePush: (array: Variable, value: string | number | boolean) => void = ...

Type declaration

    • (array: Variable, value: string | number | boolean): void

    • This shortcut function is needed for events code generation.

      -

      Parameters

      • array: Variable
      • value: string | number | boolean

      Returns void

Static Private variablePushCopy

variablePushCopy: (array: Variable, variable: Variable) => void = ...

Type declaration

Static Private variablePushCopy

variablePushCopy: (array: Variable, variable: Variable) => void = ...

Type declaration

    • This shortcut function is needed for events code generation.

      -

      Parameters

      Returns void

Static Private variableRemoveAt

variableRemoveAt: (array: Variable, index: number) => void = ...

Type declaration

Static Private variableRemoveAt

variableRemoveAt: (array: Variable, index: number) => void = ...

Type declaration

    • This shortcut function is needed for events code generation.

      -

      Parameters

      Returns void

Constructors

constructor

Constructors

constructor

  • Parameters

    • instanceContainer: RuntimeInstanceContainer

      The container the object belongs to.

    • objectData: BBTextObjectData

      The object data used to initialize the object

      diff --git a/GDJS Runtime Documentation/classes/gdjs.BBTextRuntimeObjectPixiRenderer.html b/GDJS Runtime Documentation/classes/gdjs.BBTextRuntimeObjectPixiRenderer.html index c8470aa65..8d93dd0d5 100644 --- a/GDJS Runtime Documentation/classes/gdjs.BBTextRuntimeObjectPixiRenderer.html +++ b/GDJS Runtime Documentation/classes/gdjs.BBTextRuntimeObjectPixiRenderer.html @@ -1,10 +1,10 @@ BBTextRuntimeObjectPixiRenderer | GDevelop JavaScript game engine
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class BBTextRuntimeObjectPixiRenderer

      The PIXI.js renderer for the BBCode Text runtime object.

      -

      Hierarchy

      • BBTextRuntimeObjectPixiRenderer

      Index

      Constructors

      Methods

      Constructors

      constructor

      Hierarchy

      • BBTextRuntimeObjectPixiRenderer

      Index

      Constructors

      Methods

      Constructors

      constructor

      Methods

      destroy

      • destroy(): void

      getHeight

      • getHeight(): number

      getRendererObject

      • getRendererObject(): MultiStyleText

      getWidth

      • getWidth(): number

      updateAlignment

      • updateAlignment(): void

      updateAngle

      • updateAngle(): void

      updateColor

      • updateColor(): void

      updateFontFamily

      • updateFontFamily(): void

      updateFontSize

      • updateFontSize(): void

      updateOpacity

      • updateOpacity(): void

      updatePosition

      • updatePosition(): void

      updateText

      • updateText(): void

      updateWordWrap

      • updateWordWrap(): void

      updateWrappingWidth

      • updateWrappingWidth(): void

      Legend

      • Constructor
      • Method

      Settings

      Theme

      Generated using TypeDoc

      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class Base3DBehavior

      A behavior that forwards the Base3D interface to its object.

      -

      Hierarchy

      Implements

      Index

      Methods

      Constructors

      Properties

      Methods

      activate

      • activate(enable: boolean): void

      Hierarchy

      Implements

      Index

      Methods

      Constructors

      Properties

      Methods

      activate

      • activate(enable: boolean): void

      activated

      • activated(): boolean

      Returns void

activated

  • activated(): boolean

doStepPostEvents

doStepPostEvents

doStepPreEvents

doStepPreEvents

enableSynchronization

  • enableSynchronization(enable: boolean): void

flipZ

  • flipZ(enable: boolean): void

getCenterZInScene

  • getCenterZInScene(): number

enableSynchronization

  • enableSynchronization(enable: boolean): void

flipZ

  • flipZ(enable: boolean): void

getCenterZInScene

  • getCenterZInScene(): number

getDepth

  • getDepth(): number

getDepth

  • getDepth(): number

getName

  • getName(): string

getName

  • getName(): string

getNameId

  • getNameId(): number

getNameId

  • getNameId(): number

getNetworkSyncData

  • getNetworkSyncData(): BehaviorNetworkSyncData

getRotationX

  • getRotationX(): number

getNetworkSyncData

  • getNetworkSyncData(): BehaviorNetworkSyncData

getRotationX

  • getRotationX(): number

getRotationY

  • getRotationY(): number

getRotationY

  • getRotationY(): number

getScaleZ

  • getScaleZ(): number

getScaleZ

  • getScaleZ(): number

getUnrotatedAABBMaxZ

  • getUnrotatedAABBMaxZ(): number

getUnrotatedAABBMaxZ

  • getUnrotatedAABBMaxZ(): number

getUnrotatedAABBMinZ

  • getUnrotatedAABBMinZ(): number

getUnrotatedAABBMinZ

  • getUnrotatedAABBMinZ(): number

getZ

  • getZ(): number

getZ

  • getZ(): number

isFlippedZ

  • isFlippedZ(): boolean

isSyncedOverNetwork

  • isSyncedOverNetwork(): boolean

onActivate

  • onActivate(): void

isFlippedZ

  • isFlippedZ(): boolean

isSyncedOverNetwork

  • isSyncedOverNetwork(): boolean

onActivate

  • onActivate(): void

onCreated

  • onCreated(): void

onCreated

  • onCreated(): void

onDeActivate

  • onDeActivate(): void

onDeActivate

  • onDeActivate(): void

onDestroy

  • onDestroy(): 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

onObjectHotReloaded

  • onObjectHotReloaded(): void

setCenterZInScene

  • setCenterZInScene(z: number): void

setCenterZInScene

  • setCenterZInScene(z: number): void

setDepth

  • setDepth(depth: number): void

setDepth

  • setDepth(depth: number): void

setRotationX

  • setRotationX(angle: number): void

setRotationX

  • setRotationX(angle: number): void

setRotationY

  • setRotationY(angle: number): void

setRotationY

  • setRotationY(angle: number): void

setScaleZ

  • setScaleZ(newScale: number): void

setScaleZ

  • setScaleZ(newScale: number): void

setZ

  • setZ(z: number): void

setZ

  • setZ(z: number): void

stepPostEvents

stepPostEvents

stepPreEvents

Returns void

stepPreEvents

turnAroundX

  • turnAroundX(deltaAngle: number): void

Returns void

turnAroundX

  • turnAroundX(deltaAngle: number): void

turnAroundY

  • turnAroundY(deltaAngle: number): void

turnAroundY

  • turnAroundY(deltaAngle: number): void

turnAroundZ

  • turnAroundZ(deltaAngle: number): void

turnAroundZ

  • turnAroundZ(deltaAngle: number): void

updateFromBehaviorData

  • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

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).

    -

updateFromNetworkSyncData

  • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

updateFromNetworkSyncData

  • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

usesLifecycleFunction

  • usesLifecycleFunction(): boolean

Returns void

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

Constructors

constructor

Properties

name

name: string

owner

owner: RuntimeObject

type

type: string

Private object

object: RuntimeObject & Base3DHandler

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BitmapTextRuntimeObjectPixiRenderer

The PIXI.js renderer for the Bitmap Text runtime object.

-

Hierarchy

  • BitmapTextRuntimeObjectPixiRenderer

Index

Constructors

Methods

Constructors

constructor

Hierarchy

  • BitmapTextRuntimeObjectPixiRenderer

Index

Constructors

Methods

Constructors

constructor

Methods

getFontSize

  • getFontSize(): number

getHeight

  • getHeight(): number

getRendererObject

  • getRendererObject(): BitmapText

getScale

  • getScale(): number

getTint

  • getTint(): string

Returns BitmapTextRuntimeObjectPixiRenderer

Methods

getFontSize

  • getFontSize(): number

getHeight

  • getHeight(): number

getRendererObject

  • getRendererObject(): BitmapText

getScale

  • getScale(): number

getTint

  • getTint(): string

getWidth

  • getWidth(): number

onDestroy

  • onDestroy(): void

updateAlignment

  • updateAlignment(): void

updateAngle

  • updateAngle(): void

updateFont

  • updateFont(): void

updateOpacity

  • updateOpacity(): void

updatePosition

  • updatePosition(): void

updateScale

  • updateScale(): void

updateTextContent

  • updateTextContent(): void

updateTint

  • updateTint(): void

updateWrappingWidth

  • updateWrappingWidth(): void

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Cube3DRuntimeObject

Shows a 3D box object.

-

Hierarchy

Index

Methods

Properties

Constructors

Methods

activateBehavior

  • activateBehavior(name: string, enable: boolean): void

Hierarchy

Index

Methods

Properties

Constructors

Methods

activateBehavior

  • activateBehavior(name: string, enable: boolean): void

addEffect

  • addEffect(effectData: EffectData): boolean

Returns void

addEffect

  • addEffect(effectData: EffectData): boolean

addForce

  • addForce(x: number, y: number, multiplier: number): void

Returns boolean

addForce

  • addForce(x: number, y: number, multiplier: number): void

addForceTowardObject

  • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

Returns void

addForceTowardObject

  • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

addForceTowardPosition

  • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

Returns void

addForceTowardPosition

  • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

addNewBehavior

  • addNewBehavior(behaviorData: BehaviorData): boolean

Returns void

addNewBehavior

  • addNewBehavior(behaviorData: BehaviorData): boolean

addPolarForce

  • addPolarForce(angle: number, len: number, multiplier: number): void

addPolarForce

  • addPolarForce(angle: number, len: number, multiplier: number): void

averageForceAngleIs

  • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

Returns void

averageForceAngleIs

  • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

Returns boolean

true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

-

behaviorActivated

  • behaviorActivated(name: string): boolean

behaviorActivated

  • behaviorActivated(name: string): boolean

clearEffects

  • clearEffects(): boolean

clearEffects

  • clearEffects(): boolean

clearForces

  • clearForces(): void

clearForces

  • clearForces(): void

Static collisionTest

Static collisionTest

  • Return true if the hitboxes of two objects are overlapping

    static

    Parameters

    • obj1: RuntimeObject

      The first runtimeObject

      @@ -78,68 +78,68 @@
    • ignoreTouchingEdges: boolean

      If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

    Returns boolean

    true if obj1 and obj2 are in collision

    -

cursorOnObject

cursorOnObject

deleteFromScene

deleteFromScene

Static distanceTest

Returns void

Static distanceTest

enableEffect

  • enableEffect(name: string, enable: boolean): void

enableEffect

  • enableEffect(name: string, enable: boolean): void

extraInitializationFromInitialInstance

  • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

Returns void

extraInitializationFromInitialInstance

  • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

flipX

  • flipX(enable: boolean): void

flipY

  • flipY(enable: boolean): void

flipZ

  • flipZ(enable: boolean): void

get3DRendererObject

  • get3DRendererObject(): Object3D<Object3DEventMap>

getAABB

flipX

  • flipX(enable: boolean): void

flipY

  • flipY(enable: boolean): void

flipZ

  • flipZ(enable: boolean): void

get3DRendererObject

  • get3DRendererObject(): Object3D<Object3DEventMap>

getAABB

  • Get the AABB (axis aligned bounding box) for the object.

    The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

    You should probably redefine updateAABB instead of this function.

    Returns AABB

    The bounding box

    -

getAABBBottom

  • getAABBBottom(): number

getAABBBottom

  • getAABBBottom(): number

getAABBCenterX

  • getAABBCenterX(): number

getAABBCenterX

  • getAABBCenterX(): number

getAABBCenterY

  • getAABBCenterY(): number

getAABBCenterY

  • getAABBCenterY(): number

getAABBLeft

  • getAABBLeft(): number

getAABBLeft

  • getAABBLeft(): number

getAABBRight

  • getAABBRight(): number

getAABBRight

  • getAABBRight(): number

getAABBTop

  • getAABBTop(): number

getAABBTop

  • getAABBTop(): number

getAngle

  • getAngle(): number

getAngle

  • getAngle(): number

getAngleToObject

getAngleToObject

getAngleToPosition

  • getAngleToPosition(targetX: number, targetY: number): number

Returns number

getAngleToPosition

  • getAngleToPosition(targetX: number, targetY: number): number

getAverageForce

Returns number

getAverageForce

getBackFaceUpThroughWhichAxisRotation

  • getBackFaceUpThroughWhichAxisRotation(): "Y" | "X"

getBehavior

getBackFaceUpThroughWhichAxisRotation

  • getBackFaceUpThroughWhichAxisRotation(): "Y" | "X"

getBehavior

  • Get a behavior from its name. If the behavior does not exists, undefined is returned.

    Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -147,75 +147,75 @@

    Parameters

    • name: string

      The behavior name.

    Returns null | RuntimeBehavior

    The behavior with the given name, or undefined.

    -

getCenterX

  • getCenterX(): number

getCenterX

  • getCenterX(): number

  • Return the X position of the object center, relative to the object X position (getDrawableX). Use getCenterXInScene to get the position of the center in the scene.

    Returns number

    the X position of the object center, relative to getDrawableX().

    -

getCenterXInScene

  • getCenterXInScene(): number

getCenterXInScene

  • getCenterXInScene(): number

getCenterY

  • getCenterY(): number

getCenterY

  • getCenterY(): number

  • Return the Y position of the object center, relative to the object position (getDrawableY). Use getCenterYInScene to get the position of the center in the scene.

    Returns number

    the Y position of the object center, relative to getDrawableY().

    -

getCenterYInScene

  • getCenterYInScene(): number

getCenterYInScene

  • getCenterYInScene(): number

getCenterZ

  • getCenterZ(): number

getCenterZ

  • getCenterZ(): number

  • Return the Z position of the object center, relative to the object Z position (getDrawableX).

    Use getCenterZInScene to get the position of the center in the scene.

    Returns number

    the Z position of the object center, relative to getDrawableZ().

    -

getCenterZInScene

  • getCenterZInScene(): number

getCenterZInScene

  • getCenterZInScene(): number

getDepth

  • getDepth(): number

getDepth

  • getDepth(): number

getDistanceToObject

getDistanceToObject

getDistanceToPosition

  • getDistanceToPosition(targetX: number, targetY: number): number

Returns number

getDistanceToPosition

  • getDistanceToPosition(targetX: number, targetY: number): number

getDrawableX

  • getDrawableX(): number

Returns number

getDrawableX

  • getDrawableX(): number

  • Get the X position of the rendered object.

    For most objects, this will returns the same value as getX(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableX will differ.

    Returns number

    The X position of the rendered object.

    -

getDrawableY

  • getDrawableY(): number

getDrawableY

  • getDrawableY(): number

  • Get the Y position of the rendered object.

    For most objects, this will returns the same value as getY(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableY will differ.

    Returns number

    The Y position of the rendered object.

    -

getDrawableZ

  • getDrawableZ(): number

getDrawableZ

  • getDrawableZ(): number

  • Get the Z position of the rendered object.

    For most objects, this will returns the same value as getZ(). But if the object has an origin that is not the same as the point (0,0,0) of the object displayed, getDrawableZ will differ.

    Returns number

    The Z position of the rendered object.

    -

getElapsedTime

getElapsedTime

getFacesOrientation

  • getFacesOrientation(): "Y" | "Z"

getHeight

  • getHeight(): number

Returns number

getFacesOrientation

  • getFacesOrientation(): "Y" | "Z"

getHeight

  • getHeight(): number

getHitBoxes

getHitBoxes

getHitBoxesAround

  • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

getHitBoxesAround

  • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

  • Return at least all the hit boxes that overlap a given area.

    The hit boxes don't need to actually overlap the area, (i.e: it's correct to return more hit boxes than those in the specified area) @@ -240,191 +240,191 @@

  • bottom: number

    bound of the area in scene coordinates

Returns Iterable<Polygon>

at least all the hit boxes that overlap a given area.

-

getInstanceContainer

getInstanceContainer

getLayer

  • getLayer(): string

getLayer

  • getLayer(): string

getName

  • getName(): string

getName

  • getName(): string

getNameId

  • getNameId(): number

getNameId

  • getNameId(): number

Static getNameIdentifier

  • getNameIdentifier(name: string): number

Static getNameIdentifier

  • getNameIdentifier(name: string): number

  • Get the identifier associated to an object name. Some features may want to compare objects name a large number of time. In this case, it may be more efficient to compare objects name identifiers.

    -
    static

    Parameters

    • name: string

    Returns number

getNetworkSyncData

  • getNetworkSyncData(): Cube3DObjectNetworkSyncData

getNetworkSyncData

  • getNetworkSyncData(): Cube3DObjectNetworkSyncData

getParent

getParent

getRenderer

getRendererEffects

  • getRendererEffects(): Record<string, Filter>

getRenderer

getRendererEffects

  • getRendererEffects(): Record<string, Filter>

getRendererObject

  • getRendererObject(): null

getRotationX

  • getRotationX(): number

getRendererObject

  • getRendererObject(): null

getRotationX

  • getRotationX(): number

getRotationY

  • getRotationY(): number

getRotationY

  • getRotationY(): number

getRuntimeScene

getRuntimeScene

getScale

  • getScale(): number

getScale

  • getScale(): number

  • Get the scale of the object (or the geometric average of X, Y and Z scale in case they are different).

    Returns number

    the scale of the object (or the geometric average of X, Y and Z scale in case they are different).

    -

getScaleX

  • getScaleX(): number

getScaleX

  • getScaleX(): number

getScaleY

  • getScaleY(): number

getScaleY

  • getScaleY(): number

getScaleZ

  • getScaleZ(): number

getScaleZ

  • getScaleZ(): number

getSqDistanceToObject

getSqDistanceToObject

getSqDistanceToPosition

  • getSqDistanceToPosition(targetX: number, targetY: number): number

Returns number

getSqDistanceToPosition

  • getSqDistanceToPosition(targetX: number, targetY: number): number

getTimerElapsedTimeInSeconds

  • getTimerElapsedTimeInSeconds(timerName: string): number

Returns number

getTimerElapsedTimeInSeconds

  • getTimerElapsedTimeInSeconds(timerName: string): number

getTimerElapsedTimeInSecondsOrNaN

  • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

getTimerElapsedTimeInSecondsOrNaN

  • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

getUniqueId

  • getUniqueId(): number

getUniqueId

  • getUniqueId(): number

  • Get the unique identifier of the object.
    The identifier is set by the runtimeScene owning the object.
    You can also use the id property (this._object.id) for increased efficiency instead of calling this method.

    Returns number

    The object identifier

    -

getUnrotatedAABBMaxZ

  • getUnrotatedAABBMaxZ(): number

getUnrotatedAABBMaxZ

  • getUnrotatedAABBMaxZ(): number

getUnrotatedAABBMinZ

  • getUnrotatedAABBMinZ(): number

getUnrotatedAABBMinZ

  • getUnrotatedAABBMinZ(): number

Static getVariableChildCount

  • getVariableChildCount(variable: Variable): number

Static getVariableChildCount

  • getVariableChildCount(variable: Variable): number

Static getVariableNumber

  • getVariableNumber(variable: Variable): number

Static getVariableNumber

  • getVariableNumber(variable: Variable): number

Static getVariableString

  • getVariableString(variable: Variable): string

Static getVariableString

  • getVariableString(variable: Variable): string

getVariables

getVariables

getVisibilityAABB

  • getVisibilityAABB(): null | AABB

getVisibilityAABB

  • getVisibilityAABB(): null | AABB

  • Get the AABB (axis aligned bounding box) to be used to determine if the object is visible on screen. The gdjs.RuntimeScene will hide the renderer object if the object is not visible on screen ("culling").

    The default implementation uses the AABB returned by getAABB.

    If null is returned, the object is assumed to be always visible.

    Returns null | AABB

    The bounding box or null.

    -

getWidth

  • getWidth(): number

getWidth

  • getWidth(): number

getX

  • getX(): number

getX

  • getX(): number

getXFromAngleAndDistance

  • getXFromAngleAndDistance(angle: number, distance: number): number

getXFromAngleAndDistance

  • getXFromAngleAndDistance(angle: number, distance: number): number

  • Compute the X position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

    Parameters

    • angle: number

      The angle, in degrees.

    • distance: number

      The distance from the object, in pixels

      -

    Returns number

getY

  • getY(): number

Returns number

getY

  • getY(): number

getYFromAngleAndDistance

  • getYFromAngleAndDistance(angle: number, distance: number): number

getYFromAngleAndDistance

  • getYFromAngleAndDistance(angle: number, distance: number): number

  • Compute the Y position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

    Parameters

    • angle: number

      The angle, in degrees.

    • distance: number

      The distance from the object, in pixels

      -

    Returns number

getZ

  • getZ(): number

Returns number

getZ

  • getZ(): number

getZOrder

  • getZOrder(): number

getZOrder

  • getZOrder(): number

hasBehavior

  • hasBehavior(name: string): boolean

hasBehavior

  • hasBehavior(name: string): boolean

hasEffect

  • hasEffect(name: string): boolean

Returns boolean

hasEffect

  • hasEffect(name: string): boolean

hasNoForces

  • hasNoForces(): boolean

hasNoForces

  • hasNoForces(): boolean

hasVariable

  • hasVariable(name: string): boolean

hasVariable

  • hasVariable(name: string): boolean

hide

  • hide(enable: boolean): void

hide

  • hide(enable: boolean): void

insideObject

  • insideObject(x: number, y: number): boolean

insideObject

  • insideObject(x: number, y: number): boolean

  • Return true if the specified position is inside object bounding box.

    The position should be in "world" coordinates, i.e use gdjs.Layer.convertCoords if you need to pass the mouse or a touch position that you get from gdjs.InputManager. To check if a point is inside the object collision mask, you can use isCollidingWithPoint instead.

    -

    Parameters

    • x: number
    • y: number

    Returns boolean

invalidateHitboxes

  • invalidateHitboxes(): void

invalidateHitboxes

  • invalidateHitboxes(): void

isCollidingWithPoint

  • isCollidingWithPoint(pointX: number, pointY: number): boolean

isCollidingWithPoint

  • isCollidingWithPoint(pointX: number, pointY: number): boolean

isEffectEnabled

  • isEffectEnabled(name: string): boolean

isEffectEnabled

  • isEffectEnabled(name: string): boolean

isFaceVisible

  • isFaceVisible(faceName: FaceName): boolean

isFlippedX

  • isFlippedX(): boolean

isFlippedY

  • isFlippedY(): boolean

isFlippedZ

  • isFlippedZ(): boolean

isHidden

  • isHidden(): boolean

isFaceVisible

  • isFaceVisible(faceName: FaceName): boolean

isFlippedX

  • isFlippedX(): boolean

isFlippedY

  • isFlippedY(): boolean

isFlippedZ

  • isFlippedZ(): boolean

isHidden

  • isHidden(): boolean

isIncludedInParentCollisionMask

  • isIncludedInParentCollisionMask(): boolean

isOnLayer

  • isOnLayer(layer: string): boolean

isIncludedInParentCollisionMask

  • isIncludedInParentCollisionMask(): boolean

isOnLayer

  • isOnLayer(layer: string): boolean

isTotalForceAngleAround

  • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

isTotalForceAngleAround

  • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

  • Return true if the angle of the total force applied on the object is in a given range.

    Parameters

    • angle: number
      @@ -433,43 +433,43 @@

      The maximum distance from the given angle.

    Returns boolean

    true if the difference between the force angle the given angle is less or equals the toleranceInDegrees.

    -

isVisible

  • isVisible(): boolean

isVisible

  • isVisible(): boolean

  • Return true if the object is not hidden.

    Note: This is unrelated to the actual visibility of the object on the screen. For this, see getVisibilityAABB to get the bounding boxes of the object as displayed on the scene.

    Returns boolean

    true if the object is not hidden.

    -

notifyBehaviorsObjectHotReloaded

  • notifyBehaviorsObjectHotReloaded(): void

notifyBehaviorsObjectHotReloaded

  • notifyBehaviorsObjectHotReloaded(): void

onCreated

  • onCreated(): void

onCreated

  • onCreated(): void

  • To be called by the child classes in their constructor, at the very end. Notify the behaviors that they have been constructed (this must be done when the object is ready, otherwise behaviors can do operations on the object which could be not initialized yet).

    If you redefine this function, make sure to call the original method (RuntimeObject.prototype.onCreated.call(this);).

    -

    Returns void

onDeletedFromScene

onDeletedFromScene

onDestroyed

  • onDestroyed(): void

onScenePaused

Returns void

onDestroyed

  • onDestroyed(): void

onScenePaused

onSceneResumed

Returns void

onSceneResumed

pauseTimer

  • pauseTimer(timerName: string): void

Returns void

pauseTimer

  • pauseTimer(timerName: string): void

putAround

  • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

Returns void

putAround

  • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

  • Put the object around a position, with a specific distance and angle. The distance and angle are computed between the position and the center of the object.

    Parameters

    • x: number
      @@ -480,7 +480,7 @@

      The distance between the object and the target, in pixels.

    • angleInDegrees: number

      The angle between the object and the target, in degrees.

      -

    Returns void

putAroundObject

  • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

Returns void

putAroundObject

  • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

  • Put the object around another object, with a specific distance and angle. The distance and angle are computed between the centers of the objects.

    Parameters

    • obj: null | RuntimeObject
      @@ -489,7 +489,7 @@

      The distance between the object and the target

    • angleInDegrees: number

      The angle between the object and the target, in degrees.

      -

    Returns void

raycastTest

  • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

raycastTest

  • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

registerDestroyCallback

  • registerDestroyCallback(callback: () => void): void

reinitialize

  • reinitialize(objectData: ObjectData): void

registerDestroyCallback

  • registerDestroyCallback(callback: () => void): void

reinitialize

  • reinitialize(objectData: ObjectData): void

  • Called to reset the object to its default state. This is used for objects that are "recycled": they are dismissed (at which point onDestroyFromScene is called) but still stored in a cache to be reused next time an object must be created. At this point, @@ -515,7 +515,7 @@

  • The _runtimeScene, _nameId, name and type are guaranteed to stay the same and do not need to be set again.
-

Parameters

Returns void

removeBehavior

removeBehavior

removeEffect

removeEffect

removeTimer

Returns boolean

removeTimer

resetTimer

Returns void

resetTimer

Static returnVariable

Returns void

Static returnVariable

rotate

rotate

rotateTowardAngle

rotateTowardAngle

rotateTowardPosition

separateFromObjects

Returns void

rotateTowardPosition

separateFromObjects

separateFromObjectsList

separateFromObjectsList

separateObjectsWithForces

separateObjectsWithForces

separateObjectsWithoutForces

separateObjectsWithoutForces

setAngle

Returns void

setAngle

setBackFaceUpThroughWhichAxisRotation

setCenterPositionInScene

setBackFaceUpThroughWhichAxisRotation

setCenterPositionInScene

setCenterXInScene

Returns void

setCenterXInScene

setCenterYInScene

Returns void

setCenterYInScene

setCenterZInScene

setCenterZInScene

setDepth

setDepth

setEffectBooleanParameter

setEffectBooleanParameter

setEffectDoubleParameter

Returns boolean

setEffectDoubleParameter

setEffectStringParameter

Returns boolean

setEffectStringParameter

setFaceResourceName

setFaceVisibility

Returns boolean

setFaceResourceName

setFaceVisibility

setFacesOrientation

setHeight

Returns void

setFacesOrientation

setHeight

setIncludedInParentCollisionMask

setLayer

setIncludedInParentCollisionMask

setLayer

setMaterialType

setPosition

Returns void

setMaterialType

setPosition

setRepeatTextureOnFace

Returns void

setRepeatTextureOnFace

setRotationX

Returns void

setRotationX

setRotationY

setRotationY

setScale

setScale

setScaleX

Returns void

setScaleX

setScaleY

Returns void

setScaleY

setScaleZ

Returns void

setScaleZ

setSize

Returns void

setSize

Static setVariableNumber

Static setVariableNumber

Static setVariableString

Returns void

Static setVariableString

setWidth

Returns void

setWidth

setX

setX

setY

setY

setZ

setZ

setZOrder

setZOrder

shouldUseTransparentTexture

Returns void

shouldUseTransparentTexture

stepBehaviorsPostEvents

stepBehaviorsPostEvents

stepBehaviorsPreEvents

stepBehaviorsPreEvents

timerElapsedTime

timerElapsedTime

timerPaused

timerPaused

turnAroundX

turnAroundX

turnAroundY

Returns void

turnAroundY

turnAroundZ

Returns void

turnAroundZ

unpauseTimer

Returns void

unpauseTimer

unregisterDestroyCallback

update

Returns void

unregisterDestroyCallback

update

updateAABB

Returns void

updateAABB

updateAllEffectParameters

updateAllEffectParameters

updateForces

Returns boolean

updateForces

updateFromNetworkSyncData

updateFromNetworkSyncData

updateFromObjectData

updateFromObjectData

updateHitBoxes

updateHitBoxes

updatePreRender

updatePreRender

updateTimers

Returns void

updateTimers

Properties

angle

angle: number = 0

Static forcesGarbage

forcesGarbage: Force[] = []
+

Returns void

Properties

angle

angle: number = 0

Static forcesGarbage

forcesGarbage: Force[] = []

Global container for unused forces, avoiding recreating forces each tick.

-
static

Static getFirstVariableNumber

getFirstVariableNumber: (array: Variable) => number = ...

Type declaration

Static getFirstVariableNumber

getFirstVariableNumber: (array: Variable) => number = ...

Type declaration

    • Shortcut to get the first value of an array variable as a number.

      -

      Parameters

      Returns number

getFirstVariableNumber

getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

Type declaration

getFirstVariableNumber

getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

Type declaration

    • Shortcut to get the first value of an array variable as a number.

      -

      Parameters

      Returns number

Static getFirstVariableString

getFirstVariableString: (array: Variable) => string = ...

Type declaration

Static getFirstVariableString

getFirstVariableString: (array: Variable) => string = ...

Type declaration

    • Shortcut to get the first value of an array variable as a string.

      -

      Parameters

      Returns string

getFirstVariableString

getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

Type declaration

getFirstVariableString

getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

Type declaration

    • Shortcut to get the first value of an array variable as a string.

      -

      Parameters

      Returns string

Static getLastVariableNumber

getLastVariableNumber: (array: Variable) => number = ...

Type declaration

Static getLastVariableNumber

getLastVariableNumber: (array: Variable) => number = ...

Type declaration

    • Shortcut to get the last value of an array variable as a number.

      -

      Parameters

      Returns number

getLastVariableNumber

getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

Type declaration

getLastVariableNumber

getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

Type declaration

    • Shortcut to get the last value of an array variable as a number.

      -

      Parameters

      Returns number

Static getLastVariableString

getLastVariableString: (array: Variable) => string = ...

Type declaration

Static getLastVariableString

getLastVariableString: (array: Variable) => string = ...

Type declaration

    • Shortcut to get the last value of an array variable as a string.

      -

      Parameters

      Returns string

getLastVariableString

getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

Type declaration

getLastVariableString

getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

Type declaration

    • Shortcut to get the last value of an array variable as a string.

      -

      Parameters

      Returns string

getSqDistanceTo

getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

Type declaration

    • (targetX: number, targetY: number): number
    • +

      Parameters

      Returns string

getSqDistanceTo

getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

Type declaration

    • (targetX: number, targetY: number): number

    • Get the squared distance, in pixels, between the center of this object and a position.

      Parameters

      • targetX: number

        Target X position

      • targetY: number

        Target Y position

        -

      Returns number

getVariableBoolean

getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

Type declaration

    • (variable: Variable, compareWith: boolean): boolean
    • +

    Returns number

getVariableBoolean

getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

Type declaration

    • (variable: Variable, compareWith: boolean): boolean

    • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

      -

      Parameters

      Returns boolean

getVariableChildCount

getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

Type declaration

    • +

      Parameters

      Returns boolean

getVariableChildCount

getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

Type declaration

    • Get the number of children from a variable

      static

      Parameters

      • variable: Variable

        The variable to be accessed

      Returns number

      The number of children

      -

getVariableNumber

getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

Type declaration

getVariableNumber

getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

Type declaration

    • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

      static

      Parameters

      • variable: Variable

        The variable to be accessed

      Returns number

      The value of the specified variable

      -

getVariableString

getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

Type declaration

getVariableString

getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

Type declaration

    • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

      static

      Parameters

      • variable: Variable

        The variable to be accessed

      Returns string

      The string of the specified variable

      -

hidden

hidden: boolean = false

Readonly id

id: number

layer

layer: string = ''

name

name: string

networkId

networkId: null | string = null
+

hidden

hidden: boolean = false

Readonly id

id: number

layer

layer: string = ''

name

name: string

networkId

networkId: null | string = null

A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

-

persistentUuid

persistentUuid: null | string = null
+

persistentUuid

persistentUuid: null | string = null

An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

-

pick

pick: boolean = false
+

pick

pick: boolean = false

A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

-

returnVariable

returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

Type declaration

returnVariable

returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

Type declaration

    • Return the variable passed as argument without any change. Only for usage by events.

      static

      Parameters

      • variable: Variable

        The variable to be accessed

      Returns Variable

      The specified variable

      -

setVariableBoolean

setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

Type declaration

    • (variable: Variable, newValue: boolean): void
    • +

setVariableBoolean

setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

Type declaration

    • (variable: Variable, newValue: boolean): void

    • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

      Parameters

      Returns void

setVariableNumber

setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

Type declaration

    • (variable: Variable, newValue: number): void
    • +

    Returns void

setVariableNumber

setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

Type declaration

    • (variable: Variable, newValue: number): void

    • Shortcut to set the value of a variable considered as a number

      Parameters

      • variable: Variable

        The variable to be changed

      • newValue: number

        The value to be set

        -

      Returns void

setVariableString

setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

Type declaration

    • (variable: Variable, newValue: string): void
    • +

    Returns void

setVariableString

setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

Type declaration

    • (variable: Variable, newValue: string): void

    • Shortcut to set the value of a variable considered as a string

      Parameters

      • variable: Variable

        The variable to be changed

      • newValue: string

        The value to be set

        -

      Returns void

Static supportsReinitialization

supportsReinitialization: boolean = false

toggleVariableBoolean

toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

Type declaration

    • +

    Returns void

Static supportsReinitialization

supportsReinitialization: boolean = false

toggleVariableBoolean

toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

Type declaration

    • Toggles a variable. This shortcut function is needed for events code generation.

      see

      {gdjs.evtTools.common.toggleVariableBoolean}

      -

      Parameters

      Returns void

type

type: string

valuePush

valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

Type declaration

    • (array: Variable, value: string | number | boolean): void
    • +

      Parameters

      Returns void

type

type: string

valuePush

valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

Type declaration

    • (array: Variable, value: string | number | boolean): void

    • This shortcut function is needed for events code generation.

      -

      Parameters

      • array: Variable
      • value: string | number | boolean

      Returns void

variableChildExists

variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

Type declaration

    • (variable: Variable, childName: string): boolean
    • static

      Parameters

      • variable: Variable
        +

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

variableChildExists

variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

Type declaration

    • (variable: Variable, childName: string): boolean
    • static

      Parameters

      • variable: Variable

        The variable to be tested

      • childName: string

        The name of the child

        -

      Returns boolean

variableClearChildren

variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

Type declaration

variableClearChildren

variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

Type declaration

    • static

      Parameters

      • variable: Variable

        The variable to be cleared

        -

      Returns void

variablePushCopy

variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

Type declaration

variablePushCopy

variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

Type declaration

    • This shortcut function is needed for events code generation.

      -

      Parameters

      Returns void

variableRemoveAt

variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

Type declaration

variableRemoveAt

variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

Type declaration

    • This shortcut function is needed for events code generation.

      -

      Parameters

      Returns void

variableRemoveChild

variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

Type declaration

    • (variable: Variable, childName: string): void
    • static

      Parameters

variableRemoveChild

variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

Type declaration

    • (variable: Variable, childName: string): void
    • static

      Parameters

      • variable: Variable

        The variable to be changed

      • childName: string

        The name of the child

        -

      Returns void

x

x: number = 0

y

y: number = 0

zOrder

zOrder: number = 0

Protected aabb

aabb: AABB = ...

Protected hitBoxes

hitBoxes: Polygon[]

Protected hitBoxesDirty

hitBoxesDirty: boolean = true

Static Private getVariableBoolean

getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

Type declaration

    • (variable: Variable, compareWith: boolean): boolean
    • +

    Returns void

x

x: number = 0

y

y: number = 0

zOrder

zOrder: number = 0

Protected aabb

aabb: AABB = ...

Protected hitBoxes

hitBoxes: Polygon[]

Protected hitBoxesDirty

hitBoxesDirty: boolean = true

Static Private getVariableBoolean

getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

Type declaration

    • (variable: Variable, compareWith: boolean): boolean

    • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

      -

      Parameters

      Returns boolean

Static Private setVariableBoolean

setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

Type declaration

    • (variable: Variable, newValue: boolean): void
    • +

      Parameters

      Returns boolean

Static Private setVariableBoolean

setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

Type declaration

    • (variable: Variable, newValue: boolean): void

    • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

      Parameters

      Returns void

Static Private toggleVariableBoolean

toggleVariableBoolean: (variable: Variable) => void = ...

Type declaration

    • +

    Returns void

Static Private toggleVariableBoolean

toggleVariableBoolean: (variable: Variable) => void = ...

Type declaration

    • Toggles a variable. This shortcut function is needed for events code generation.

      see

      {gdjs.evtTools.common.toggleVariableBoolean}

      -

      Parameters

      Returns void

Static Private valuePush

valuePush: (array: Variable, value: string | number | boolean) => void = ...

Type declaration

    • (array: Variable, value: string | number | boolean): void
    • +

      Parameters

      Returns void

Static Private valuePush

valuePush: (array: Variable, value: string | number | boolean) => void = ...

Type declaration

    • (array: Variable, value: string | number | boolean): void

    • This shortcut function is needed for events code generation.

      -

      Parameters

      • array: Variable
      • value: string | number | boolean

      Returns void

Static Private variablePushCopy

variablePushCopy: (array: Variable, variable: Variable) => void = ...

Type declaration

Static Private variablePushCopy

variablePushCopy: (array: Variable, variable: Variable) => void = ...

Type declaration

    • This shortcut function is needed for events code generation.

      -

      Parameters

      Returns void

Static Private variableRemoveAt

variableRemoveAt: (array: Variable, index: number) => void = ...

Type declaration

Static Private variableRemoveAt

variableRemoveAt: (array: Variable, index: number) => void = ...

Type declaration

    • This shortcut function is needed for events code generation.

      -

      Parameters

      Returns void

Constructors

constructor

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomRuntimeObject2D

Base class for 2D custom objects.

-

Hierarchy

Index

Methods

Properties

Constructors

Methods

activateBehavior

  • activateBehavior(name: string, enable: boolean): void

Hierarchy

Index

Methods

Properties

Constructors

Methods

activateBehavior

  • activateBehavior(name: string, enable: boolean): void

addEffect

  • addEffect(effectData: EffectData): boolean

Returns void

addEffect

  • addEffect(effectData: EffectData): boolean

addForce

  • addForce(x: number, y: number, multiplier: number): void

Returns boolean

addForce

  • addForce(x: number, y: number, multiplier: number): void

addForceTowardObject

  • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

Returns void

addForceTowardObject

  • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

addForceTowardPosition

  • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

Returns void

addForceTowardPosition

  • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

addNewBehavior

  • addNewBehavior(behaviorData: BehaviorData): boolean

Returns void

addNewBehavior

  • addNewBehavior(behaviorData: BehaviorData): boolean

addPolarForce

  • addPolarForce(angle: number, len: number, multiplier: number): void

addPolarForce

  • addPolarForce(angle: number, len: number, multiplier: number): void

applyObjectInverseTransformation

  • applyObjectInverseTransformation(x: number, y: number, destination: FloatPoint): void

Returns void

applyObjectInverseTransformation

  • applyObjectInverseTransformation(x: number, y: number, destination: FloatPoint): void

  • Return an array containing the coordinates of the point passed as parameter in object local coordinates (as opposed to the parent coordinate coordinates).

    All transformations (flipping, scale, rotation) are supported.

    @@ -58,7 +58,7 @@

    The X position of the point, in parent coordinates.

  • y: number

    The Y position of the point, in parent coordinates.

    -
  • destination: FloatPoint

Returns void

applyObjectTransformation

  • applyObjectTransformation(x: number, y: number, destination: FloatPoint): void

Returns void

applyObjectTransformation

  • applyObjectTransformation(x: number, y: number, destination: FloatPoint): void

  • Return an array containing the coordinates of the point passed as parameter in parent coordinate coordinates (as opposed to the object local coordinates).

    All transformations (flipping, scale, rotation) are supported.

    @@ -66,7 +66,7 @@

    The X position of the point, in object coordinates.

  • y: number

    The Y position of the point, in object coordinates.

    -
  • destination: FloatPoint

Returns void

averageForceAngleIs

  • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

Returns void

averageForceAngleIs

  • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

Returns boolean

true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

-

behaviorActivated

  • behaviorActivated(name: string): boolean

behaviorActivated

  • behaviorActivated(name: string): boolean

clearEffects

  • clearEffects(): boolean

clearEffects

  • clearEffects(): boolean

clearForces

  • clearForces(): void

clearForces

  • clearForces(): void

Static collisionTest

Static collisionTest

  • Return true if the hitboxes of two objects are overlapping

    static

    Parameters

    • obj1: RuntimeObject

      The first runtimeObject

      @@ -94,75 +94,75 @@
    • ignoreTouchingEdges: boolean

      If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

    Returns boolean

    true if obj1 and obj2 are in collision

    -

cursorOnObject

cursorOnObject

deleteFromScene

deleteFromScene

Static distanceTest

Returns void

Static distanceTest

doStepPostEvents

doStepPostEvents

doStepPreEvents

enableEffect

  • enableEffect(name: string, enable: boolean): void

Returns void

doStepPreEvents

enableEffect

  • enableEffect(name: string, enable: boolean): void

extraInitializationFromInitialInstance

  • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

Returns void

extraInitializationFromInitialInstance

  • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

flipX

  • flipX(enable: boolean): void

flipY

  • flipY(enable: boolean): void

get3DRendererObject

  • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

getAABB

flipX

  • flipX(enable: boolean): void

flipY

  • flipY(enable: boolean): void

get3DRendererObject

  • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

getAABB

  • Get the AABB (axis aligned bounding box) for the object.

    The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

    You should probably redefine updateAABB instead of this function.

    Returns AABB

    The bounding box

    -

getAABBBottom

  • getAABBBottom(): number

getAABBBottom

  • getAABBBottom(): number

getAABBCenterX

  • getAABBCenterX(): number

getAABBCenterX

  • getAABBCenterX(): number

getAABBCenterY

  • getAABBCenterY(): number

getAABBCenterY

  • getAABBCenterY(): number

getAABBLeft

  • getAABBLeft(): number

getAABBLeft

  • getAABBLeft(): number

getAABBRight

  • getAABBRight(): number

getAABBRight

  • getAABBRight(): number

getAABBTop

  • getAABBTop(): number

getAABBTop

  • getAABBTop(): number

getAngle

  • getAngle(): number

getAngle

  • getAngle(): number

getAngleToObject

getAngleToObject

getAngleToPosition

  • getAngleToPosition(targetX: number, targetY: number): number

Returns number

getAngleToPosition

  • getAngleToPosition(targetX: number, targetY: number): number

getAnimator

Returns number

getAnimator

getAverageForce

getAverageForce

getBehavior

getBehavior

  • Get a behavior from its name. If the behavior does not exists, undefined is returned.

    Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -170,59 +170,59 @@

    Parameters

    • name: string

      The behavior name.

    Returns null | RuntimeBehavior

    The behavior with the given name, or undefined.

    -

getCenterX

  • getCenterX(): number

getCenterX

  • getCenterX(): number

  • Return the X position of the object center, relative to the object X position (getDrawableX). Use getCenterXInScene to get the position of the center in the scene.

    Returns number

    the X position of the object center, relative to getDrawableX().

    -

getCenterXInScene

  • getCenterXInScene(): number

getCenterXInScene

  • getCenterXInScene(): number

getCenterY

  • getCenterY(): number

getCenterY

  • getCenterY(): number

getCenterYInScene

  • getCenterYInScene(): number

getCenterYInScene

  • getCenterYInScene(): number

getDistanceToObject

getDistanceToObject

getDistanceToPosition

  • getDistanceToPosition(targetX: number, targetY: number): number

Returns number

getDistanceToPosition

  • getDistanceToPosition(targetX: number, targetY: number): number

getDrawableX

  • getDrawableX(): number

Returns number

getDrawableX

  • getDrawableX(): number

  • Get the X position of the rendered object.

    For most objects, this will returns the same value as getX(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableX will differ.

    Returns number

    The X position of the rendered object.

    -

getDrawableY

  • getDrawableY(): number

getDrawableY

  • getDrawableY(): number

  • Get the Y position of the rendered object.

    For most objects, this will returns the same value as getY(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableY will differ.

    Returns number

    The Y position of the rendered object.

    -

getElapsedTime

getElapsedTime

getHeight

  • getHeight(): number

Returns number

getHeight

  • getHeight(): number

getHitBoxes

getHitBoxes

getHitBoxesAround

  • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

getHitBoxesAround

  • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

  • Return at least all the hit boxes that overlap a given area.

    The hit boxes don't need to actually overlap the area, (i.e: it's correct to return more hit boxes than those in the specified area) @@ -247,191 +247,191 @@

  • bottom: number

    bound of the area in scene coordinates

Returns Iterable<Polygon>

at least all the hit boxes that overlap a given area.

-

getInstanceContainer

getInstanceContainer

getLayer

  • getLayer(): string

getLayer

  • getLayer(): string

getLocalInverseTransformation

getLocalTransformation

getLocalInverseTransformation

getLocalTransformation

getName

  • getName(): string

getName

  • getName(): string

getNameId

  • getNameId(): number

getNameId

  • getNameId(): number

Static getNameIdentifier

  • getNameIdentifier(name: string): number

Static getNameIdentifier

  • getNameIdentifier(name: string): number

getNetworkSyncData

  • getNetworkSyncData(): ObjectNetworkSyncData

getNetworkSyncData

  • getNetworkSyncData(): ObjectNetworkSyncData

getOpacity

  • getOpacity(): number

getOpacity

  • getOpacity(): number

getParent

getParent

getRenderer

getRendererEffects

  • getRendererEffects(): Record<string, Filter>

getRenderer

getRendererEffects

  • getRendererEffects(): Record<string, Filter>

getRendererObject

  • getRendererObject(): Container<DisplayObject>

getRuntimeScene

getRendererObject

  • getRendererObject(): Container<DisplayObject>

getRuntimeScene

getScale

  • getScale(): number

getScale

  • getScale(): number

getScaleMean

  • getScaleMean(): number

getScaleMean

  • getScaleMean(): number

getScaleX

  • getScaleX(): number

getScaleX

  • getScaleX(): number

getScaleY

  • getScaleY(): number

getScaleY

  • getScaleY(): number

getSqDistanceToObject

getSqDistanceToObject

getSqDistanceToPosition

  • getSqDistanceToPosition(targetX: number, targetY: number): number

Returns number

getSqDistanceToPosition

  • getSqDistanceToPosition(targetX: number, targetY: number): number

getTimerElapsedTimeInSeconds

  • getTimerElapsedTimeInSeconds(timerName: string): number

Returns number

getTimerElapsedTimeInSeconds

  • getTimerElapsedTimeInSeconds(timerName: string): number

getTimerElapsedTimeInSecondsOrNaN

  • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

getTimerElapsedTimeInSecondsOrNaN

  • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

getUniqueId

  • getUniqueId(): number

getUniqueId

  • getUniqueId(): number

  • Get the unique identifier of the object.
    The identifier is set by the runtimeScene owning the object.
    You can also use the id property (this._object.id) for increased efficiency instead of calling this method.

    Returns number

    The object identifier

    -

getUnscaledCenterX

  • getUnscaledCenterX(): number

getUnscaledCenterY

  • getUnscaledCenterY(): number

getUnscaledHeight

  • getUnscaledHeight(): number

getUnscaledWidth

  • getUnscaledWidth(): number

Static getVariableChildCount

  • getVariableChildCount(variable: Variable): number

getUnscaledCenterX

  • getUnscaledCenterX(): number

getUnscaledCenterY

  • getUnscaledCenterY(): number

getUnscaledHeight

  • getUnscaledHeight(): number

getUnscaledWidth

  • getUnscaledWidth(): number

Static getVariableChildCount

  • getVariableChildCount(variable: Variable): number

Static getVariableNumber

  • getVariableNumber(variable: Variable): number

Static getVariableNumber

  • getVariableNumber(variable: Variable): number

Static getVariableString

  • getVariableString(variable: Variable): string

Static getVariableString

  • getVariableString(variable: Variable): string

getVariables

getVariables

getVisibilityAABB

  • getVisibilityAABB(): null | AABB

getVisibilityAABB

  • getVisibilityAABB(): null | AABB

  • Get the AABB (axis aligned bounding box) to be used to determine if the object is visible on screen. The gdjs.RuntimeScene will hide the renderer object if the object is not visible on screen ("culling").

    The default implementation uses the AABB returned by getAABB.

    If null is returned, the object is assumed to be always visible.

    Returns null | AABB

    The bounding box or null.

    -

getWidth

  • getWidth(): number

getWidth

  • getWidth(): number

getX

  • getX(): number

getX

  • getX(): number

getXFromAngleAndDistance

  • getXFromAngleAndDistance(angle: number, distance: number): number

getXFromAngleAndDistance

  • getXFromAngleAndDistance(angle: number, distance: number): number

  • Compute the X position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

    Parameters

    • angle: number

      The angle, in degrees.

    • distance: number

      The distance from the object, in pixels

      -

    Returns number

getY

  • getY(): number

Returns number

getY

  • getY(): number

getYFromAngleAndDistance

  • getYFromAngleAndDistance(angle: number, distance: number): number

getYFromAngleAndDistance

  • getYFromAngleAndDistance(angle: number, distance: number): number

  • Compute the Y position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

    Parameters

    • angle: number

      The angle, in degrees.

    • distance: number

      The distance from the object, in pixels

      -

    Returns number

getZOrder

  • getZOrder(): number

Returns number

getZOrder

  • getZOrder(): number

hasBehavior

  • hasBehavior(name: string): boolean

hasBehavior

  • hasBehavior(name: string): boolean

hasCustomRotationCenter

  • hasCustomRotationCenter(): boolean

hasEffect

  • hasEffect(name: string): boolean

Returns boolean

hasCustomRotationCenter

  • hasCustomRotationCenter(): boolean

hasEffect

  • hasEffect(name: string): boolean

hasNoForces

  • hasNoForces(): boolean

hasNoForces

  • hasNoForces(): boolean

hasVariable

  • hasVariable(name: string): boolean

hasVariable

  • hasVariable(name: string): boolean

hide

  • hide(enable: boolean): void

hide

  • hide(enable: boolean): void

insideObject

  • insideObject(x: number, y: number): boolean

Returns void

insideObject

  • insideObject(x: number, y: number): boolean

  • Return true if the specified position is inside object bounding box.

    The position should be in "world" coordinates, i.e use gdjs.Layer.convertCoords if you need to pass the mouse or a touch position that you get from gdjs.InputManager. To check if a point is inside the object collision mask, you can use isCollidingWithPoint instead.

    -

    Parameters

    • x: number
    • y: number

    Returns boolean

invalidateHitboxes

  • invalidateHitboxes(): void

invalidateHitboxes

  • invalidateHitboxes(): void

isCollidingWithPoint

  • isCollidingWithPoint(pointX: number, pointY: number): boolean

isCollidingWithPoint

  • isCollidingWithPoint(pointX: number, pointY: number): boolean

isEffectEnabled

  • isEffectEnabled(name: string): boolean

isEffectEnabled

  • isEffectEnabled(name: string): boolean

isFlippedX

  • isFlippedX(): boolean

isFlippedY

  • isFlippedY(): boolean

isHidden

  • isHidden(): boolean

isFlippedX

  • isFlippedX(): boolean

isFlippedY

  • isFlippedY(): boolean

isHidden

  • isHidden(): boolean

isIncludedInParentCollisionMask

  • isIncludedInParentCollisionMask(): boolean

isOnLayer

  • isOnLayer(layer: string): boolean

isIncludedInParentCollisionMask

  • isIncludedInParentCollisionMask(): boolean

isOnLayer

  • isOnLayer(layer: string): boolean

isTotalForceAngleAround

  • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

isTotalForceAngleAround

  • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

  • Return true if the angle of the total force applied on the object is in a given range.

    Parameters

    • angle: number
      @@ -440,46 +440,46 @@

      The maximum distance from the given angle.

    Returns boolean

    true if the difference between the force angle the given angle is less or equals the toleranceInDegrees.

    -

isVisible

  • isVisible(): boolean

isVisible

  • isVisible(): boolean

  • Return true if the object is not hidden.

    Note: This is unrelated to the actual visibility of the object on the screen. For this, see getVisibilityAABB to get the bounding boxes of the object as displayed on the scene.

    Returns boolean

    true if the object is not hidden.

    -

notifyBehaviorsObjectHotReloaded

  • notifyBehaviorsObjectHotReloaded(): void

notifyBehaviorsObjectHotReloaded

  • notifyBehaviorsObjectHotReloaded(): void

onChildrenLocationChanged

  • onChildrenLocationChanged(): void

onCreated

  • onCreated(): void

onChildrenLocationChanged

  • onChildrenLocationChanged(): void

onCreated

  • onCreated(): void

  • To be called by the child classes in their constructor, at the very end. Notify the behaviors that they have been constructed (this must be done when the object is ready, otherwise behaviors can do operations on the object which could be not initialized yet).

    If you redefine this function, make sure to call the original method (RuntimeObject.prototype.onCreated.call(this);).

    -

    Returns void

onDeletedFromScene

onDeletedFromScene

onDestroy

onDestroy

onDestroyed

  • onDestroyed(): void

onHotReloading

onDestroyed

  • onDestroyed(): void

onHotReloading

onScenePaused

onScenePaused

onSceneResumed

Returns void

onSceneResumed

pauseTimer

  • pauseTimer(timerName: string): void

Returns void

pauseTimer

  • pauseTimer(timerName: string): void

putAround

  • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

Returns void

putAround

  • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

  • Put the object around a position, with a specific distance and angle. The distance and angle are computed between the position and the center of the object.

    Parameters

    • x: number
      @@ -490,7 +490,7 @@

      The distance between the object and the target, in pixels.

    • angleInDegrees: number

      The angle between the object and the target, in degrees.

      -

    Returns void

putAroundObject

  • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

Returns void

putAroundObject

  • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

  • Put the object around another object, with a specific distance and angle. The distance and angle are computed between the centers of the objects.

    Parameters

    • obj: null | RuntimeObject
      @@ -499,7 +499,7 @@

      The distance between the object and the target

    • angleInDegrees: number

      The angle between the object and the target, in degrees.

      -

    Returns void

raycastTest

  • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

raycastTest

  • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

registerDestroyCallback

  • registerDestroyCallback(callback: () => void): void

reinitialize

registerDestroyCallback

  • registerDestroyCallback(callback: () => void): void

reinitialize

  • Called to reset the object to its default state. This is used for objects that are "recycled": they are dismissed (at which point onDestroyFromScene is called) but still stored in a cache to be reused next time an object must be created. At this point, @@ -525,7 +525,7 @@

  • The _runtimeScene, _nameId, name and type are guaranteed to stay the same and do not need to be set again.
-

Parameters

Returns void

removeBehavior

removeBehavior

removeEffect

removeEffect

removeTimer

Returns boolean

removeTimer

resetTimer

Returns void

resetTimer

Static returnVariable

Returns void

Static returnVariable

rotate

rotate

rotateTowardAngle

rotateTowardAngle

rotateTowardPosition

separateFromObjects

Returns void

rotateTowardPosition

separateFromObjects

separateFromObjectsList

separateFromObjectsList

separateObjectsWithForces

separateObjectsWithForces

separateObjectsWithoutForces

separateObjectsWithoutForces

setAngle

Returns void

setAngle

setCenterPositionInScene

setCenterPositionInScene

setCenterXInScene

Returns void

setCenterXInScene

setCenterYInScene

Returns void

setCenterYInScene

setEffectBooleanParameter

setEffectBooleanParameter

setEffectDoubleParameter

Returns boolean

setEffectDoubleParameter

setEffectStringParameter

Returns boolean

setEffectStringParameter

setHeight

Returns boolean

setHeight

setIncludedInParentCollisionMask

setLayer

setIncludedInParentCollisionMask

setLayer

setOpacity

Returns void

setOpacity

setPosition

setPosition

setRotationCenter

Returns void

setRotationCenter

Returns void

setScale

Returns void

setScale

setScaleX

Returns void

setScaleX

setScaleY

Returns void

setScaleY

setSize

Returns void

setSize

Static setVariableNumber

Returns void

Static setVariableNumber

Static setVariableString

Returns void

Static setVariableString

setWidth

Returns void

setWidth

setX

setX

setY

setY

setZOrder

setZOrder

stepBehaviorsPostEvents

Returns void

stepBehaviorsPostEvents

stepBehaviorsPreEvents

stepBehaviorsPreEvents

timerElapsedTime

timerElapsedTime

timerPaused

timerPaused

unpauseTimer

unpauseTimer

unregisterDestroyCallback

update

Returns void

unregisterDestroyCallback

update

updateAABB

updateAABB

updateAllEffectParameters

updateAllEffectParameters

updateForces

Returns boolean

updateForces

updateFromNetworkSyncData

updateFromNetworkSyncData

updateFromObjectData

updateFromObjectData

updateHitBoxes

updateHitBoxes

updatePreRender

updatePreRender

updateTimers

updateTimers

Properties

angle

angle: number = 0

Static forcesGarbage

forcesGarbage: Force[] = []
+

Returns void

Properties

angle

angle: number = 0

Static forcesGarbage

forcesGarbage: Force[] = []

Global container for unused forces, avoiding recreating forces each tick.

-
static

Static getFirstVariableNumber

getFirstVariableNumber: (array: Variable) => number = ...

Type declaration

Static getFirstVariableNumber

getFirstVariableNumber: (array: Variable) => number = ...

Type declaration

    • Shortcut to get the first value of an array variable as a number.

      -

      Parameters

      Returns number

getFirstVariableNumber

getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

Type declaration

getFirstVariableNumber

getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

Type declaration

    • Shortcut to get the first value of an array variable as a number.

      -

      Parameters

      Returns number

Static getFirstVariableString

getFirstVariableString: (array: Variable) => string = ...

Type declaration

Static getFirstVariableString

getFirstVariableString: (array: Variable) => string = ...

Type declaration

    • Shortcut to get the first value of an array variable as a string.

      -

      Parameters

      Returns string

getFirstVariableString

getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

Type declaration

getFirstVariableString

getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

Type declaration

    • Shortcut to get the first value of an array variable as a string.

      -

      Parameters

      Returns string

Static getLastVariableNumber

getLastVariableNumber: (array: Variable) => number = ...

Type declaration

Static getLastVariableNumber

getLastVariableNumber: (array: Variable) => number = ...

Type declaration

    • Shortcut to get the last value of an array variable as a number.

      -

      Parameters

      Returns number

getLastVariableNumber

getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

Type declaration

getLastVariableNumber

getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

Type declaration

    • Shortcut to get the last value of an array variable as a number.

      -

      Parameters

      Returns number

Static getLastVariableString

getLastVariableString: (array: Variable) => string = ...

Type declaration

Static getLastVariableString

getLastVariableString: (array: Variable) => string = ...

Type declaration

    • Shortcut to get the last value of an array variable as a string.

      -

      Parameters

      Returns string

getLastVariableString

getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

Type declaration

getLastVariableString

getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

Type declaration

    • Shortcut to get the last value of an array variable as a string.

      -

      Parameters

      Returns string

getSqDistanceTo

getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

Type declaration

    • (targetX: number, targetY: number): number
    • +

      Parameters

      Returns string

getSqDistanceTo

getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

Type declaration

    • (targetX: number, targetY: number): number

    • Get the squared distance, in pixels, between the center of this object and a position.

      Parameters

      • targetX: number

        Target X position

      • targetY: number

        Target Y position

        -

      Returns number

getVariableBoolean

getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

Type declaration

    • (variable: Variable, compareWith: boolean): boolean
    • +

    Returns number

getVariableBoolean

getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

Type declaration

    • (variable: Variable, compareWith: boolean): boolean

    • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

      -

      Parameters

      Returns boolean

getVariableChildCount

getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

Type declaration

    • +

      Parameters

      Returns boolean

getVariableChildCount

getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

Type declaration

    • Get the number of children from a variable

      static

      Parameters

      • variable: Variable

        The variable to be accessed

      Returns number

      The number of children

      -

getVariableNumber

getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

Type declaration

getVariableNumber

getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

Type declaration

    • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

      static

      Parameters

      • variable: Variable

        The variable to be accessed

      Returns number

      The value of the specified variable

      -

getVariableString

getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

Type declaration

getVariableString

getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

Type declaration

    • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

      static

      Parameters

      • variable: Variable

        The variable to be accessed

      Returns string

      The string of the specified variable

      -

hidden

hidden: boolean = false

Readonly id

id: number

layer

layer: string = ''

name

name: string

networkId

networkId: null | string = null
+

hidden

hidden: boolean = false

Readonly id

id: number

layer

layer: string = ''

name

name: string

networkId

networkId: null | string = null

A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

-

persistentUuid

persistentUuid: null | string = null
+

persistentUuid

persistentUuid: null | string = null

An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

-

pick

pick: boolean = false
+

pick

pick: boolean = false

A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

-

returnVariable

returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

Type declaration

returnVariable

returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

Type declaration

    • Return the variable passed as argument without any change. Only for usage by events.

      static

      Parameters

      • variable: Variable

        The variable to be accessed

      Returns Variable

      The specified variable

      -

setVariableBoolean

setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

Type declaration

    • (variable: Variable, newValue: boolean): void
    • +

setVariableBoolean

setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

Type declaration

    • (variable: Variable, newValue: boolean): void

    • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

      Parameters

      Returns void

setVariableNumber

setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

Type declaration

    • (variable: Variable, newValue: number): void
    • +

    Returns void

setVariableNumber

setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

Type declaration

    • (variable: Variable, newValue: number): void

    • Shortcut to set the value of a variable considered as a number

      Parameters

      • variable: Variable

        The variable to be changed

      • newValue: number

        The value to be set

        -

      Returns void

setVariableString

setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

Type declaration

    • (variable: Variable, newValue: string): void
    • +

    Returns void

setVariableString

setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

Type declaration

    • (variable: Variable, newValue: string): void

    • Shortcut to set the value of a variable considered as a string

      Parameters

      • variable: Variable

        The variable to be changed

      • newValue: string

        The value to be set

        -

      Returns void

Static supportsReinitialization

supportsReinitialization: boolean = false

toggleVariableBoolean

toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

Type declaration

    • +

    Returns void

Static supportsReinitialization

supportsReinitialization: boolean = false

toggleVariableBoolean

toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

Type declaration

    • Toggles a variable. This shortcut function is needed for events code generation.

      see

      {gdjs.evtTools.common.toggleVariableBoolean}

      -

      Parameters

      Returns void

type

type: string

valuePush

valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

Type declaration

    • (array: Variable, value: string | number | boolean): void
    • +

      Parameters

      Returns void

type

type: string

valuePush

valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

Type declaration

    • (array: Variable, value: string | number | boolean): void

    • This shortcut function is needed for events code generation.

      -

      Parameters

      • array: Variable
      • value: string | number | boolean

      Returns void

variableChildExists

variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

Type declaration

    • (variable: Variable, childName: string): boolean
    • static

      Parameters

      • variable: Variable
        +

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

variableChildExists

variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

Type declaration

    • (variable: Variable, childName: string): boolean
    • static

      Parameters

      • variable: Variable

        The variable to be tested

      • childName: string

        The name of the child

        -

      Returns boolean

variableClearChildren

variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

Type declaration

variableClearChildren

variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

Type declaration

    • static

      Parameters

      • variable: Variable

        The variable to be cleared

        -

      Returns void

variablePushCopy

variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

Type declaration

variablePushCopy

variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

Type declaration

    • This shortcut function is needed for events code generation.

      -

      Parameters

      Returns void

variableRemoveAt

variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

Type declaration

variableRemoveAt

variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

Type declaration

    • This shortcut function is needed for events code generation.

      -

      Parameters

      Returns void

variableRemoveChild

variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

Type declaration

    • (variable: Variable, childName: string): void
    • static

      Parameters

variableRemoveChild

variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

Type declaration

    • (variable: Variable, childName: string): void
    • static

      Parameters

      • variable: Variable

        The variable to be changed

      • childName: string

        The name of the child

        -

      Returns void

x

x: number = 0

y

y: number = 0

zOrder

zOrder: number = 0

Protected aabb

aabb: AABB = ...

Protected hitBoxes

hitBoxes: Polygon[]

Protected hitBoxesDirty

hitBoxesDirty: boolean = true

Static Private getVariableBoolean

getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

Type declaration

    • (variable: Variable, compareWith: boolean): boolean
    • +

    Returns void

x

x: number = 0

y

y: number = 0

zOrder

zOrder: number = 0

Protected aabb

aabb: AABB = ...

Protected hitBoxes

hitBoxes: Polygon[]

Protected hitBoxesDirty

hitBoxesDirty: boolean = true

Static Private getVariableBoolean

getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

Type declaration

    • (variable: Variable, compareWith: boolean): boolean

    • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

      -

      Parameters

      Returns boolean

Static Private setVariableBoolean

setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

Type declaration

    • (variable: Variable, newValue: boolean): void
    • +

      Parameters

      Returns boolean

Static Private setVariableBoolean

setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

Type declaration

    • (variable: Variable, newValue: boolean): void

    • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

      Parameters

      Returns void

Static Private toggleVariableBoolean

toggleVariableBoolean: (variable: Variable) => void = ...

Type declaration

    • +

    Returns void

Static Private toggleVariableBoolean

toggleVariableBoolean: (variable: Variable) => void = ...

Type declaration

    • Toggles a variable. This shortcut function is needed for events code generation.

      see

      {gdjs.evtTools.common.toggleVariableBoolean}

      -

      Parameters

      Returns void

Static Private valuePush

valuePush: (array: Variable, value: string | number | boolean) => void = ...

Type declaration

    • (array: Variable, value: string | number | boolean): void
    • +

      Parameters

      Returns void

Static Private valuePush

valuePush: (array: Variable, value: string | number | boolean) => void = ...

Type declaration

    • (array: Variable, value: string | number | boolean): void

    • This shortcut function is needed for events code generation.

      -

      Parameters

      • array: Variable
      • value: string | number | boolean

      Returns void

Static Private variablePushCopy

variablePushCopy: (array: Variable, variable: Variable) => void = ...

Type declaration

Static Private variablePushCopy

variablePushCopy: (array: Variable, variable: Variable) => void = ...

Type declaration

    • This shortcut function is needed for events code generation.

      -

      Parameters

      Returns void

Static Private variableRemoveAt

variableRemoveAt: (array: Variable, index: number) => void = ...

Type declaration

Static Private variableRemoveAt

variableRemoveAt: (array: Variable, index: number) => void = ...

Type declaration

    • This shortcut function is needed for events code generation.

      -

      Parameters

      Returns void

Constructors

constructor

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomRuntimeObject2DPixiRenderer

The renderer for a gdjs.CustomRuntimeObject2D using Pixi.js.

-

Hierarchy

  • CustomRuntimeObject2DPixiRenderer

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

ensureUpToDate

  • ensureUpToDate(): void

Hierarchy

  • CustomRuntimeObject2DPixiRenderer

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

ensureUpToDate

  • ensureUpToDate(): void

get3DRendererObject

  • get3DRendererObject(): null | Object3D<Object3DEventMap>

Static getAnimationFrameTextureManager

  • getAnimationFrameTextureManager(imageManager: PixiImageManager): PixiAnimationFrameTextureManager

getPIXIContainer

  • getPIXIContainer(): Container<DisplayObject>

getPIXIRenderer

  • getPIXIRenderer(): null

getRendererObject

  • getRendererObject(): Container<DisplayObject>

reinitialize

setLayerIndex

get3DRendererObject

  • get3DRendererObject(): null | Object3D<Object3DEventMap>

Static getAnimationFrameTextureManager

  • getAnimationFrameTextureManager(imageManager: PixiImageManager): PixiAnimationFrameTextureManager

getPIXIContainer

  • getPIXIContainer(): Container<DisplayObject>

getPIXIRenderer

  • getPIXIRenderer(): null

getRendererObject

  • getRendererObject(): Container<DisplayObject>

reinitialize

setLayerIndex

update

  • update(): void

updateAngle

  • updateAngle(): void

updateOpacity

  • updateOpacity(): void

updateVisibility

  • updateVisibility(): void

updateX

  • updateX(): void

updateY

  • updateY(): void

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomRuntimeObject3D

Base class for 3D custom objects.

-

Hierarchy

Implements

Index

Methods

Properties

Constructors

Methods

activateBehavior

  • activateBehavior(name: string, enable: boolean): void

Hierarchy

Implements

Index

Methods

Properties

Constructors

Methods

activateBehavior

  • activateBehavior(name: string, enable: boolean): void

addEffect

  • addEffect(effectData: EffectData): boolean

Returns void

addEffect

  • addEffect(effectData: EffectData): boolean

addForce

  • addForce(x: number, y: number, multiplier: number): void

Returns boolean

addForce

  • addForce(x: number, y: number, multiplier: number): void

addForceTowardObject

  • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

Returns void

addForceTowardObject

  • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

addForceTowardPosition

  • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

Returns void

addForceTowardPosition

  • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

addNewBehavior

  • addNewBehavior(behaviorData: BehaviorData): boolean

Returns void

addNewBehavior

  • addNewBehavior(behaviorData: BehaviorData): boolean

addPolarForce

  • addPolarForce(angle: number, len: number, multiplier: number): void

addPolarForce

  • addPolarForce(angle: number, len: number, multiplier: number): void

applyObjectInverseTransformation

  • applyObjectInverseTransformation(x: number, y: number, destination: FloatPoint): void

Returns void

applyObjectInverseTransformation

  • applyObjectInverseTransformation(x: number, y: number, destination: FloatPoint): void

  • Return an array containing the coordinates of the point passed as parameter in object local coordinates (as opposed to the parent coordinate coordinates).

    All transformations (flipping, scale, rotation) are supported.

    @@ -58,7 +58,7 @@

    The X position of the point, in parent coordinates.

  • y: number

    The Y position of the point, in parent coordinates.

    -
  • destination: FloatPoint

Returns void

applyObjectTransformation

  • applyObjectTransformation(x: number, y: number, destination: FloatPoint): void

Returns void

applyObjectTransformation

  • applyObjectTransformation(x: number, y: number, destination: FloatPoint): void

  • Return an array containing the coordinates of the point passed as parameter in parent coordinate coordinates (as opposed to the object local coordinates).

    All transformations (flipping, scale, rotation) are supported.

    @@ -66,7 +66,7 @@

    The X position of the point, in object coordinates.

  • y: number

    The Y position of the point, in object coordinates.

    -
  • destination: FloatPoint

Returns void

averageForceAngleIs

  • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

Returns void

averageForceAngleIs

  • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

Returns boolean

true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

-

behaviorActivated

  • behaviorActivated(name: string): boolean

behaviorActivated

  • behaviorActivated(name: string): boolean

clearEffects

  • clearEffects(): boolean

clearEffects

  • clearEffects(): boolean

clearForces

  • clearForces(): void

clearForces

  • clearForces(): void

Static collisionTest

Static collisionTest

  • Return true if the hitboxes of two objects are overlapping

    static

    Parameters

    • obj1: RuntimeObject

      The first runtimeObject

      @@ -94,75 +94,75 @@
    • ignoreTouchingEdges: boolean

      If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

    Returns boolean

    true if obj1 and obj2 are in collision

    -

cursorOnObject

cursorOnObject

deleteFromScene

deleteFromScene

Static distanceTest

Returns void

Static distanceTest

doStepPostEvents

doStepPostEvents

doStepPreEvents

enableEffect

  • enableEffect(name: string, enable: boolean): void

Returns void

doStepPreEvents

enableEffect

  • enableEffect(name: string, enable: boolean): void

extraInitializationFromInitialInstance

  • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

Returns void

extraInitializationFromInitialInstance

  • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

flipX

  • flipX(enable: boolean): void

flipY

  • flipY(enable: boolean): void

flipZ

  • flipZ(enable: boolean): void

get3DRendererObject

  • get3DRendererObject(): Object3D<Object3DEventMap>

getAABB

flipX

  • flipX(enable: boolean): void

flipY

  • flipY(enable: boolean): void

flipZ

  • flipZ(enable: boolean): void

get3DRendererObject

  • get3DRendererObject(): Object3D<Object3DEventMap>

getAABB

  • Get the AABB (axis aligned bounding box) for the object.

    The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

    You should probably redefine updateAABB instead of this function.

    Returns AABB

    The bounding box

    -

getAABBBottom

  • getAABBBottom(): number

getAABBBottom

  • getAABBBottom(): number

getAABBCenterX

  • getAABBCenterX(): number

getAABBCenterX

  • getAABBCenterX(): number

getAABBCenterY

  • getAABBCenterY(): number

getAABBCenterY

  • getAABBCenterY(): number

getAABBLeft

  • getAABBLeft(): number

getAABBLeft

  • getAABBLeft(): number

getAABBRight

  • getAABBRight(): number

getAABBRight

  • getAABBRight(): number

getAABBTop

  • getAABBTop(): number

getAABBTop

  • getAABBTop(): number

getAngle

  • getAngle(): number

getAngle

  • getAngle(): number

getAngleToObject

getAngleToObject

getAngleToPosition

  • getAngleToPosition(targetX: number, targetY: number): number

Returns number

getAngleToPosition

  • getAngleToPosition(targetX: number, targetY: number): number

getAnimator

Returns number

getAnimator

getAverageForce

getAverageForce

getBehavior

getBehavior

  • Get a behavior from its name. If the behavior does not exists, undefined is returned.

    Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -170,75 +170,75 @@

    Parameters

    • name: string

      The behavior name.

    Returns null | RuntimeBehavior

    The behavior with the given name, or undefined.

    -

getCenterX

  • getCenterX(): number

getCenterX

  • getCenterX(): number

  • Return the X position of the object center, relative to the object X position (getDrawableX). Use getCenterXInScene to get the position of the center in the scene.

    Returns number

    the X position of the object center, relative to getDrawableX().

    -

getCenterXInScene

  • getCenterXInScene(): number

getCenterXInScene

  • getCenterXInScene(): number

getCenterY

  • getCenterY(): number

getCenterY

  • getCenterY(): number

getCenterYInScene

  • getCenterYInScene(): number

getCenterYInScene

  • getCenterYInScene(): number

getCenterZ

  • getCenterZ(): number

getCenterZ

  • getCenterZ(): number

  • Return the Z position of the object center, relative to the object Z position (getDrawableX).

    Use getCenterZInScene to get the position of the center in the scene.

    Returns number

    the Z position of the object center, relative to getDrawableZ().

    -

getCenterZInScene

  • getCenterZInScene(): number

getCenterZInScene

  • getCenterZInScene(): number

getDepth

  • getDepth(): number

getDepth

  • getDepth(): number

getDistanceToObject

getDistanceToObject

getDistanceToPosition

  • getDistanceToPosition(targetX: number, targetY: number): number

Returns number

getDistanceToPosition

  • getDistanceToPosition(targetX: number, targetY: number): number

getDrawableX

  • getDrawableX(): number

Returns number

getDrawableX

  • getDrawableX(): number

  • Get the X position of the rendered object.

    For most objects, this will returns the same value as getX(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableX will differ.

    Returns number

    The X position of the rendered object.

    -

getDrawableY

  • getDrawableY(): number

getDrawableY

  • getDrawableY(): number

  • Get the Y position of the rendered object.

    For most objects, this will returns the same value as getY(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableY will differ.

    Returns number

    The Y position of the rendered object.

    -

getDrawableZ

  • getDrawableZ(): number

getDrawableZ

  • getDrawableZ(): number

  • Get the Z position of the rendered object.

    For most objects, this will returns the same value as getZ(). But if the object has an origin that is not the same as the point (0,0,0) of the object displayed, getDrawableZ will differ.

    Returns number

    The Z position of the rendered object.

    -

getElapsedTime

getElapsedTime

getHeight

  • getHeight(): number

Returns number

getHeight

  • getHeight(): number

getHitBoxes

getHitBoxes

getHitBoxesAround

  • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

getHitBoxesAround

  • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

  • Return at least all the hit boxes that overlap a given area.

    The hit boxes don't need to actually overlap the area, (i.e: it's correct to return more hit boxes than those in the specified area) @@ -263,210 +263,210 @@

  • bottom: number

    bound of the area in scene coordinates

Returns Iterable<Polygon>

at least all the hit boxes that overlap a given area.

-

getInstanceContainer

getInstanceContainer

getLayer

  • getLayer(): string

getLayer

  • getLayer(): string

getLocalInverseTransformation

getLocalTransformation

getLocalInverseTransformation

getLocalTransformation

getName

  • getName(): string

getName

  • getName(): string

getNameId

  • getNameId(): number

getNameId

  • getNameId(): number

Static getNameIdentifier

  • getNameIdentifier(name: string): number

Static getNameIdentifier

  • getNameIdentifier(name: string): number

getNetworkSyncData

  • getNetworkSyncData(): ObjectNetworkSyncData

getNetworkSyncData

  • getNetworkSyncData(): ObjectNetworkSyncData

getOpacity

  • getOpacity(): number

getOpacity

  • getOpacity(): number

getParent

getParent

getRenderer

getRendererEffects

  • getRendererEffects(): Record<string, Filter>

getRenderer

getRendererEffects

  • getRendererEffects(): Record<string, Filter>

getRendererObject

getRotationX

  • getRotationX(): number

getRendererObject

getRotationX

  • getRotationX(): number

getRotationY

  • getRotationY(): number

getRotationY

  • getRotationY(): number

getRuntimeScene

getRuntimeScene

getScale

  • getScale(): number

getScale

  • getScale(): number

getScaleMean

  • getScaleMean(): number

getScaleMean

  • getScaleMean(): number

getScaleX

  • getScaleX(): number

getScaleX

  • getScaleX(): number

getScaleY

  • getScaleY(): number

getScaleY

  • getScaleY(): number

getScaleZ

  • getScaleZ(): number

getScaleZ

  • getScaleZ(): number

getSqDistanceToObject

getSqDistanceToObject

getSqDistanceToPosition

  • getSqDistanceToPosition(targetX: number, targetY: number): number

Returns number

getSqDistanceToPosition

  • getSqDistanceToPosition(targetX: number, targetY: number): number

getTimerElapsedTimeInSeconds

  • getTimerElapsedTimeInSeconds(timerName: string): number

Returns number

getTimerElapsedTimeInSeconds

  • getTimerElapsedTimeInSeconds(timerName: string): number

getTimerElapsedTimeInSecondsOrNaN

  • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

getTimerElapsedTimeInSecondsOrNaN

  • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

getUniqueId

  • getUniqueId(): number

getUniqueId

  • getUniqueId(): number

  • Get the unique identifier of the object.
    The identifier is set by the runtimeScene owning the object.
    You can also use the id property (this._object.id) for increased efficiency instead of calling this method.

    Returns number

    The object identifier

    -

getUnrotatedAABBMaxZ

  • getUnrotatedAABBMaxZ(): number

getUnrotatedAABBMaxZ

  • getUnrotatedAABBMaxZ(): number

getUnrotatedAABBMinZ

  • getUnrotatedAABBMinZ(): number

getUnrotatedAABBMinZ

  • getUnrotatedAABBMinZ(): number

getUnscaledCenterX

  • getUnscaledCenterX(): number

getUnscaledCenterY

  • getUnscaledCenterY(): number

getUnscaledCenterZ

  • getUnscaledCenterZ(): number

getUnscaledDepth

  • getUnscaledDepth(): number

getUnscaledHeight

  • getUnscaledHeight(): number

getUnscaledWidth

  • getUnscaledWidth(): number

Static getVariableChildCount

  • getVariableChildCount(variable: Variable): number

getUnscaledCenterX

  • getUnscaledCenterX(): number

getUnscaledCenterY

  • getUnscaledCenterY(): number

getUnscaledCenterZ

  • getUnscaledCenterZ(): number

getUnscaledDepth

  • getUnscaledDepth(): number

getUnscaledHeight

  • getUnscaledHeight(): number

getUnscaledWidth

  • getUnscaledWidth(): number

Static getVariableChildCount

  • getVariableChildCount(variable: Variable): number

Static getVariableNumber

  • getVariableNumber(variable: Variable): number

Static getVariableNumber

  • getVariableNumber(variable: Variable): number

Static getVariableString

  • getVariableString(variable: Variable): string

Static getVariableString

  • getVariableString(variable: Variable): string

getVariables

getVariables

getVisibilityAABB

  • getVisibilityAABB(): null | AABB

getVisibilityAABB

  • getVisibilityAABB(): null | AABB

  • Get the AABB (axis aligned bounding box) to be used to determine if the object is visible on screen. The gdjs.RuntimeScene will hide the renderer object if the object is not visible on screen ("culling").

    The default implementation uses the AABB returned by getAABB.

    If null is returned, the object is assumed to be always visible.

    Returns null | AABB

    The bounding box or null.

    -

getWidth

  • getWidth(): number

getWidth

  • getWidth(): number

getX

  • getX(): number

getX

  • getX(): number

getXFromAngleAndDistance

  • getXFromAngleAndDistance(angle: number, distance: number): number

getXFromAngleAndDistance

  • getXFromAngleAndDistance(angle: number, distance: number): number

  • Compute the X position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

    Parameters

    • angle: number

      The angle, in degrees.

    • distance: number

      The distance from the object, in pixels

      -

    Returns number

getY

  • getY(): number

Returns number

getY

  • getY(): number

getYFromAngleAndDistance

  • getYFromAngleAndDistance(angle: number, distance: number): number

getYFromAngleAndDistance

  • getYFromAngleAndDistance(angle: number, distance: number): number

  • Compute the Y position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

    Parameters

    • angle: number

      The angle, in degrees.

    • distance: number

      The distance from the object, in pixels

      -

    Returns number

getZ

  • getZ(): number

Returns number

getZ

  • getZ(): number

getZOrder

  • getZOrder(): number

getZOrder

  • getZOrder(): number

hasBehavior

  • hasBehavior(name: string): boolean

hasBehavior

  • hasBehavior(name: string): boolean

hasCustomRotationCenter

  • hasCustomRotationCenter(): boolean

hasEffect

  • hasEffect(name: string): boolean

Returns boolean

hasCustomRotationCenter

  • hasCustomRotationCenter(): boolean

hasEffect

  • hasEffect(name: string): boolean

hasNoForces

  • hasNoForces(): boolean

hasNoForces

  • hasNoForces(): boolean

hasVariable

  • hasVariable(name: string): boolean

hasVariable

  • hasVariable(name: string): boolean

hide

  • hide(enable: boolean): void

hide

  • hide(enable: boolean): void

insideObject

  • insideObject(x: number, y: number): boolean

Returns void

insideObject

  • insideObject(x: number, y: number): boolean

  • Return true if the specified position is inside object bounding box.

    The position should be in "world" coordinates, i.e use gdjs.Layer.convertCoords if you need to pass the mouse or a touch position that you get from gdjs.InputManager. To check if a point is inside the object collision mask, you can use isCollidingWithPoint instead.

    -

    Parameters

    • x: number
    • y: number

    Returns boolean

invalidateHitboxes

  • invalidateHitboxes(): void

invalidateHitboxes

  • invalidateHitboxes(): void

isCollidingWithPoint

  • isCollidingWithPoint(pointX: number, pointY: number): boolean

isCollidingWithPoint

  • isCollidingWithPoint(pointX: number, pointY: number): boolean

isEffectEnabled

  • isEffectEnabled(name: string): boolean

isEffectEnabled

  • isEffectEnabled(name: string): boolean

isFlippedX

  • isFlippedX(): boolean

isFlippedY

  • isFlippedY(): boolean

isFlippedZ

  • isFlippedZ(): boolean

isHidden

  • isHidden(): boolean

isFlippedX

  • isFlippedX(): boolean

isFlippedY

  • isFlippedY(): boolean

isFlippedZ

  • isFlippedZ(): boolean

isHidden

  • isHidden(): boolean

isIncludedInParentCollisionMask

  • isIncludedInParentCollisionMask(): boolean

isOnLayer

  • isOnLayer(layer: string): boolean

isIncludedInParentCollisionMask

  • isIncludedInParentCollisionMask(): boolean

isOnLayer

  • isOnLayer(layer: string): boolean

isTotalForceAngleAround

  • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

isTotalForceAngleAround

  • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

  • Return true if the angle of the total force applied on the object is in a given range.

    Parameters

    • angle: number
      @@ -475,46 +475,46 @@

      The maximum distance from the given angle.

    Returns boolean

    true if the difference between the force angle the given angle is less or equals the toleranceInDegrees.

    -

isVisible

  • isVisible(): boolean

isVisible

  • isVisible(): boolean

  • Return true if the object is not hidden.

    Note: This is unrelated to the actual visibility of the object on the screen. For this, see getVisibilityAABB to get the bounding boxes of the object as displayed on the scene.

    Returns boolean

    true if the object is not hidden.

    -

notifyBehaviorsObjectHotReloaded

  • notifyBehaviorsObjectHotReloaded(): void

notifyBehaviorsObjectHotReloaded

  • notifyBehaviorsObjectHotReloaded(): void

onChildrenLocationChanged

  • onChildrenLocationChanged(): void

onCreated

  • onCreated(): void

onChildrenLocationChanged

  • onChildrenLocationChanged(): void

onCreated

  • onCreated(): void

  • To be called by the child classes in their constructor, at the very end. Notify the behaviors that they have been constructed (this must be done when the object is ready, otherwise behaviors can do operations on the object which could be not initialized yet).

    If you redefine this function, make sure to call the original method (RuntimeObject.prototype.onCreated.call(this);).

    -

    Returns void

onDeletedFromScene

onDeletedFromScene

onDestroy

onDestroy

onDestroyed

  • onDestroyed(): void

onHotReloading

onDestroyed

  • onDestroyed(): void

onHotReloading

onScenePaused

onScenePaused

onSceneResumed

Returns void

onSceneResumed

pauseTimer

  • pauseTimer(timerName: string): void

Returns void

pauseTimer

  • pauseTimer(timerName: string): void

putAround

  • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

Returns void

putAround

  • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

  • Put the object around a position, with a specific distance and angle. The distance and angle are computed between the position and the center of the object.

    Parameters

    • x: number
      @@ -525,7 +525,7 @@

      The distance between the object and the target, in pixels.

    • angleInDegrees: number

      The angle between the object and the target, in degrees.

      -

    Returns void

putAroundObject

  • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

Returns void

putAroundObject

  • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

  • Put the object around another object, with a specific distance and angle. The distance and angle are computed between the centers of the objects.

    Parameters

    • obj: null | RuntimeObject
      @@ -534,7 +534,7 @@

      The distance between the object and the target

    • angleInDegrees: number

      The angle between the object and the target, in degrees.

      -

    Returns void

raycastTest

  • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

raycastTest

  • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

registerDestroyCallback

  • registerDestroyCallback(callback: () => void): void

reinitialize

registerDestroyCallback

  • registerDestroyCallback(callback: () => void): void

reinitialize

  • Called to reset the object to its default state. This is used for objects that are "recycled": they are dismissed (at which point onDestroyFromScene is called) but still stored in a cache to be reused next time an object must be created. At this point, @@ -560,7 +560,7 @@

  • The _runtimeScene, _nameId, name and type are guaranteed to stay the same and do not need to be set again.
-

Parameters

Returns void

removeBehavior

removeBehavior

removeEffect

removeEffect

removeTimer

Returns boolean

removeTimer

resetTimer

Returns void

resetTimer

Static returnVariable

Returns void

Static returnVariable

rotate

rotate

rotateTowardAngle

rotateTowardAngle

rotateTowardPosition

separateFromObjects

Returns void

rotateTowardPosition

separateFromObjects

separateFromObjectsList

separateFromObjectsList

separateObjectsWithForces

separateObjectsWithForces

separateObjectsWithoutForces

separateObjectsWithoutForces

setAngle

Returns void

setAngle

setCenterPositionInScene

setCenterPositionInScene

setCenterXInScene

Returns void

setCenterXInScene

setCenterYInScene

Returns void

setCenterYInScene

setCenterZInScene

setCenterZInScene

setDepth

setDepth

setEffectBooleanParameter

setEffectBooleanParameter

setEffectDoubleParameter

Returns boolean

setEffectDoubleParameter

setEffectStringParameter

Returns boolean

setEffectStringParameter

setHeight

Returns boolean

setHeight

setIncludedInParentCollisionMask

setLayer

setIncludedInParentCollisionMask

setLayer

setOpacity

Returns void

setOpacity

setPosition

setPosition

setRotationCenter

Returns void

setRotationCenter

Returns void

setRotationCenter3D

Returns void

setRotationCenter3D

Returns void

setRotationX

Returns void

setRotationX

setRotationY

setRotationY

setScale

setScale

setScaleX

Returns void

setScaleX

setScaleY

Returns void

setScaleY

setScaleZ

Returns void

setScaleZ

setSize

Returns void

setSize

Static setVariableNumber

Returns void

Static setVariableNumber

Static setVariableString

Returns void

Static setVariableString

setWidth

Returns void

setWidth

setX

setX

setY

setY

setZ

setZ

setZOrder

setZOrder

stepBehaviorsPostEvents

Returns void

stepBehaviorsPostEvents

stepBehaviorsPreEvents

stepBehaviorsPreEvents

timerElapsedTime

timerElapsedTime

timerPaused

timerPaused

turnAroundX

turnAroundX

turnAroundY

Returns void

turnAroundY

turnAroundZ

Returns void

turnAroundZ

unpauseTimer

Returns void

unpauseTimer

unregisterDestroyCallback

update

Returns void

unregisterDestroyCallback

update

updateAABB

updateAABB

updateAllEffectParameters

updateAllEffectParameters

updateForces

Returns boolean

updateForces

updateFromNetworkSyncData

updateFromNetworkSyncData

updateFromObjectData

updateFromObjectData

updateHitBoxes

updateHitBoxes

updatePreRender

updatePreRender

updateTimers

updateTimers

Properties

angle

angle: number = 0

Static forcesGarbage

forcesGarbage: Force[] = []
+

Returns void

Properties

angle

angle: number = 0

Static forcesGarbage

forcesGarbage: Force[] = []

Global container for unused forces, avoiding recreating forces each tick.

-
static

Static getFirstVariableNumber

getFirstVariableNumber: (array: Variable) => number = ...

Type declaration

Static getFirstVariableNumber

getFirstVariableNumber: (array: Variable) => number = ...

Type declaration

    • Shortcut to get the first value of an array variable as a number.

      -

      Parameters

      Returns number

getFirstVariableNumber

getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

Type declaration

getFirstVariableNumber

getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

Type declaration

    • Shortcut to get the first value of an array variable as a number.

      -

      Parameters

      Returns number

Static getFirstVariableString

getFirstVariableString: (array: Variable) => string = ...

Type declaration

Static getFirstVariableString

getFirstVariableString: (array: Variable) => string = ...

Type declaration

    • Shortcut to get the first value of an array variable as a string.

      -

      Parameters

      Returns string

getFirstVariableString

getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

Type declaration

getFirstVariableString

getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

Type declaration

    • Shortcut to get the first value of an array variable as a string.

      -

      Parameters

      Returns string

Static getLastVariableNumber

getLastVariableNumber: (array: Variable) => number = ...

Type declaration

Static getLastVariableNumber

getLastVariableNumber: (array: Variable) => number = ...

Type declaration

    • Shortcut to get the last value of an array variable as a number.

      -

      Parameters

      Returns number

getLastVariableNumber

getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

Type declaration

getLastVariableNumber

getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

Type declaration

    • Shortcut to get the last value of an array variable as a number.

      -

      Parameters

      Returns number

Static getLastVariableString

getLastVariableString: (array: Variable) => string = ...

Type declaration

Static getLastVariableString

getLastVariableString: (array: Variable) => string = ...

Type declaration

    • Shortcut to get the last value of an array variable as a string.

      -

      Parameters

      Returns string

getLastVariableString

getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

Type declaration

getLastVariableString

getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

Type declaration

    • Shortcut to get the last value of an array variable as a string.

      -

      Parameters

      Returns string

getSqDistanceTo

getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

Type declaration

    • (targetX: number, targetY: number): number
    • +

      Parameters

      Returns string

getSqDistanceTo

getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

Type declaration

    • (targetX: number, targetY: number): number

    • Get the squared distance, in pixels, between the center of this object and a position.

      Parameters

      • targetX: number

        Target X position

      • targetY: number

        Target Y position

        -

      Returns number

getVariableBoolean

getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

Type declaration

    • (variable: Variable, compareWith: boolean): boolean
    • +

    Returns number

getVariableBoolean

getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

Type declaration

    • (variable: Variable, compareWith: boolean): boolean

    • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

      -

      Parameters

      Returns boolean

getVariableChildCount

getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

Type declaration

    • +

      Parameters

      Returns boolean

getVariableChildCount

getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

Type declaration

    • Get the number of children from a variable

      static

      Parameters

      • variable: Variable

        The variable to be accessed

      Returns number

      The number of children

      -

getVariableNumber

getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

Type declaration

getVariableNumber

getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

Type declaration

    • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

      static

      Parameters

      • variable: Variable

        The variable to be accessed

      Returns number

      The value of the specified variable

      -

getVariableString

getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

Type declaration

getVariableString

getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

Type declaration

    • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

      static

      Parameters

      • variable: Variable

        The variable to be accessed

      Returns string

      The string of the specified variable

      -

hidden

hidden: boolean = false

Readonly id

id: number

layer

layer: string = ''

name

name: string

networkId

networkId: null | string = null
+

hidden

hidden: boolean = false

Readonly id

id: number

layer

layer: string = ''

name

name: string

networkId

networkId: null | string = null

A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

-

persistentUuid

persistentUuid: null | string = null
+

persistentUuid

persistentUuid: null | string = null

An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

-

pick

pick: boolean = false
+

pick

pick: boolean = false

A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

-

returnVariable

returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

Type declaration

returnVariable

returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

Type declaration

    • Return the variable passed as argument without any change. Only for usage by events.

      static

      Parameters

      • variable: Variable

        The variable to be accessed

      Returns Variable

      The specified variable

      -

setVariableBoolean

setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

Type declaration

    • (variable: Variable, newValue: boolean): void
    • +

setVariableBoolean

setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

Type declaration

    • (variable: Variable, newValue: boolean): void

    • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

      Parameters

      Returns void

setVariableNumber

setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

Type declaration

    • (variable: Variable, newValue: number): void
    • +

    Returns void

setVariableNumber

setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

Type declaration

    • (variable: Variable, newValue: number): void

    • Shortcut to set the value of a variable considered as a number

      Parameters

      • variable: Variable

        The variable to be changed

      • newValue: number

        The value to be set

        -

      Returns void

setVariableString

setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

Type declaration

    • (variable: Variable, newValue: string): void
    • +

    Returns void

setVariableString

setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

Type declaration

    • (variable: Variable, newValue: string): void

    • Shortcut to set the value of a variable considered as a string

      Parameters

      • variable: Variable

        The variable to be changed

      • newValue: string

        The value to be set

        -

      Returns void

Static supportsReinitialization

supportsReinitialization: boolean = false

toggleVariableBoolean

toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

Type declaration

    • +

    Returns void

Static supportsReinitialization

supportsReinitialization: boolean = false

toggleVariableBoolean

toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

Type declaration

    • Toggles a variable. This shortcut function is needed for events code generation.

      see

      {gdjs.evtTools.common.toggleVariableBoolean}

      -

      Parameters

      Returns void

type

type: string

valuePush

valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

Type declaration

    • (array: Variable, value: string | number | boolean): void
    • +

      Parameters

      Returns void

type

type: string

valuePush

valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

Type declaration

    • (array: Variable, value: string | number | boolean): void

    • This shortcut function is needed for events code generation.

      -

      Parameters

      • array: Variable
      • value: string | number | boolean

      Returns void

variableChildExists

variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

Type declaration

    • (variable: Variable, childName: string): boolean
    • static

      Parameters

      • variable: Variable
        +

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

variableChildExists

variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

Type declaration

    • (variable: Variable, childName: string): boolean
    • static

      Parameters

      • variable: Variable

        The variable to be tested

      • childName: string

        The name of the child

        -

      Returns boolean

variableClearChildren

variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

Type declaration

variableClearChildren

variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

Type declaration

    • static

      Parameters

      • variable: Variable

        The variable to be cleared

        -

      Returns void

variablePushCopy

variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

Type declaration

variablePushCopy

variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

Type declaration

    • This shortcut function is needed for events code generation.

      -

      Parameters

      Returns void

variableRemoveAt

variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

Type declaration

variableRemoveAt

variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

Type declaration

    • This shortcut function is needed for events code generation.

      -

      Parameters

      Returns void

variableRemoveChild

variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

Type declaration

    • (variable: Variable, childName: string): void
    • static

      Parameters

variableRemoveChild

variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

Type declaration

    • (variable: Variable, childName: string): void
    • static

      Parameters

      • variable: Variable

        The variable to be changed

      • childName: string

        The name of the child

        -

      Returns void

x

x: number = 0

y

y: number = 0

zOrder

zOrder: number = 0

Protected aabb

aabb: AABB = ...

Protected hitBoxes

hitBoxes: Polygon[]

Protected hitBoxesDirty

hitBoxesDirty: boolean = true

Static Private getVariableBoolean

getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

Type declaration

    • (variable: Variable, compareWith: boolean): boolean
    • +

    Returns void

x

x: number = 0

y

y: number = 0

zOrder

zOrder: number = 0

Protected aabb

aabb: AABB = ...

Protected hitBoxes

hitBoxes: Polygon[]

Protected hitBoxesDirty

hitBoxesDirty: boolean = true

Static Private getVariableBoolean

getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

Type declaration

    • (variable: Variable, compareWith: boolean): boolean

    • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

      -

      Parameters

      Returns boolean

Static Private setVariableBoolean

setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

Type declaration

    • (variable: Variable, newValue: boolean): void
    • +

      Parameters

      Returns boolean

Static Private setVariableBoolean

setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

Type declaration

    • (variable: Variable, newValue: boolean): void

    • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

      Parameters

      Returns void

Static Private toggleVariableBoolean

toggleVariableBoolean: (variable: Variable) => void = ...

Type declaration

    • +

    Returns void

Static Private toggleVariableBoolean

toggleVariableBoolean: (variable: Variable) => void = ...

Type declaration

    • Toggles a variable. This shortcut function is needed for events code generation.

      see

      {gdjs.evtTools.common.toggleVariableBoolean}

      -

      Parameters

      Returns void

Static Private valuePush

valuePush: (array: Variable, value: string | number | boolean) => void = ...

Type declaration

    • (array: Variable, value: string | number | boolean): void
    • +

      Parameters

      Returns void

Static Private valuePush

valuePush: (array: Variable, value: string | number | boolean) => void = ...

Type declaration

    • (array: Variable, value: string | number | boolean): void

    • This shortcut function is needed for events code generation.

      -

      Parameters

      • array: Variable
      • value: string | number | boolean

      Returns void

Static Private variablePushCopy

variablePushCopy: (array: Variable, variable: Variable) => void = ...

Type declaration

Static Private variablePushCopy

variablePushCopy: (array: Variable, variable: Variable) => void = ...

Type declaration

    • This shortcut function is needed for events code generation.

      -

      Parameters

      Returns void

Static Private variableRemoveAt

variableRemoveAt: (array: Variable, index: number) => void = ...

Type declaration

Static Private variableRemoveAt

variableRemoveAt: (array: Variable, index: number) => void = ...

Type declaration

    • This shortcut function is needed for events code generation.

      -

      Parameters

      Returns void

Constructors

constructor

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomRuntimeObject3DRenderer

The renderer for a gdjs.CustomRuntimeObject3D using Three.js.

-

Hierarchy

  • CustomRuntimeObject3DRenderer

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

ensureUpToDate

  • ensureUpToDate(): void

Hierarchy

  • CustomRuntimeObject3DRenderer

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

ensureUpToDate

  • ensureUpToDate(): void

get3DRendererObject

  • get3DRendererObject(): Object3D<Object3DEventMap>

Static getAnimationFrameTextureManager

  • getAnimationFrameTextureManager(imageManager: PixiImageManager): ThreeAnimationFrameTextureManager

getRendererObject

  • getRendererObject(): null

reinitialize

setLayerIndex

update

  • update(): void

updateAngle

  • updateAngle(): void

updateOpacity

  • updateOpacity(): void

updatePosition

  • updatePosition(): void

updateRotation

  • updateRotation(): void

updateSize

  • updateSize(): void

updateVisibility

  • updateVisibility(): void

updateX

  • updateX(): void

updateY

  • updateY(): void

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomRuntimeObjectInstanceContainer

The instance container of a custom object, containing instances of objects rendered on screen.

see

gdjs.CustomRuntimeObject

-

Hierarchy

Index

Methods

Constructors

Properties

Methods

addLayer

  • addLayer(layerData: LayerData): void

Hierarchy

Index

Methods

Constructors

Properties

Methods

addLayer

  • addLayer(layerData: LayerData): void

addObject

addObject

convertCoords

  • convertCoords(x: number, y: number, result: FloatPoint): FloatPoint

Returns void

convertCoords

  • convertCoords(x: number, y: number, result: FloatPoint): FloatPoint

convertInverseCoords

  • convertInverseCoords(sceneX: number, sceneY: number, result: FloatPoint): FloatPoint

convertInverseCoords

  • convertInverseCoords(sceneX: number, sceneY: number, result: FloatPoint): FloatPoint

createObject

createObject

createObjectsFrom

  • createObjectsFrom(data: InstanceData[], xPos: number, yPos: number, zPos: number, trackByPersistentUuid: boolean): void

createObjectsFrom

  • createObjectsFrom(data: InstanceData[], xPos: number, yPos: number, zPos: number, trackByPersistentUuid: boolean): void

  • Create objects from initial instances data (for example, the initial instances of the scene or the instances of an external layout).

    Parameters

    • data: InstanceData[]
      @@ -30,100 +30,100 @@
    • trackByPersistentUuid: boolean

      If true, objects are tracked by setting their persistentUuid to the same as the associated instance. Useful for hot-reloading when instances are changed.

      -

    Returns void

enableDebugDraw

  • enableDebugDraw(enableDebugDraw: boolean, showHiddenInstances: boolean, showPointsNames: boolean, showCustomPoints: boolean): void

Returns void

enableDebugDraw

  • enableDebugDraw(enableDebugDraw: boolean, showHiddenInstances: boolean, showPointsNames: boolean, showCustomPoints: boolean): void

getAdhocListOfAllInstances

getAdhocListOfAllInstances

getAllLayerNames

  • getAllLayerNames(result: string[]): void

getAllLayerNames

  • getAllLayerNames(result: string[]): void

getDebuggerRenderer

Returns void

getDebuggerRenderer

getElapsedTime

  • getElapsedTime(): number

getElapsedTime

  • getElapsedTime(): number

getGame

getGame

getInitialSharedDataForBehavior

  • getInitialSharedDataForBehavior(name: string): null | BehaviorSharedData

getInitialSharedDataForBehavior

  • getInitialSharedDataForBehavior(name: string): null | BehaviorSharedData

getInstancesCountOnScene

  • getInstancesCountOnScene(objectName: string): number

getInstancesCountOnScene

  • getInstancesCountOnScene(objectName: string): number

getInstancesOf

getInstancesOf

getLayer

getLayer

getObjects

getObjects

getRenderer

getRenderer

getScene

getScene

getViewportHeight

  • getViewportHeight(): number

getViewportOriginX

  • getViewportOriginX(): number

getViewportOriginY

  • getViewportOriginY(): number

getViewportWidth

  • getViewportWidth(): number

hasLayer

  • hasLayer(name: string): boolean

getViewportHeight

  • getViewportHeight(): number

getViewportOriginX

  • getViewportOriginX(): number

getViewportOriginY

  • getViewportOriginY(): number

getViewportWidth

  • getViewportWidth(): number

hasLayer

  • hasLayer(name: string): boolean

isObjectRegistered

  • isObjectRegistered(objectName: string): boolean

Returns boolean

isObjectRegistered

  • isObjectRegistered(objectName: string): boolean

loadFrom

loadFrom

markObjectForDeletion

Returns void

markObjectForDeletion

onChildrenLocationChanged

  • onChildrenLocationChanged(): void

Returns void

onChildrenLocationChanged

  • onChildrenLocationChanged(): void

onDestroyFromScene

onDestroyFromScene

registerObject

  • registerObject(objectData: ObjectData): void

Returns void

registerObject

  • registerObject(objectData: ObjectData): void

removeLayer

  • removeLayer(layerName: string): void

Returns void

removeLayer

  • removeLayer(layerName: string): void

setInitialSharedDataForBehavior

  • setInitialSharedDataForBehavior(name: string, sharedData: null | BehaviorSharedData): void

Returns void

setInitialSharedDataForBehavior

  • setInitialSharedDataForBehavior(name: string, sharedData: null | BehaviorSharedData): void

setLayerIndex

  • setLayerIndex(layerName: string, newIndex: number): void

Returns void

setLayerIndex

  • setLayerIndex(layerName: string, newIndex: number): void

unregisterObject

  • unregisterObject(objectName: string): void

Returns void

unregisterObject

  • unregisterObject(objectName: string): void

updateFrom

Returns void

updateFrom

Returns boolean

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

-

updateObject

  • updateObject(objectData: ObjectData): void

updateObject

  • updateObject(objectData: ObjectData): void

updateObjectsForces

  • updateObjectsForces(): void

Returns void

updateObjectsForces

  • updateObjectsForces(): void

Constructors

constructor

Constructors

constructor

Properties

pathfindingObstaclesManager

pathfindingObstaclesManager: PathfindingObstaclesManager

tileMapCollisionMaskManager

tileMapCollisionMaskManager: TileMapRuntimeManager

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DebuggerPixiRenderer

A renderer for debug instances location of a container using Pixi.js.

see

gdjs.CustomRuntimeObject2DPixiRenderer

-

Hierarchy

  • DebuggerPixiRenderer

Index

Methods

Constructors

Methods

clearDebugDraw

  • clearDebugDraw(): void

getRendererObject

  • getRendererObject(): null | Container<DisplayObject>

renderDebugDraw

  • renderDebugDraw(instances: RuntimeObject[], showHiddenInstances: boolean, showPointsNames: boolean, showCustomPoints: boolean): void

Hierarchy

  • DebuggerPixiRenderer

Index

Methods

Constructors

Methods

clearDebugDraw

  • clearDebugDraw(): void

getRendererObject

  • getRendererObject(): null | Container<DisplayObject>

renderDebugDraw

  • renderDebugDraw(instances: RuntimeObject[], showHiddenInstances: boolean, showPointsNames: boolean, showCustomPoints: boolean): void

  • Render graphics for debugging purpose. Activate this in gdjs.RuntimeScene, in the renderAndStep method.

    see

    gdjs.RuntimeInstanceContainer#enableDebugDraw

    -

    Parameters

    • instances: RuntimeObject[]
    • showHiddenInstances: boolean
    • showPointsNames: boolean
    • showCustomPoints: boolean

    Returns void

Constructors

constructor

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DestroyOutsideRuntimeBehavior

The DestroyOutsideRuntimeBehavior represents a behavior that destroys the object when it leaves the screen.

-

Hierarchy

Index

Methods

Constructors

Properties

Methods

activate

  • activate(enable: boolean): void

Hierarchy

Index

Methods

Constructors

Properties

Methods

activate

  • activate(enable: boolean): void

activated

  • activated(): boolean

Returns void

activated

  • activated(): boolean

doStepPostEvents

doStepPostEvents

doStepPreEvents

doStepPreEvents

enableSynchronization

  • enableSynchronization(enable: boolean): void

getExtraBorder

  • getExtraBorder(): number

Returns void

enableSynchronization

  • enableSynchronization(enable: boolean): void

getExtraBorder

  • getExtraBorder(): number

getName

  • getName(): string

getName

  • getName(): string

getNameId

  • getNameId(): number

getNameId

  • getNameId(): number

getNetworkSyncData

  • getNetworkSyncData(): BehaviorNetworkSyncData

isSyncedOverNetwork

  • isSyncedOverNetwork(): boolean

onActivate

  • onActivate(): void

getNetworkSyncData

  • getNetworkSyncData(): BehaviorNetworkSyncData

isSyncedOverNetwork

  • isSyncedOverNetwork(): boolean

onActivate

  • onActivate(): void

onCreated

  • onCreated(): void

onCreated

  • onCreated(): void

onDeActivate

  • onDeActivate(): void

onDeActivate

  • onDeActivate(): void

onDestroy

  • onDestroy(): 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

onObjectHotReloaded

  • onObjectHotReloaded(): void

setExtraBorder

  • setExtraBorder(val: number): void

setExtraBorder

  • setExtraBorder(val: number): void

stepPostEvents

Returns void

stepPostEvents

stepPreEvents

Returns void

stepPreEvents

updateFromBehaviorData

  • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

Returns void

updateFromBehaviorData

  • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

updateFromNetworkSyncData

  • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

updateFromNetworkSyncData

  • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

usesLifecycleFunction

  • usesLifecycleFunction(): boolean

Returns void

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

Constructors

constructor

Properties

name

name: string

owner

owner: RuntimeObject

type

type: string

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DraggableRuntimeBehavior

The DraggableRuntimeBehavior represents a behavior allowing objects to be moved using the mouse.

-

Hierarchy

Index

Methods

Constructors

Properties

Methods

activate

  • activate(enable: boolean): void

Hierarchy

Index

Methods

Constructors

Properties

Methods

activate

  • activate(enable: boolean): void

activated

  • activated(): boolean

Returns void

activated

  • activated(): boolean

doStepPostEvents

doStepPostEvents

doStepPreEvents

doStepPreEvents

enableSynchronization

  • enableSynchronization(enable: boolean): void

getName

  • getName(): string

enableSynchronization

  • enableSynchronization(enable: boolean): void

getName

  • getName(): string

getNameId

  • getNameId(): number

getNameId

  • getNameId(): number

getNetworkSyncData

  • getNetworkSyncData(): BehaviorNetworkSyncData

isDragged

  • isDragged(): boolean

isSyncedOverNetwork

  • isSyncedOverNetwork(): boolean

onActivate

  • onActivate(): void

getNetworkSyncData

  • getNetworkSyncData(): BehaviorNetworkSyncData

isDragged

  • isDragged(): boolean

isSyncedOverNetwork

  • isSyncedOverNetwork(): boolean

onActivate

  • onActivate(): void

onCreated

  • onCreated(): void

onCreated

  • onCreated(): void

onDeActivate

  • onDeActivate(): void

onDeActivate

  • onDeActivate(): void

onDestroy

  • onDestroy(): void

onDestroy

  • onDestroy(): void

onObjectHotReloaded

  • onObjectHotReloaded(): void

onObjectHotReloaded

  • onObjectHotReloaded(): void

stepPostEvents

stepPostEvents

stepPreEvents

Returns void

stepPreEvents

updateFromBehaviorData

  • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

Returns void

updateFromBehaviorData

  • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

updateFromNetworkSyncData

  • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

updateFromNetworkSyncData

  • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

usesLifecycleFunction

  • usesLifecycleFunction(): boolean

Returns void

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

wasJustDropped

  • wasJustDropped(): boolean

Constructors

constructor

Properties

name

name: string

owner

owner: RuntimeObject

type

type: string

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DummyWithSharedDataRuntimeBehavior

Hierarchy

Index

Methods

Constructors

Properties

Methods

activate

  • activate(enable: boolean): void

activated

  • activated(): boolean

doStepPostEvents

doStepPostEvents

doStepPreEvents

doStepPreEvents

enableSynchronization

  • enableSynchronization(enable: boolean): void

getName

  • getName(): string

enableSynchronization

  • enableSynchronization(enable: boolean): void

getName

  • getName(): string

getNameId

  • getNameId(): number

getNameId

  • getNameId(): number

getNetworkSyncData

  • getNetworkSyncData(): BehaviorNetworkSyncData

isSyncedOverNetwork

  • isSyncedOverNetwork(): boolean

onActivate

  • onActivate(): void

getNetworkSyncData

  • getNetworkSyncData(): BehaviorNetworkSyncData

isSyncedOverNetwork

  • isSyncedOverNetwork(): boolean

onActivate

  • onActivate(): void

onCreated

  • onCreated(): void

onCreated

  • onCreated(): void

onDeActivate

  • onDeActivate(): void

onDeActivate

  • onDeActivate(): void

onDestroy

  • onDestroy(): 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

onObjectHotReloaded

  • onObjectHotReloaded(): void

stepPostEvents

stepPostEvents

stepPreEvents

Returns void

stepPreEvents

updateFromBehaviorData

  • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

Returns void

updateFromBehaviorData

  • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

updateFromNetworkSyncData

  • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

updateFromNetworkSyncData

  • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

usesLifecycleFunction

  • usesLifecycleFunction(): boolean

Returns void

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

Constructors

constructor

Properties

name

name: string

owner

owner: RuntimeObject

type

type: string

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EffectBehavior

A behavior that forwards the EffectBehavior interface to its object.

-

Hierarchy

Implements

Index

Methods

Constructors

Properties

Methods

activate

  • activate(enable: boolean): void

Hierarchy

Implements

Index

Methods

Constructors

Properties

Methods

activate

  • activate(enable: boolean): void

activated

  • activated(): boolean

Returns void

activated

  • activated(): boolean

doStepPostEvents

doStepPostEvents

doStepPreEvents

doStepPreEvents

enableEffect

  • enableEffect(name: string, enable: boolean): void

enableEffect

  • enableEffect(name: string, enable: boolean): void

enableSynchronization

  • enableSynchronization(enable: boolean): void

getName

  • getName(): string

enableSynchronization

  • enableSynchronization(enable: boolean): void

getName

  • getName(): string

getNameId

  • getNameId(): number

getNameId

  • getNameId(): number

getNetworkSyncData

  • getNetworkSyncData(): BehaviorNetworkSyncData

isEffectEnabled

  • isEffectEnabled(name: string): boolean

getNetworkSyncData

  • getNetworkSyncData(): BehaviorNetworkSyncData

isEffectEnabled

  • isEffectEnabled(name: string): boolean

isSyncedOverNetwork

  • isSyncedOverNetwork(): boolean

onActivate

  • onActivate(): void

isSyncedOverNetwork

  • isSyncedOverNetwork(): boolean

onActivate

  • onActivate(): void

onCreated

  • onCreated(): void

onCreated

  • onCreated(): void

onDeActivate

  • onDeActivate(): void

onDeActivate

  • onDeActivate(): void

onDestroy

  • onDestroy(): 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

onObjectHotReloaded

  • onObjectHotReloaded(): void

setEffectBooleanParameter

  • setEffectBooleanParameter(name: string, parameterName: string, value: boolean): boolean

setEffectBooleanParameter

  • setEffectBooleanParameter(name: string, parameterName: string, value: boolean): boolean

setEffectDoubleParameter

  • setEffectDoubleParameter(name: string, parameterName: string, value: number): boolean

setEffectDoubleParameter

  • setEffectDoubleParameter(name: string, parameterName: string, value: number): boolean

setEffectStringParameter

  • setEffectStringParameter(name: string, parameterName: string, value: string): boolean

setEffectStringParameter

  • setEffectStringParameter(name: string, parameterName: string, value: string): boolean

stepPostEvents

stepPostEvents

stepPreEvents

Returns void

stepPreEvents

updateFromBehaviorData

  • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

Returns void

updateFromBehaviorData

  • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

updateFromNetworkSyncData

  • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

updateFromNetworkSyncData

  • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

usesLifecycleFunction

  • usesLifecycleFunction(): boolean

Returns void

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

Constructors

constructor

Properties

name

name: string

owner

owner: RuntimeObject

type

type: string

Private object

object: RuntimeObject & EffectHandler

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FlippableBehavior

A behavior that forwards the Flippable interface to its object.

-

Hierarchy

Implements

Index

Methods

Constructors

Properties

Methods

activate

  • activate(enable: boolean): void

Hierarchy

Implements

Index

Methods

Constructors

Properties

Methods

activate

  • activate(enable: boolean): void

activated

  • activated(): boolean

Returns void

activated

  • activated(): boolean

doStepPostEvents

doStepPostEvents

doStepPreEvents

doStepPreEvents

enableSynchronization

  • enableSynchronization(enable: boolean): void

flipX

  • flipX(enable: boolean): void

flipY

  • flipY(enable: boolean): void

getName

  • getName(): string

enableSynchronization

  • enableSynchronization(enable: boolean): void

flipX

  • flipX(enable: boolean): void

flipY

  • flipY(enable: boolean): void

getName

  • getName(): string

getNameId

  • getNameId(): number

getNameId

  • getNameId(): number

getNetworkSyncData

  • getNetworkSyncData(): BehaviorNetworkSyncData

isFlippedX

  • isFlippedX(): boolean

isFlippedY

  • isFlippedY(): boolean

isSyncedOverNetwork

  • isSyncedOverNetwork(): boolean

onActivate

  • onActivate(): void

getNetworkSyncData

  • getNetworkSyncData(): BehaviorNetworkSyncData

isFlippedX

  • isFlippedX(): boolean

isFlippedY

  • isFlippedY(): boolean

isSyncedOverNetwork

  • isSyncedOverNetwork(): boolean

onActivate

  • onActivate(): void

onCreated

  • onCreated(): void

onCreated

  • onCreated(): void

onDeActivate

  • onDeActivate(): void

onDeActivate

  • onDeActivate(): void

onDestroy

  • onDestroy(): 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

onObjectHotReloaded

  • onObjectHotReloaded(): void

stepPostEvents

stepPostEvents

stepPreEvents

Returns void

stepPreEvents

updateFromBehaviorData

  • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

Returns void

updateFromBehaviorData

  • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

updateFromNetworkSyncData

  • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

updateFromNetworkSyncData

  • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

usesLifecycleFunction

  • usesLifecycleFunction(): boolean

Returns void

usesLifecycleFunction

  • usesLifecycleFunction(): boolean

Constructors

constructor

Properties

name

name: string

owner

owner: RuntimeObject

type

type: string

Private object

object: RuntimeObject & Flippable

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Force

A vector used to move objects.

-

Hierarchy

  • Force

Index

Methods

Constructors

Methods

add

  • add(x: number, y: number): void

addForce

  • addForce(force: Force): void

clear

  • clear(): void

getAngle

  • getAngle(): number

Hierarchy

  • Force

Index

Methods

Constructors

Methods

add

  • add(x: number, y: number): void

addForce

  • addForce(force: Force): void

clear

  • clear(): void

getAngle

  • getAngle(): number

getLength

  • getLength(): number

getLength

  • getLength(): number

getMultiplier

  • getMultiplier(): number

getMultiplier

  • getMultiplier(): number

getNetworkSyncData

  • getNetworkSyncData(): ForceNetworkSyncData

getX

  • getX(): number

getNetworkSyncData

  • getNetworkSyncData(): ForceNetworkSyncData

getX

  • getX(): number

getY

  • getY(): number

getY

  • getY(): number

setAngle

  • setAngle(angle: number): void

setAngle

  • setAngle(angle: number): void

setLength

  • setLength(len: number): void

Returns void

setLength

  • setLength(len: number): void

setMultiplier

  • setMultiplier(multiplier: number): void

Returns void

setMultiplier

  • setMultiplier(multiplier: number): void

setX

  • setX(x: number): void

Returns void

setX

  • setX(x: number): void

  • Set the x component of the force.

    Parameters

    • x: number

      The new X component

      -

    Returns void

setY

  • setY(y: number): void

Returns void

setY

  • setY(y: number): void

  • Set the y component of the force.

    Parameters

    • y: number

      The new Y component

      -

    Returns void

updateFromNetworkSyncData

  • updateFromNetworkSyncData(syncData: ForceNetworkSyncData): void

Constructors

constructor

  • new Force(x: number, y: number, multiplier: number): Force

updateFromNetworkSyncData

  • updateFromNetworkSyncData(syncData: ForceNetworkSyncData): void

Constructors

constructor

  • new Force(x: number, y: number, multiplier: number): Force

Methods

Static deepEqual

  • deepEqual(a: any, b: any): boolean

Static groupByPersistentUuid

  • groupByPersistentUuid<ObjectWithPersistentId>(objectsWithPersistentId: ObjectWithPersistentId[]): Record<string, ObjectWithPersistentId>

  • Type parameters

    • ObjectWithPersistentId: { persistentUuid: null | string }

    Parameters

    • objectsWithPersistentId: ObjectWithPersistentId[]

    Returns Record<string, ObjectWithPersistentId>

hotReload

reloadScriptFiles

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InGameDebugger

Displays uncaught exceptions on top of the game. Could be reworked in the future to support a minimal debugger inside the game.

-

Hierarchy

  • InGameDebugger

Index

Constructors

Methods

Constructors

constructor

Methods

render

  • render(): void

setUncaughtException

  • setUncaughtException(exception: null | Error): void

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InputManager

Store input made on a canvas: mouse position, key pressed and touches states.

-

Hierarchy

  • InputManager

Index

Properties

Methods

Constructors

Properties

Static MOUSE_BACK_BUTTON

MOUSE_BACK_BUTTON: number = 3

Static MOUSE_FORWARD_BUTTON

MOUSE_FORWARD_BUTTON: number = 4

Static MOUSE_LEFT_BUTTON

MOUSE_LEFT_BUTTON: number = 0

Static MOUSE_MIDDLE_BUTTON

MOUSE_MIDDLE_BUTTON: number = 2

Static MOUSE_RIGHT_BUTTON

MOUSE_RIGHT_BUTTON: number = 1

Static MOUSE_TOUCH_ID

MOUSE_TOUCH_ID: number = 1

Methods

anyKeyPressed

  • anyKeyPressed(): boolean

Hierarchy

  • InputManager

Index

Properties

Methods

Constructors

Properties

Static MOUSE_BACK_BUTTON

MOUSE_BACK_BUTTON: number = 3

Static MOUSE_FORWARD_BUTTON

MOUSE_FORWARD_BUTTON: number = 4

Static MOUSE_LEFT_BUTTON

MOUSE_LEFT_BUTTON: number = 0

Static MOUSE_MIDDLE_BUTTON

MOUSE_MIDDLE_BUTTON: number = 2

Static MOUSE_RIGHT_BUTTON

MOUSE_RIGHT_BUTTON: number = 1

Static MOUSE_TOUCH_ID

MOUSE_TOUCH_ID: number = 1

Methods

anyKeyPressed

  • anyKeyPressed(): boolean

anyKeyReleased

  • anyKeyReleased(): boolean

anyKeyReleased

  • anyKeyReleased(): boolean

getAllTouchIdentifiers

  • getAllTouchIdentifiers(): number[]

getAllTouchIdentifiers

  • getAllTouchIdentifiers(): number[]

getCursorX

  • getCursorX(): number

getCursorX

  • getCursorX(): number

  • Get the cursor X position. The cursor is moved by mouse and touch events.

    Returns number

    the cursor X position, relative to the game view.

    -

getCursorY

  • getCursorY(): number

getCursorY

  • getCursorY(): number

  • Get the cursor Y position. The cursor is moved by mouse and touch events.

    Returns number

    the cursor Y position, relative to the game view.

    -

getLastPressedKey

  • getLastPressedKey(): number

getLastPressedKey

  • getLastPressedKey(): number

  • Return the location-aware code of the last key that was pressed.

    Returns number

    The location-aware code of the last key pressed.

    -

getMouseWheelDelta

  • getMouseWheelDelta(): number

getMouseWheelDelta

  • getMouseWheelDelta(): number

getMouseX

  • getMouseX(): number

getMouseX

  • getMouseX(): number

getMouseY

  • getMouseY(): number

getMouseY

  • getMouseY(): number

getStartedTouchIdentifiers

  • getStartedTouchIdentifiers(): number[]

getTouchX

  • getTouchX(publicIdentifier: number): number

getStartedTouchIdentifiers

  • getStartedTouchIdentifiers(): number[]

getTouchX

  • getTouchX(publicIdentifier: number): number

  • Get a touch X position.

    Parameters

    • publicIdentifier: number

    Returns number

    the touch X position, relative to the game view.

    -

getTouchY

  • getTouchY(publicIdentifier: number): number

getTouchY

  • getTouchY(publicIdentifier: number): number

  • Get a touch Y position.

    Parameters

    • publicIdentifier: number

    Returns number

    the touch Y position, relative to the game view.

    -

hasTouchEnded

  • hasTouchEnded(publicIdentifier: number): boolean

hasTouchEnded

  • hasTouchEnded(publicIdentifier: number): boolean

isKeyPressed

  • isKeyPressed(locationAwareKeyCode: number): boolean

isKeyPressed

  • isKeyPressed(locationAwareKeyCode: number): boolean

  • Return true if the key corresponding to the location-aware keyCode is pressed.

    Parameters

    • locationAwareKeyCode: number

      The location-aware key code to be tested.

      -

    Returns boolean

isMouseButtonPressed

  • isMouseButtonPressed(buttonCode: number): boolean

Returns boolean

isMouseButtonPressed

  • isMouseButtonPressed(buttonCode: number): boolean

  • Return true if the mouse button corresponding to buttonCode is pressed.

    Parameters

    • buttonCode: number

      The mouse button code (0: Left button, 1: Right button).

      -

    Returns boolean

isMouseButtonReleased

  • isMouseButtonReleased(buttonCode: number): boolean

Returns boolean

isMouseButtonReleased

  • isMouseButtonReleased(buttonCode: number): boolean

  • Return true if the mouse button corresponding to buttonCode was just released.

    Parameters

    • buttonCode: number

      The mouse button code (0: Left button, 1: Right button).

      -

    Returns boolean

isMouseInsideCanvas

  • isMouseInsideCanvas(): boolean

isScrollingDown

  • isScrollingDown(): boolean

Returns boolean

isMouseInsideCanvas

  • isMouseInsideCanvas(): boolean

isScrollingDown

  • isScrollingDown(): boolean

isScrollingUp

  • isScrollingUp(): boolean

isScrollingUp

  • isScrollingUp(): boolean

isSimulatingMouseWithTouch

  • isSimulatingMouseWithTouch(): boolean

onFrameEnded

  • onFrameEnded(): void

isSimulatingMouseWithTouch

  • isSimulatingMouseWithTouch(): boolean

onFrameEnded

  • onFrameEnded(): void

  • Notify the input manager that the frame ended, so anything that last only for one frame (started/ended touches) should be reset.

    This method should be called in the game loop (see gdjs.RuntimeGame.startGameLoop). You don't need to call it otherwise.

    -

    Returns void

onKeyPressed

  • onKeyPressed(keyCode: number, location?: number): void

onKeyPressed

  • onKeyPressed(keyCode: number, location?: number): void

  • Should be called whenever a key is pressed. The location corresponds to KeyboardEvent.location, which should be 0 for standard keys, 1 for left keys, 2 for right keys, and 3 for numpad keys.

    @@ -68,7 +68,7 @@

    The raw key code associated to the key press.

  • Optional location: number

    The location of the event.

    -

Returns void

onKeyReleased

  • onKeyReleased(keyCode: number, location?: number): void

Returns void

onKeyReleased

  • onKeyReleased(keyCode: number, location?: number): void

  • Should be called whenever a key is released. The location corresponds to KeyboardEvent.location, which should be 0 for standard keys, 1 for left keys, 2 for right keys, and 3 for numpad keys.

    @@ -76,47 +76,47 @@

    The raw key code associated to the key release.

  • Optional location: number

    The location of the event.

    -

Returns void

onMouseButtonPressed

  • onMouseButtonPressed(buttonCode: number): void

Returns void

onMouseButtonPressed

  • onMouseButtonPressed(buttonCode: number): void

  • Should be called whenever a mouse button is pressed.

    Parameters

    • buttonCode: number

      The mouse button code associated to the event. See InputManager.MOUSE_LEFT_BUTTON, InputManager.MOUSE_RIGHT_BUTTON, InputManager.MOUSE_MIDDLE_BUTTON

      -

    Returns void

onMouseButtonReleased

  • onMouseButtonReleased(buttonCode: number): void

Returns void

onMouseButtonReleased

  • onMouseButtonReleased(buttonCode: number): void

  • Should be called whenever a mouse button is released.

    Parameters

    • buttonCode: number

      The mouse button code associated to the event. (see onMouseButtonPressed)

      -

    Returns void

onMouseEnter

  • onMouseEnter(): void

Returns void

onMouseEnter

  • onMouseEnter(): void

onMouseLeave

  • onMouseLeave(): void

onMouseLeave

  • onMouseLeave(): void

onMouseMove

  • onMouseMove(x: number, y: number): void

onMouseMove

  • onMouseMove(x: number, y: number): void

  • Should be called when the mouse is moved.

    Please note that the coordinates must be expressed relative to the view position.

    Parameters

    • x: number

      The mouse new X position

    • y: number

      The mouse new Y position

      -

    Returns void

onMouseWheel

  • onMouseWheel(wheelDelta: number): void

Returns void

onMouseWheel

  • onMouseWheel(wheelDelta: number): void

onTouchCancel

  • onTouchCancel(rawIdentifier: number): void

onTouchEnd

  • onTouchEnd(rawIdentifier: number): void

onTouchMove

  • onTouchMove(rawIdentifier: number, x: number, y: number): void

onTouchStart

  • onTouchStart(rawIdentifier: number, x: number, y: number): void

popEndedTouch

  • popEndedTouch(): undefined | number

popStartedTouch

  • popStartedTouch(): undefined | number

touchSimulateMouse

  • touchSimulateMouse(enable: boolean): void

Returns void

onTouchCancel

  • onTouchCancel(rawIdentifier: number): void

onTouchEnd

  • onTouchEnd(rawIdentifier: number): void

onTouchMove

  • onTouchMove(rawIdentifier: number, x: number, y: number): void

onTouchStart

  • onTouchStart(rawIdentifier: number, x: number, y: number): void

popEndedTouch

  • popEndedTouch(): undefined | number

popStartedTouch

  • popStartedTouch(): undefined | number

touchSimulateMouse

  • touchSimulateMouse(enable: boolean): void

  • Set if touch events should simulate mouse events.

    If true, any touch will move the mouse position and set mouse buttons as pressed/released.

    Parameters

    • enable: boolean

      true to simulate mouse events, false to disable it.

      -

    Returns void

wasKeyReleased

  • wasKeyReleased(locationAwareKeyCode: number): boolean

Returns void

wasKeyReleased

  • wasKeyReleased(locationAwareKeyCode: number): boolean

  • Return true if the key corresponding to the location-aware keyCode was released during the last frame.

    Parameters

    • locationAwareKeyCode: number

      The location-aware key code to be tested.

      -

    Returns boolean

Private getPublicTouchIdentifier

  • getPublicTouchIdentifier(rawIdentifier: number): number

Returns boolean

Private getPublicTouchIdentifier

  • getPublicTouchIdentifier(rawIdentifier: number): number

  • Add 2 to the identifier to avoid identifiers taking the GDevelop default variable value which is 0 and reserve 1 for the mouse.

    Parameters

    • rawIdentifier: number

      The identifier given by the browser.

    Returns number

    The identifier used in events.

    -

Constructors

constructor

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Inventory

Hierarchy

  • Inventory

Index

Methods

Constructors

Methods

add

  • add(itemName: any): boolean

clear

  • clear(): void

count

  • count(itemName: any): any

equip

  • equip(itemName: any, equip: any): boolean

getAllItems

  • getAllItems(): any

has

  • has(itemName: any): boolean

isEquipped

  • isEquipped(itemName: any): boolean

isFull

  • isFull(itemName: any): boolean

maximum

  • maximum(itemName: any): any

remove

  • remove(itemName: any): boolean

setCount

  • setCount(itemName: any, count: any): void

setMaximum

  • setMaximum(itemName: any, maxCount: any): void

setUnlimited

  • setUnlimited(itemName: any, enable: any): void

Constructors

constructor

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Inventory

Hierarchy

  • Inventory

Index

Methods

Constructors

Methods

add

  • add(itemName: any): boolean

clear

  • clear(): void

count

  • count(itemName: any): any

equip

  • equip(itemName: any, equip: any): boolean

getAllItems

  • getAllItems(): any

has

  • has(itemName: any): boolean

isEquipped

  • isEquipped(itemName: any): boolean

isFull

  • isFull(itemName: any): boolean

maximum

  • maximum(itemName: any): any

remove

  • remove(itemName: any): boolean

setCount

  • setCount(itemName: any, count: any): void

setMaximum

  • setMaximum(itemName: any, maxCount: any): void

setUnlimited

  • setUnlimited(itemName: any, enable: any): void

Constructors

constructor

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InventoryManager

Hierarchy

  • InventoryManager

Index

Constructors

Methods

Constructors

constructor

Methods

Static get

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InventoryManager

Hierarchy

  • InventoryManager

Index

Constructors

Methods

Constructors

constructor

Methods

Static get

Generated using TypeDoc

Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Layer

Represents a layer of a scene, used to display objects.

-

Hierarchy

Index

Methods

Constructors

Methods

addEffect

  • addEffect(effectData: EffectData): void

Hierarchy

Index

Methods

Constructors

Methods

addEffect

  • addEffect(effectData: EffectData): void

applyLayerInverseTransformation

  • applyLayerInverseTransformation(x: number, y: number, cameraId: number, result: FloatPoint): FloatPoint

Returns void

applyLayerInverseTransformation

  • applyLayerInverseTransformation(x: number, y: number, cameraId: number, result: FloatPoint): FloatPoint

  • Return an array containing the coordinates of the point passed as parameter in layer local coordinates (as opposed to the parent coordinates).

    All transformations (scale, rotation) are supported.

    @@ -15,7 +15,7 @@

    The Y position of the point, in parent coordinates.

  • cameraId: number
  • result: FloatPoint

    Array that will be updated with the result

    -

Returns FloatPoint

applyLayerTransformation

  • applyLayerTransformation(x: number, y: number, cameraId: number, result: FloatPoint): FloatPoint

Returns FloatPoint

applyLayerTransformation

  • applyLayerTransformation(x: number, y: number, cameraId: number, result: FloatPoint): FloatPoint

  • Return an array containing the coordinates of the point passed as parameter in parent coordinate coordinates (as opposed to the layer local coordinates).

    All transformations (scale, rotation) are supported.

    @@ -27,7 +27,7 @@
  • cameraId: number
  • result: FloatPoint

    Array that will be updated with the result (x and y position of the point in parent coordinates).

    -

Returns FloatPoint

convertCoords

  • convertCoords(x: number, y: number, cameraId?: number, result: FloatPoint): FloatPoint

Returns FloatPoint

convertCoords

  • convertCoords(x: number, y: number, cameraId?: number, result: FloatPoint): FloatPoint

  • Convert a point from the canvas coordinates (for example, the mouse position) to the container coordinates.

    This method handles 3D rotations.

    @@ -39,7 +39,7 @@

    The camera number. Currently ignored.

  • result: FloatPoint

    The point instance that is used to return the result.

    -

Returns FloatPoint

convertInverseCoords

  • convertInverseCoords(x: number, y: number, cameraId?: number, result: FloatPoint): FloatPoint

Returns FloatPoint

convertInverseCoords

  • convertInverseCoords(x: number, y: number, cameraId?: number, result: FloatPoint): FloatPoint

  • Convert a point from the container coordinates (for example, an object position) to the canvas coordinates.

    This method doesn't handle 3D rotations.

    @@ -51,122 +51,122 @@

    The camera number. Currently ignored.

  • result: FloatPoint

    The point instance that is used to return the result.

    -

Returns FloatPoint

enableEffect

  • enableEffect(name: string, enable: boolean): void

Returns FloatPoint

enableEffect

  • enableEffect(name: string, enable: boolean): void

followBaseLayer

  • followBaseLayer(): void

Returns void

followBaseLayer

  • followBaseLayer(): void

get3DRendererObject

  • get3DRendererObject(): null | Scene

getCameraHeight

  • getCameraHeight(cameraId?: number): number

get3DRendererObject

  • get3DRendererObject(): null | Scene

getCameraHeight

  • getCameraHeight(cameraId?: number): number

  • Get the camera height (which can be different than the game resolution height if the camera is zoomed).

    Parameters

    • Optional cameraId: number

      The camera number. Currently ignored.

    Returns number

    The height of the camera

    -

getCameraRotation

  • getCameraRotation(cameraId?: number): number

getCameraRotation

  • getCameraRotation(cameraId?: number): number

getCameraType

getCameraWidth

  • getCameraWidth(cameraId?: number): number

getCameraType

getCameraWidth

  • getCameraWidth(cameraId?: number): number

  • Get the camera width (which can be different than the game resolution width if the camera is zoomed).

    Parameters

    • Optional cameraId: number

      The camera number. Currently ignored.

    Returns number

    The width of the camera

    -

getCameraX

  • getCameraX(cameraId?: number): number

getCameraX

  • getCameraX(cameraId?: number): number

getCameraY

  • getCameraY(cameraId?: number): number

getCameraY

  • getCameraY(cameraId?: number): number

getCameraZ

  • getCameraZ(fov: null | number, cameraId?: number): number

getCameraZ

  • getCameraZ(fov: null | number, cameraId?: number): number

  • Get the camera center Z position.

    Parameters

    • fov: null | number

      The field of view.

    • Optional cameraId: number

      The camera number. Currently ignored.

    Returns number

    The z position of the camera

    -

getCameraZoom

  • getCameraZoom(cameraId?: number): number

getCameraZoom

  • getCameraZoom(cameraId?: number): number

getClearColor

  • getClearColor(): number[]

getClearColor

  • getClearColor(): number[]

getDefaultZOrder

  • getDefaultZOrder(): number

getDefaultZOrder

  • getDefaultZOrder(): number

getElapsedTime

getElapsedTime

getHeight

  • getHeight(): number

getInitialCamera3DFarPlaneDistance

  • getInitialCamera3DFarPlaneDistance(): number

getInitialCamera3DFieldOfView

  • getInitialCamera3DFieldOfView(): number

getInitialCamera3DNearPlaneDistance

  • getInitialCamera3DNearPlaneDistance(): number

getInitialEffectsData

  • getInitialEffectsData(): EffectData[]

Returns number

getHeight

  • getHeight(): number

getInitialCamera3DFarPlaneDistance

  • getInitialCamera3DFarPlaneDistance(): number

getInitialCamera3DFieldOfView

  • getInitialCamera3DFieldOfView(): number

getInitialCamera3DNearPlaneDistance

  • getInitialCamera3DNearPlaneDistance(): number

getInitialEffectsData

  • getInitialEffectsData(): EffectData[]

getName

  • getName(): string

getName

  • getName(): string

getRenderer

getRendererEffects

  • getRendererEffects(): Record<string, Filter>

getRenderer

getRendererEffects

  • getRendererEffects(): Record<string, Filter>

getRendererObject

  • getRendererObject(): Container<DisplayObject>

getRenderingType

getRuntimeScene

getRendererObject

  • getRendererObject(): Container<DisplayObject>

getRenderingType

getRuntimeScene

getTimeScale

  • getTimeScale(): number

getTimeScale

  • getTimeScale(): number

getWidth

  • getWidth(): number

hasEffect

  • hasEffect(name: string): boolean

getWidth

  • getWidth(): number

hasEffect

  • hasEffect(name: string): boolean

isEffectEnabled

  • isEffectEnabled(name: string): boolean

isEffectEnabled

  • isEffectEnabled(name: string): boolean

isLightingLayer

  • isLightingLayer(): boolean

isLightingLayer

  • isLightingLayer(): boolean

isVisible

  • isVisible(): boolean

isVisible

  • isVisible(): boolean

onGameResolutionResized

  • onGameResolutionResized(oldGameResolutionOriginX: number, oldGameResolutionOriginY: number): void

onGameResolutionResized

  • onGameResolutionResized(oldGameResolutionOriginX: number, oldGameResolutionOriginY: number): void

removeEffect

  • removeEffect(effectName: string): void

removeEffect

  • removeEffect(effectName: string): void

setCameraRotation

  • setCameraRotation(rotation: number, cameraId?: number): void

Returns void

setCameraRotation

  • setCameraRotation(rotation: number, cameraId?: number): void

  • Set the rotation of the camera, expressed in degrees. The rotation is made around the camera center.

    Parameters

    • rotation: number

      The new rotation, in degrees.

    • Optional cameraId: number

      The camera number. Currently ignored.

      -

    Returns void

setCameraX

  • setCameraX(x: number, cameraId?: number): void

Returns void

setCameraX

  • setCameraX(x: number, cameraId?: number): void

setCameraY

  • setCameraY(y: number, cameraId?: number): void

Returns void

setCameraY

  • setCameraY(y: number, cameraId?: number): void

setCameraZ

  • setCameraZ(z: number, fov: null | number, cameraId?: number): void

Returns void

setCameraZ

  • setCameraZ(z: number, fov: null | number, cameraId?: number): void

  • Set the camera center Z position.

    Parameters

    • z: number

      The new y position.

      @@ -174,13 +174,13 @@

      The field of view.

    • Optional cameraId: number

      The camera number. Currently ignored.

      -

    Returns void

setCameraZoom

  • setCameraZoom(newZoom: number, cameraId?: number): void

Returns void

setCameraZoom

  • setCameraZoom(newZoom: number, cameraId?: number): void

  • Set the zoom of a camera.

    Parameters

    • newZoom: number

      The new zoom. Must be superior to 0. 1 is the default zoom.

    • Optional cameraId: number

      The camera number. Currently ignored.

      -

    Returns void

setClearColor

  • setClearColor(r: number, g: number, b: number): void

Returns void

setClearColor

  • setClearColor(r: number, g: number, b: number): void

  • Set the clear color in format [r, g, b], with components in the range of 0 to 1.;

    Parameters

    • r: number

      Red color component in the range 0-255.

      @@ -188,11 +188,11 @@

      Green color component in the range 0-255.

    • b: number

      Blue color component in the range 0-255.

      -

    Returns void

setDefaultZOrder

  • setDefaultZOrder(defaultZOrder: number): void

Returns void

setDefaultZOrder

  • setDefaultZOrder(defaultZOrder: number): void

setEffectBooleanParameter

  • setEffectBooleanParameter(name: string, parameterName: string, value: boolean): void

Returns void

setEffectBooleanParameter

  • setEffectBooleanParameter(name: string, parameterName: string, value: boolean): void

setEffectDoubleParameter

  • setEffectDoubleParameter(name: string, parameterName: string, value: number): void

Returns void

setEffectDoubleParameter

  • setEffectDoubleParameter(name: string, parameterName: string, value: number): void

setEffectStringParameter

  • setEffectStringParameter(name: string, parameterName: string, value: string): void

Returns void

setEffectStringParameter

  • setEffectStringParameter(name: string, parameterName: string, value: string): void

setFollowBaseLayerCamera

  • setFollowBaseLayerCamera(follow: boolean): void

Returns void

setFollowBaseLayerCamera

  • setFollowBaseLayerCamera(follow: boolean): void

setTimeScale

  • setTimeScale(timeScale: number): void

setTimeScale

  • setTimeScale(timeScale: number): void

show

  • show(enable: boolean): void

Returns void

show

  • show(enable: boolean): void

updatePreRender

Returns void

updatePreRender

Constructors

constructor

Constructors

constructor

changeRendererObjectZOrder

  • changeRendererObjectZOrder(pixiChild: any, newZOrder: number): void

getLightingSprite

  • getLightingSprite(): null | Sprite

Returns void

getLightingSprite

  • getLightingSprite(): null | Sprite

getRendererObject

  • getRendererObject(): Container<DisplayObject>

getThreeCamera

  • getThreeCamera(): null | PerspectiveCamera | OrthographicCamera

getThreeEffectComposer

  • getThreeEffectComposer(): null | EffectComposer

getThreeScene

  • getThreeScene(): null | Scene

has2DObjects

  • has2DObjects(): boolean

has3DObjects

  • has3DObjects(): boolean

hasPostProcessingPass

  • hasPostProcessingPass(): boolean

isCameraRotatedIn3D

  • isCameraRotatedIn3D(): null | boolean

onCreated

  • onCreated(): void

onGameResolutionResized

  • onGameResolutionResized(): void

remove3DRendererObject

  • remove3DRendererObject(object: Object3D<Object3DEventMap>): void

removePostProcessingPass

  • removePostProcessingPass(pass: Pass): void

removeRendererObject

  • removeRendererObject(child: any): void

getRendererObject

  • getRendererObject(): Container<DisplayObject>

getThreeCamera

  • getThreeCamera(): null | PerspectiveCamera | OrthographicCamera

getThreeEffectComposer

  • getThreeEffectComposer(): null | EffectComposer

getThreeScene

  • getThreeScene(): null | Scene

has2DObjects

  • has2DObjects(): boolean

has3DObjects

  • has3DObjects(): boolean

hasPostProcessingPass

  • hasPostProcessingPass(): boolean

isCameraRotatedIn3D

  • isCameraRotatedIn3D(): null | boolean

onCreated

  • onCreated(): void

onGameResolutionResized

  • onGameResolutionResized(): void

remove3DRendererObject

  • remove3DRendererObject(object: Object3D<Object3DEventMap>): void

removePostProcessingPass

  • removePostProcessingPass(pass: Pass): void

removeRendererObject

  • removeRendererObject(child: any): void

renderOnPixiRenderTexture

  • renderOnPixiRenderTexture(pixiRenderer: Renderer): void

Returns void

renderOnPixiRenderTexture

  • renderOnPixiRenderTexture(pixiRenderer: Renderer): void

  • Render the layer of the PixiJS RenderTexture, so that it can be then displayed with a blend mode (for a lighting layer) or consumed by Three.js (for 2D+3D layers).

    -

    Parameters

    • pixiRenderer: Renderer

    Returns void

setThreeCameraDirty

  • setThreeCameraDirty(enable: boolean): void

show2DRenderingPlane

  • show2DRenderingPlane(enable: boolean): void

transformTo3DWorld

  • transformTo3DWorld(screenX: number, screenY: number, worldZ: number, cameraId: number, result: FloatPoint): FloatPoint

updateClearColor

  • updateClearColor(): void

updatePosition

  • updatePosition(): void

setThreeCameraDirty

  • setThreeCameraDirty(enable: boolean): void

show2DRenderingPlane

  • show2DRenderingPlane(enable: boolean): void

transformTo3DWorld

  • transformTo3DWorld(screenX: number, screenY: number, worldZ: number, cameraId: number, result: FloatPoint): FloatPoint

updateClearColor

  • updateClearColor(): void

updatePosition

  • updatePosition(): void

updatePreRender

  • updatePreRender(): void

updateResolution

  • updateResolution(): void

updateThreePlaneTextureFromPixiRenderTexture

  • updateThreePlaneTextureFromPixiRenderTexture(threeRenderer: WebGLRenderer, pixiRenderer: Renderer): void

updatePreRender

  • updatePreRender(): void

updateResolution

  • updateResolution(): void

updateThreePlaneTextureFromPixiRenderTexture

  • updateThreePlaneTextureFromPixiRenderTexture(threeRenderer: WebGLRenderer, pixiRenderer: Renderer): void

  • Set the texture of the 2D plane in the 3D world to be the same WebGL texture as the PixiJS RenderTexture - so that the 2D rendering can be shown in the 3D world.

    -

    Parameters

    • threeRenderer: WebGLRenderer
    • pixiRenderer: Renderer

    Returns void

updateVisibility

  • updateVisibility(visible: boolean): void

Constructors

constructor

updateVisibility

  • updateVisibility(visible: boolean): void

Constructors

constructor

Properties

Static Private vectorForProjections

vectorForProjections: null | Vector3 = null

Static Private Readonly zeroZOrderForPixi

zeroZOrderForPixi: number = ...
+
  • runtimeGameRenderer: RuntimeGamePixiRenderer

    • Returns LayerPixiRenderer

    Properties

    Static Private vectorForProjections

    vectorForProjections: null | Vector3 = null

    Static Private Readonly zeroZOrderForPixi

    zeroZOrderForPixi: number = ...

    Pixi doesn't sort children with zIndex == 0.

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class LightObstacleRuntimeBehavior

    Hierarchy

    Index

    Methods

    Constructors

    Properties

    Methods

    activate

    • activate(enable: boolean): void

    activated

    • activated(): boolean

    doStepPostEvents

    doStepPostEvents

    doStepPreEvents

    Returns void

    doStepPreEvents

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getName

    • getName(): string

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    onDeActivate

    • onDeActivate(): void

    onDeActivate

    • onDeActivate(): void

    onDestroy

    • onDestroy(): 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

    onObjectHotReloaded

    • onObjectHotReloaded(): void

    stepPostEvents

    stepPostEvents

    stepPreEvents

    Returns void

    stepPreEvents

    updateFromBehaviorData

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

    Returns void

    updateFromBehaviorData

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

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    Returns void

    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

    Constructors

    constructor

    Properties

    currentRBushAABB

    currentRBushAABB: null | BehaviorRBushAABB<LightObstacleRuntimeBehavior> = null

    name

    name: string

    owner

    owner: RuntimeObject

    type

    type: string

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class LightObstaclesManager

    Hierarchy

    • LightObstaclesManager

    Index

    Methods

    Constructors

    Methods

    addObstacle

    Static getManager

    removeObstacle

    removeObstacle

    Constructors

    constructor

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class LightRuntimeObject

    Displays a Light object.

    -

    Hierarchy

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    Hierarchy

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    addEffect

    • addEffect(effectData: EffectData): boolean

    Returns void

    addEffect

    • addEffect(effectData: EffectData): boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    Returns boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    • Add a force to the object to move it.

      Parameters

      • x: number

        The x coordinates of the force

        @@ -18,7 +18,7 @@

        The y coordinates of the force

      • multiplier: number

        Set the force multiplier

        -

      Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    Returns void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    Returns void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    • Create the behavior described by the given BehaviorData

      Parameters

      • behaviorData: BehaviorData

        The data to be used to construct the behavior.

      Returns boolean

      true if the behavior was properly created, false otherwise.

      -

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns boolean

    true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

    -

    behaviorActivated

    • behaviorActivated(name: string): boolean

    behaviorActivated

    • behaviorActivated(name: string): boolean

    clearEffects

    • clearEffects(): boolean

    clearEffects

    • clearEffects(): boolean

    clearForces

    • clearForces(): void

    clearForces

    • clearForces(): void

    Static collisionTest

    Static collisionTest

    • Return true if the hitboxes of two objects are overlapping

      static

      Parameters

      • obj1: RuntimeObject

        The first runtimeObject

        @@ -78,70 +78,70 @@
      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if obj1 and obj2 are in collision

      -

    cursorOnObject

    cursorOnObject

    deleteFromScene

    deleteFromScene

    Static distanceTest

    Returns void

    Static distanceTest

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    Returns void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    Returns void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    • Get the AABB (axis aligned bounding box) for the object.

      The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

      You should probably redefine updateAABB instead of this function.

      Returns AABB

      The bounding box

      -

    getAABBBottom

    • getAABBBottom(): number

    getAABBBottom

    • getAABBBottom(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBRight

    • getAABBRight(): number

    getAABBRight

    • getAABBRight(): number

    getAABBTop

    • getAABBTop(): number

    getAABBTop

    • getAABBTop(): number

    getAngle

    • getAngle(): number

    getAngle

    • getAngle(): number

    getAngleToObject

    getAngleToObject

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    Returns number

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    getAverageForce

    Returns number

    getAverageForce

    getBehavior

    getBehavior

    • Get a behavior from its name. If the behavior does not exists, undefined is returned.

      Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -149,59 +149,59 @@

      Parameters

      • name: string

        The behavior name.

      Returns null | RuntimeBehavior

      The behavior with the given name, or undefined.

      -

    getCenterX

    • getCenterX(): number

    getCenterX

    • getCenterX(): number

    • Return the X position of the object center, relative to the object X position (getDrawableX). Use getCenterXInScene to get the position of the center in the scene.

      Returns number

      the X position of the object center, relative to getDrawableX().

      -

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterY

    • getCenterY(): number

    getCenterY

    • getCenterY(): number

    • Return the Y position of the object center, relative to the object position (getDrawableY). Use getCenterYInScene to get the position of the center in the scene.

      Returns number

      the Y position of the object center, relative to getDrawableY().

      -

    getCenterYInScene

    • getCenterYInScene(): number

    getCenterYInScene

    • getCenterYInScene(): number

    getColor

    • getColor(): string

    getColor

    • getColor(): string

    getDebugMode

    • getDebugMode(): boolean

    getDebugMode

    • getDebugMode(): boolean

    getDistanceToObject

    getDistanceToObject

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    getDrawableX

    • getDrawableX(): number

    Returns number

    getDrawableX

    • getDrawableX(): number

    getDrawableY

    • getDrawableY(): number

    getDrawableY

    • getDrawableY(): number

    getElapsedTime

    getElapsedTime

    getHeight

    • getHeight(): number

    Returns number

    getHeight

    • getHeight(): number

    getHitBoxes

    getHitBoxes

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    • Return at least all the hit boxes that overlap a given area.

      The hit boxes don't need to actually overlap the area, (i.e: it's correct to return more hit boxes than those in the specified area) @@ -226,176 +226,176 @@

    • bottom: number

      bound of the area in scene coordinates

    Returns Iterable<Polygon>

    at least all the hit boxes that overlap a given area.

    -

    getInstanceContainer

    getInstanceContainer

    getLayer

    • getLayer(): string

    getLayer

    • getLayer(): string

    getName

    • getName(): string

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    • Get the identifier associated to an object name. Some features may want to compare objects name a large number of time. In this case, it may be more efficient to compare objects name identifiers.

      -
      static

      Parameters

      • name: string

      Returns number

    getNetworkSyncData

    getNetworkSyncData

    getObstaclesManager

    getObstaclesManager

    getParent

    getParent

    getRadius

    • getRadius(): number

    getRadius

    • getRadius(): number

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererObject

    • getRendererObject(): null | Container<DisplayObject> | Mesh<MeshMaterial>

    getRuntimeScene

    getRendererObject

    • getRendererObject(): null | Container<DisplayObject> | Mesh<MeshMaterial>

    getRuntimeScene

    getSqDistanceToObject

    getSqDistanceToObject

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    getTexture

    • getTexture(): string

    Returns number

    getTexture

    • getTexture(): string

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    • Get a timer elapsed time.

      This is used by expressions to return 0 when a timer doesn't exist because numeric expressions must always return a number.

      Parameters

      • timerName: string

        The timer name.

      Returns number

      The timer elapsed time in seconds, 0 if the timer doesn't exist.

      -

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getUniqueId

    • getUniqueId(): number

    getUniqueId

    • getUniqueId(): number

    • Get the unique identifier of the object.
      The identifier is set by the runtimeScene owning the object.
      You can also use the id property (this._object.id) for increased efficiency instead of calling this method.

      Returns number

      The object identifier

      -

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableString

    • getVariableString(variable: Variable): string

    Static getVariableString

    • getVariableString(variable: Variable): string

    getVariables

    getVariables

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    • Get the AABB (axis aligned bounding box) to be used to determine if the object is visible on screen. The gdjs.RuntimeScene will hide the renderer object if the object is not visible on screen ("culling").

      The default implementation uses the AABB returned by getAABB.

      If null is returned, the object is assumed to be always visible.

      Returns null | AABB

      The bounding box or null.

      -

    getWidth

    • getWidth(): number

    getWidth

    • getWidth(): number

    getX

    • getX(): number

    getX

    • getX(): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    • Compute the X position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getY

    • getY(): number

    Returns number

    getY

    • getY(): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    • Compute the Y position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getZOrder

    • getZOrder(): number

    Returns number

    getZOrder

    • getZOrder(): number

    hasBehavior

    • hasBehavior(name: string): boolean

    hasBehavior

    • hasBehavior(name: string): boolean

    hasEffect

    • hasEffect(name: string): boolean

    Returns boolean

    hasEffect

    • hasEffect(name: string): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hasVariable

    • hasVariable(name: string): boolean

    Static hexToRGBColor

    • hexToRGBColor(hex: any): number[]

    hide

    • hide(enable: boolean): void

    Static hexToRGBColor

    • hexToRGBColor(hex: any): number[]

    hide

    • hide(enable: boolean): void

    insideObject

    • insideObject(x: number, y: number): boolean

    Returns void

    insideObject

    • insideObject(x: number, y: number): boolean

    • Return true if the specified position is inside object bounding box.

      The position should be in "world" coordinates, i.e use gdjs.Layer.convertCoords if you need to pass the mouse or a touch position that you get from gdjs.InputManager. To check if a point is inside the object collision mask, you can use isCollidingWithPoint instead.

      -

      Parameters

      • x: number
      • y: number

      Returns boolean

    invalidateHitboxes

    • invalidateHitboxes(): void

    invalidateHitboxes

    • invalidateHitboxes(): void

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isHidden

    • isHidden(): boolean

    isHidden

    • isHidden(): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    • Return true if the angle of the total force applied on the object is in a given range.

      Parameters

      • angle: number
        @@ -404,43 +404,43 @@

        The maximum distance from the given angle.

      Returns boolean

      true if the difference between the force angle the given angle is less or equals the toleranceInDegrees.

      -

    isVisible

    • isVisible(): boolean

    isVisible

    • isVisible(): boolean

    • Return true if the object is not hidden.

      Note: This is unrelated to the actual visibility of the object on the screen. For this, see getVisibilityAABB to get the bounding boxes of the object as displayed on the scene.

      Returns boolean

      true if the object is not hidden.

      -

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    • To be called by the child classes in their constructor, at the very end. Notify the behaviors that they have been constructed (this must be done when the object is ready, otherwise behaviors can do operations on the object which could be not initialized yet).

      If you redefine this function, make sure to call the original method (RuntimeObject.prototype.onCreated.call(this);).

      -

      Returns void

    onDeletedFromScene

    onDeletedFromScene

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    Returns void

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    onSceneResumed

    Returns void

    onSceneResumed

    pauseTimer

    • pauseTimer(timerName: string): void

    Returns void

    pauseTimer

    • pauseTimer(timerName: string): void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    Returns void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    • Put the object around a position, with a specific distance and angle. The distance and angle are computed between the position and the center of the object.

      Parameters

      • x: number
        @@ -451,7 +451,7 @@

        The distance between the object and the target, in pixels.

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    • Put the object around another object, with a specific distance and angle. The distance and angle are computed between the centers of the objects.

      Parameters

      • obj: null | RuntimeObject
        @@ -460,7 +460,7 @@

        The distance between the object and the target

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    • Called to reset the object to its default state. This is used for objects that are "recycled": they are dismissed (at which point onDestroyFromScene is called) but still stored in a cache to be reused next time an object must be created. At this point, @@ -486,7 +486,7 @@

    • The _runtimeScene, _nameId, name and type are guaranteed to stay the same and do not need to be set again.
    -

    Parameters

    Returns void

    removeBehavior

    removeBehavior

    removeEffect

    removeEffect

    removeTimer

    Returns boolean

    removeTimer

    resetTimer

    Returns void

    resetTimer

    Static returnVariable

    Returns void

    Static returnVariable

    rotate

    rotate

    rotateTowardAngle

    rotateTowardAngle

    rotateTowardPosition

    separateFromObjects

    Returns void

    rotateTowardPosition

    separateFromObjects

    separateFromObjectsList

    separateFromObjectsList

    separateObjectsWithForces

    separateObjectsWithForces

    separateObjectsWithoutForces

    separateObjectsWithoutForces

    setAngle

    Returns void

    setAngle

    setCenterPositionInScene

    Returns void

    setCenterPositionInScene

    setCenterXInScene

    Returns void

    setCenterXInScene

    setCenterYInScene

    Returns void

    setCenterYInScene

    setColor

    setColor

    setEffectBooleanParameter

    setEffectBooleanParameter

    setEffectDoubleParameter

    Returns boolean

    setEffectDoubleParameter

    setEffectStringParameter

    Returns boolean

    setEffectStringParameter

    setHeight

    Returns boolean

    setHeight

    setIncludedInParentCollisionMask

    setLayer

    Returns void

    setIncludedInParentCollisionMask

    setLayer

    setPosition

    Returns void

    setPosition

    setRadius

    Returns void

    setRadius

    Static setVariableNumber

    Static setVariableNumber

    Static setVariableString

    Returns void

    Static setVariableString

    setWidth

    Returns void

    setWidth

    setX

    Returns void

    setX

    setY

    Returns void

    setY

    setZOrder

    Returns void

    setZOrder

    stepBehaviorsPostEvents

    Returns void

    stepBehaviorsPostEvents

    stepBehaviorsPreEvents

    stepBehaviorsPreEvents

    timerElapsedTime

    timerElapsedTime

    timerPaused

    timerPaused

    unpauseTimer

    unpauseTimer

    unregisterDestroyCallback

    update

    Returns void

    unregisterDestroyCallback

    update

    updateAABB

    Returns void

    updateAABB

    updateAllEffectParameters

    updateAllEffectParameters

    updateForces

    Returns boolean

    updateForces

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    updateFromObjectData

    updateFromObjectData

    updateHitBoxes

    updateHitBoxes

    updatePreRender

    updatePreRender

    updateTimers

    updateTimers

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []
    +

    Returns void

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []

    Global container for unused forces, avoiding recreating forces each tick.

    -
    static

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number
      • +

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number

      • Get the squared distance, in pixels, between the center of this object and a position.

        Parameters

        • targetX: number

          Target X position

        • targetY: number

          Target Y position

          -

        Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • +

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • Get the number of children from a variable

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The number of children

        -

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

      • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The value of the specified variable

        -

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

      • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns string

        The string of the specified variable

        -

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null
    +

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null

    A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

    -

    persistentUuid

    persistentUuid: null | string = null
    +

    persistentUuid

    persistentUuid: null | string = null

    An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

    -

    pick

    pick: boolean = false
    +

    pick

    pick: boolean = false

    A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

    -

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

      • Return the variable passed as argument without any change. Only for usage by events.

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns Variable

        The specified variable

        -

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void
      • +

      Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void

      • Shortcut to set the value of a variable considered as a number

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: number

          The value to be set

          -

        Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void
      • +

      Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void

      • Shortcut to set the value of a variable considered as a string

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: string

          The value to be set

          -

        Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • +

      Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable
          +

          Parameters

          • array: Variable
          • value: string | number | boolean

          Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable

          The variable to be tested

        • childName: string

          The name of the child

          -

        Returns boolean

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

      • static

        Parameters

        • variable: Variable

          The variable to be cleared

          -

        Returns void

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

        • variable: Variable

          The variable to be changed

        • childName: string

          The name of the child

          -

        Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • +

      Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Constructors

    constructor

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class LightRuntimeObjectPixiRenderer

    Pixi renderer for light runtime objects.

    -

    Hierarchy

    • LightRuntimeObjectPixiRenderer

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    Properties

    Static defaultFragmentShader

    defaultFragmentShader: string = ...

    Static defaultVertexShader

    defaultVertexShader: string = ...

    Static texturedFragmentShader

    texturedFragmentShader: string = ...

    Methods

    ensureUpToDate

    • ensureUpToDate(): void

    getRendererObject

    • getRendererObject(): null | Container<DisplayObject> | Mesh<MeshMaterial>

    updateColor

    • updateColor(): void

    updateDebugMode

    • updateDebugMode(): void

    updateMesh

    • updateMesh(): void

    updateRadius

    • updateRadius(): void

    updateTexture

    • updateTexture(): void

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class LinksManager

    Manages the links between objects.

    -

    Hierarchy

    • LinksManager

    Index

    Constructors

    Methods

    Constructors

    constructor

    Methods

    Static getManager

    Hierarchy

    • LinksManager

    Index

    Constructors

    Methods

    Constructors

    constructor

    Methods

    Static getManager

    getObjectsLinkedWith

    getObjectsLinkedWithAndNamed

    linkObjects

    removeAllLinksOf

    removeLinkBetween

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Logger

    A Console API like class for logging in a GDevelop game.

    -

    Hierarchy

    • Logger

    Index

    Constructors

    Methods

    Properties

    Constructors

    constructor

    • new Logger(group: string): Logger

    Hierarchy

    • Logger

    Index

    Constructors

    Methods

    Properties

    Constructors

    constructor

    • new Logger(group: string): Logger

    • Create a new logger with the given group name. You can then use log, info, warn and error on this object.

      -

      Parameters

      • group: string

      Returns Logger

    Methods

    error

    • error(...messages: any[]): void

    Static getDefaultConsoleLoggerOutput

    • getDefaultConsoleLoggerOutput(): ConsoleLoggerOutput

    Methods

    error

    • error(...messages: any[]): void

    Static getDefaultConsoleLoggerOutput

    • getDefaultConsoleLoggerOutput(): ConsoleLoggerOutput

    • Give access to the console output used by default by the logger. This can be useful to restore the default log method if you overrode it or to disable some logging in the console.

      -

      Returns ConsoleLoggerOutput

    Static getLoggerOutput

    Static getLoggerOutput

    info

    • info(...messages: any[]): void

    log

    • log(...messages: any[]): void

    Static setLoggerOutput

    info

    • info(...messages: any[]): void

    log

    • log(...messages: any[]): void

    Static setLoggerOutput

    warn

    • warn(...messages: any[]): void

    Properties

    Private Readonly group

    group: string

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class LongLivedObjectsList

    A container for objects lists that should last more than the current frame. It automatically removes objects that were destroyed from the objects lists.

    -

    Hierarchy

    • LongLivedObjectsList

    Index

    Methods

    Constructors

    Properties

    Methods

    addObject

    • addObject(objectName: string, runtimeObject: RuntimeObject): void

    backupLocalVariablesContainers

    Static from

    Hierarchy

    • LongLivedObjectsList

    Index

    Methods

    Constructors

    Properties

    Methods

    addObject

    • addObject(objectName: string, runtimeObject: RuntimeObject): void

    backupLocalVariablesContainers

    Static from

    • Create a new container for objects lists, inheriting from another one. This is useful should we get the objects that have not been saved in this context (using addObject) but saved in a parent context. This avoids to save all object lists every time we create a new LongLivedObjectsList, despite not all objects lists being used.

      -

      Parameters

      Returns LongLivedObjectsList

    getObjects

    removeObject

    • removeObject(objectName: string, runtimeObject: RuntimeObject): void

    restoreLocalVariablesContainers

    Private getOrCreateList

    Constructors

    constructor

    Properties

    Private callbacks

    callbacks: Map<RuntimeObject, () => void> = ...

    Private localVariablesContainers

    localVariablesContainers: VariablesContainer[] = []

    Private objectsLists

    objectsLists: Map<string, RuntimeObject[]> = ...

    Private parent

    parent: null | LongLivedObjectsList = null

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ManuallyResolvableTask

    Hierarchy

    Index

    Constructors

    Methods

    Properties

    Constructors

    constructor

    Methods

    resolve

    • resolve(): void

    update

    • update(): boolean
    • +ManuallyResolvableTask | GDevelop JavaScript game engine
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class ManuallyResolvableTask

      Hierarchy

      Index

      Constructors

      Methods

      Properties

      Constructors

      constructor

      Methods

      resolve

      • resolve(): void

      update

      • update(): boolean

      Properties

      Private isResolved

      isResolved: boolean = false

      Legend

      • Method
      • Inherited constructor
      • Private property

      Settings

      Theme

      Generated using TypeDoc

      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class Model3DManager

      Load GLB files (using Three.js), using the "model3D" resources registered in the game resources.

      -

      Hierarchy

      • Model3DManager

      Implements

      Index

      Constructors

      Methods

      Constructors

      constructor

      Hierarchy

      • Model3DManager

      Implements

      Index

      Constructors

      Methods

      Constructors

      constructor

      Methods

      getModel

      • getModel(resourceName: string): GLTF

      Returns Model3DManager

    Methods

    getModel

    • getModel(resourceName: string): GLTF

    • Return a 3D model.

      Caller should not modify the object but clone it.

      Parameters

      • resourceName: string

        The name of the json resource.

      Returns GLTF

      a 3D model if it exists.

      -

    getResourceKinds

    • getResourceKinds(): ResourceKind[]

    getResourceKinds

    • getResourceKinds(): ResourceKind[]

    loadResource

    • loadResource(resourceName: string): Promise<void>

    loadResource

    • loadResource(resourceName: string): Promise<void>

    processResource

    • processResource(resourceName: string): Promise<void>

    processResource

    • processResource(resourceName: string): Promise<void>

    addEffect

    • addEffect(effectData: EffectData): boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    Returns boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    Returns void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    Returns void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns boolean

    true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

    -

    behaviorActivated

    • behaviorActivated(name: string): boolean

    behaviorActivated

    • behaviorActivated(name: string): boolean

    clearEffects

    • clearEffects(): boolean

    clearEffects

    • clearEffects(): boolean

    clearForces

    • clearForces(): void

    clearForces

    • clearForces(): void

    Static collisionTest

    Static collisionTest

    • Return true if the hitboxes of two objects are overlapping

      static

      Parameters

      • obj1: RuntimeObject

        The first runtimeObject

        @@ -78,76 +78,76 @@
      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if obj1 and obj2 are in collision

      -

    cursorOnObject

    cursorOnObject

    deleteFromScene

    deleteFromScene

    Static distanceTest

    Returns void

    Static distanceTest

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    Returns void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    flipX

    • flipX(enable: boolean): void

    flipY

    • flipY(enable: boolean): void

    flipZ

    • flipZ(enable: boolean): void

    get3DRendererObject

    • get3DRendererObject(): Object3D<Object3DEventMap>

    getAABB

    flipX

    • flipX(enable: boolean): void

    flipY

    • flipY(enable: boolean): void

    flipZ

    • flipZ(enable: boolean): void

    get3DRendererObject

    • get3DRendererObject(): Object3D<Object3DEventMap>

    getAABB

    • Get the AABB (axis aligned bounding box) for the object.

      The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

      You should probably redefine updateAABB instead of this function.

      Returns AABB

      The bounding box

      -

    getAABBBottom

    • getAABBBottom(): number

    getAABBBottom

    • getAABBBottom(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBRight

    • getAABBRight(): number

    getAABBRight

    • getAABBRight(): number

    getAABBTop

    • getAABBTop(): number

    getAABBTop

    • getAABBTop(): number

    getAngle

    • getAngle(): number

    getAngle

    • getAngle(): number

    getAngleToObject

    getAngleToObject

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    Returns number

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    getAnimationDuration

    • getAnimationDuration(): number

    getAnimationElapsedTime

    • getAnimationElapsedTime(): number

    getAnimationIndex

    • getAnimationIndex(): number

    Returns number

    getAnimationDuration

    • getAnimationDuration(): number

    getAnimationElapsedTime

    • getAnimationElapsedTime(): number

    getAnimationIndex

    • getAnimationIndex(): number

    getAnimationName

    • getAnimationName(): string

    getAnimationName

    • getAnimationName(): string

    getAnimationSpeedScale

    • getAnimationSpeedScale(): number

    getAverageForce

    getAnimationSpeedScale

    • getAnimationSpeedScale(): number

    getAverageForce

    getBehavior

    getBehavior

    • Get a behavior from its name. If the behavior does not exists, undefined is returned.

      Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -155,75 +155,75 @@

      Parameters

      • name: string

        The behavior name.

      Returns null | RuntimeBehavior

      The behavior with the given name, or undefined.

      -

    getCenterX

    • getCenterX(): number

    getCenterX

    • getCenterX(): number

    • Return the X position of the object center, relative to the object X position (getDrawableX). Use getCenterXInScene to get the position of the center in the scene.

      Returns number

      the X position of the object center, relative to getDrawableX().

      -

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterY

    • getCenterY(): number

    getCenterY

    • getCenterY(): number

    • Return the Y position of the object center, relative to the object position (getDrawableY). Use getCenterYInScene to get the position of the center in the scene.

      Returns number

      the Y position of the object center, relative to getDrawableY().

      -

    getCenterYInScene

    • getCenterYInScene(): number

    getCenterYInScene

    • getCenterYInScene(): number

    getCenterZ

    • getCenterZ(): number

    getCenterZ

    • getCenterZ(): number

    • Return the Z position of the object center, relative to the object Z position (getDrawableX).

      Use getCenterZInScene to get the position of the center in the scene.

      Returns number

      the Z position of the object center, relative to getDrawableZ().

      -

    getCenterZInScene

    • getCenterZInScene(): number

    getCenterZInScene

    • getCenterZInScene(): number

    getDepth

    • getDepth(): number

    getDepth

    • getDepth(): number

    getDistanceToObject

    getDistanceToObject

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    getDrawableX

    • getDrawableX(): number

    Returns number

    getDrawableX

    • getDrawableX(): number

    • Get the X position of the rendered object.

      For most objects, this will returns the same value as getX(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableX will differ.

      Returns number

      The X position of the rendered object.

      -

    getDrawableY

    • getDrawableY(): number

    getDrawableY

    • getDrawableY(): number

    • Get the Y position of the rendered object.

      For most objects, this will returns the same value as getY(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableY will differ.

      Returns number

      The Y position of the rendered object.

      -

    getDrawableZ

    • getDrawableZ(): number

    getDrawableZ

    • getDrawableZ(): number

    • Get the Z position of the rendered object.

      For most objects, this will returns the same value as getZ(). But if the object has an origin that is not the same as the point (0,0,0) of the object displayed, getDrawableZ will differ.

      Returns number

      The Z position of the rendered object.

      -

    getElapsedTime

    getElapsedTime

    getHeight

    • getHeight(): number

    Returns number

    getHeight

    • getHeight(): number

    getHitBoxes

    getHitBoxes

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    • Return at least all the hit boxes that overlap a given area.

      The hit boxes don't need to actually overlap the area, (i.e: it's correct to return more hit boxes than those in the specified area) @@ -248,142 +248,142 @@

    • bottom: number

      bound of the area in scene coordinates

    Returns Iterable<Polygon>

    at least all the hit boxes that overlap a given area.

    -

    getInstanceContainer

    getInstanceContainer

    getLayer

    • getLayer(): string

    getLayer

    • getLayer(): string

    getName

    • getName(): string

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    • Get the identifier associated to an object name. Some features may want to compare objects name a large number of time. In this case, it may be more efficient to compare objects name identifiers.

      -
      static

      Parameters

      • name: string

      Returns number

    getNetworkSyncData

    • getNetworkSyncData(): Model3DObjectNetworkSyncData

    getNetworkSyncData

    • getNetworkSyncData(): Model3DObjectNetworkSyncData

    getParent

    getParent

    getRenderer

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRenderer

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererObject

    • getRendererObject(): null

    getRotationX

    • getRotationX(): number

    getRendererObject

    • getRendererObject(): null

    getRotationX

    • getRotationX(): number

    getRotationY

    • getRotationY(): number

    getRotationY

    • getRotationY(): number

    getRuntimeScene

    getRuntimeScene

    getScale

    • getScale(): number

    getScale

    • getScale(): number

    • Get the scale of the object (or the geometric average of X, Y and Z scale in case they are different).

      Returns number

      the scale of the object (or the geometric average of X, Y and Z scale in case they are different).

      -

    getScaleX

    • getScaleX(): number

    getScaleX

    • getScaleX(): number

    getScaleY

    • getScaleY(): number

    getScaleY

    • getScaleY(): number

    getScaleZ

    • getScaleZ(): number

    getScaleZ

    • getScaleZ(): number

    getSqDistanceToObject

    getSqDistanceToObject

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    Returns number

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getUniqueId

    • getUniqueId(): number

    getUniqueId

    • getUniqueId(): number

    • Get the unique identifier of the object.
      The identifier is set by the runtimeScene owning the object.
      You can also use the id property (this._object.id) for increased efficiency instead of calling this method.

      Returns number

      The object identifier

      -

    getUnrotatedAABBMaxZ

    • getUnrotatedAABBMaxZ(): number

    getUnrotatedAABBMaxZ

    • getUnrotatedAABBMaxZ(): number

    getUnrotatedAABBMinZ

    • getUnrotatedAABBMinZ(): number

    getUnrotatedAABBMinZ

    • getUnrotatedAABBMinZ(): number

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableString

    • getVariableString(variable: Variable): string

    Static getVariableString

    • getVariableString(variable: Variable): string

    getVariables

    getVariables

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    • Get the AABB (axis aligned bounding box) to be used to determine if the object is visible on screen. The gdjs.RuntimeScene will hide the renderer object if the object is not visible on screen ("culling").

      The default implementation uses the AABB returned by getAABB.

      If null is returned, the object is assumed to be always visible.

      Returns null | AABB

      The bounding box or null.

      -

    getWidth

    • getWidth(): number

    getWidth

    • getWidth(): number

    getX

    • getX(): number

    getX

    • getX(): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    • Compute the X position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getY

    • getY(): number

    Returns number

    getY

    • getY(): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    • Compute the Y position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getZ

    • getZ(): number

    Returns number

    getZ

    • getZ(): number

    getZOrder

    • getZOrder(): number

    getZOrder

    • getZOrder(): number

    hasAnimationEnded

    • hasAnimationEnded(): boolean

    hasAnimationEnded

    • hasAnimationEnded(): boolean

    hasBehavior

    • hasBehavior(name: string): boolean

    hasBehavior

    • hasBehavior(name: string): boolean

    hasEffect

    • hasEffect(name: string): boolean

    Returns boolean

    hasEffect

    • hasEffect(name: string): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hide

    • hide(enable: boolean): void

    hide

    • hide(enable: boolean): void

    insideObject

    • insideObject(x: number, y: number): boolean

    insideObject

    • insideObject(x: number, y: number): boolean

    • Return true if the specified position is inside object bounding box.

      The position should be in "world" coordinates, i.e use gdjs.Layer.convertCoords if you need to pass the mouse or a touch position that you get from gdjs.InputManager. To check if a point is inside the object collision mask, you can use isCollidingWithPoint instead.

      -

      Parameters

      • x: number
      • y: number

      Returns boolean

    invalidateHitboxes

    • invalidateHitboxes(): void

    invalidateHitboxes

    • invalidateHitboxes(): void

    isAnimationPaused

    • isAnimationPaused(): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isAnimationPaused

    • isAnimationPaused(): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isCurrentAnimationName

    • isCurrentAnimationName(name: string): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isCurrentAnimationName

    • isCurrentAnimationName(name: string): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isFlippedX

    • isFlippedX(): boolean

    isFlippedY

    • isFlippedY(): boolean

    isFlippedZ

    • isFlippedZ(): boolean

    isHidden

    • isHidden(): boolean

    isFlippedX

    • isFlippedX(): boolean

    isFlippedY

    • isFlippedY(): boolean

    isFlippedZ

    • isFlippedZ(): boolean

    isHidden

    • isHidden(): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    • Return true if the angle of the total force applied on the object is in a given range.

      Parameters

      • angle: number
        @@ -449,43 +449,43 @@

        The maximum distance from the given angle.

      Returns boolean

      true if the difference between the force angle the given angle is less or equals the toleranceInDegrees.

      -

    isVisible

    • isVisible(): boolean

    isVisible

    • isVisible(): boolean

    • Return true if the object is not hidden.

      Note: This is unrelated to the actual visibility of the object on the screen. For this, see getVisibilityAABB to get the bounding boxes of the object as displayed on the scene.

      Returns boolean

      true if the object is not hidden.

      -

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    • To be called by the child classes in their constructor, at the very end. Notify the behaviors that they have been constructed (this must be done when the object is ready, otherwise behaviors can do operations on the object which could be not initialized yet).

      If you redefine this function, make sure to call the original method (RuntimeObject.prototype.onCreated.call(this);).

      -

      Returns void

    onDeletedFromScene

    onDeletedFromScene

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    Returns void

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    onSceneResumed

    Returns void

    onSceneResumed

    pauseAnimation

    • pauseAnimation(): void

    pauseTimer

    • pauseTimer(timerName: string): void

    Returns void

    pauseAnimation

    • pauseAnimation(): void

    pauseTimer

    • pauseTimer(timerName: string): void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    Returns void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    • Put the object around a position, with a specific distance and angle. The distance and angle are computed between the position and the center of the object.

      Parameters

      • x: number
        @@ -496,7 +496,7 @@

        The distance between the object and the target, in pixels.

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    • Put the object around another object, with a specific distance and angle. The distance and angle are computed between the centers of the objects.

      Parameters

      • obj: null | RuntimeObject
        @@ -505,7 +505,7 @@

        The distance between the object and the target

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    • Called to reset the object to its default state. This is used for objects that are "recycled": they are dismissed (at which point onDestroyFromScene is called) but still stored in a cache to be reused next time an object must be created. At this point, @@ -531,7 +531,7 @@

    • The _runtimeScene, _nameId, name and type are guaranteed to stay the same and do not need to be set again.
    -

    Parameters

    Returns void

    removeBehavior

    removeBehavior

    removeEffect

    removeEffect

    removeTimer

    Returns boolean

    removeTimer

    resetTimer

    Returns void

    resetTimer

    resumeAnimation

    Static returnVariable

    Returns void

    resumeAnimation

    Static returnVariable

    rotate

    rotate

    rotateTowardAngle

    rotateTowardAngle

    rotateTowardPosition

    separateFromObjects

    Returns void

    rotateTowardPosition

    separateFromObjects

    separateFromObjectsList

    separateFromObjectsList

    separateObjectsWithForces

    separateObjectsWithForces

    separateObjectsWithoutForces

    separateObjectsWithoutForces

    setAngle

    Returns void

    setAngle

    setAnimationElapsedTime

    setAnimationElapsedTime

    setAnimationIndex

    setAnimationIndex

    setAnimationName

    Returns void

    setAnimationName

    setAnimationSpeedScale

    setCenterPositionInScene

    Returns void

    setAnimationSpeedScale

    setCenterPositionInScene

    setCenterXInScene

    Returns void

    setCenterXInScene

    setCenterYInScene

    Returns void

    setCenterYInScene

    setCenterZInScene

    setCenterZInScene

    setDepth

    setDepth

    setEffectBooleanParameter

    setEffectBooleanParameter

    setEffectDoubleParameter

    Returns boolean

    setEffectDoubleParameter

    setEffectStringParameter

    Returns boolean

    setEffectStringParameter

    setHeight

    Returns boolean

    setHeight

    setIncludedInParentCollisionMask

    setLayer

    setIncludedInParentCollisionMask

    setLayer

    setPosition

    Returns void

    setPosition

    setRotationX

    Returns void

    setRotationX

    setRotationY

    setRotationY

    setScale

    setScale

    setScaleX

    Returns void

    setScaleX

    setScaleY

    Returns void

    setScaleY

    setScaleZ

    Returns void

    setScaleZ

    setSize

    Returns void

    setSize

    Static setVariableNumber

    Static setVariableNumber

    Static setVariableString

    Returns void

    Static setVariableString

    setWidth

    Returns void

    setWidth

    setX

    setX

    setY

    setY

    setZ

    setZ

    setZOrder

    setZOrder

    stepBehaviorsPostEvents

    Returns void

    stepBehaviorsPostEvents

    stepBehaviorsPreEvents

    stepBehaviorsPreEvents

    timerElapsedTime

    timerElapsedTime

    timerPaused

    timerPaused

    turnAroundX

    turnAroundX

    turnAroundY

    Returns void

    turnAroundY

    turnAroundZ

    Returns void

    turnAroundZ

    unpauseTimer

    Returns void

    unpauseTimer

    unregisterDestroyCallback

    update

    Returns void

    unregisterDestroyCallback

    update

    updateAABB

    updateAABB

    updateAllEffectParameters

    updateAllEffectParameters

    updateForces

    Returns boolean

    updateForces

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    updateFromObjectData

    updateFromObjectData

    updateHitBoxes

    updateHitBoxes

    updatePreRender

    updatePreRender

    updateTimers

    Returns void

    updateTimers

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []
    +

    Returns void

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []

    Global container for unused forces, avoiding recreating forces each tick.

    -
    static

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number
      • +

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number

      • Get the squared distance, in pixels, between the center of this object and a position.

        Parameters

        • targetX: number

          Target X position

        • targetY: number

          Target Y position

          -

        Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • +

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • Get the number of children from a variable

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The number of children

        -

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

      • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The value of the specified variable

        -

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

      • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns string

        The string of the specified variable

        -

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null
    +

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null

    A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

    -

    persistentUuid

    persistentUuid: null | string = null
    +

    persistentUuid

    persistentUuid: null | string = null

    An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

    -

    pick

    pick: boolean = false
    +

    pick

    pick: boolean = false

    A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

    -

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

      • Return the variable passed as argument without any change. Only for usage by events.

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns Variable

        The specified variable

        -

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void
      • +

      Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void

      • Shortcut to set the value of a variable considered as a number

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: number

          The value to be set

          -

        Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void
      • +

      Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void

      • Shortcut to set the value of a variable considered as a string

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: string

          The value to be set

          -

        Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • +

      Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable
          +

          Parameters

          • array: Variable
          • value: string | number | boolean

          Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable

          The variable to be tested

        • childName: string

          The name of the child

          -

        Returns boolean

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

      • static

        Parameters

        • variable: Variable

          The variable to be cleared

          -

        Returns void

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

        • variable: Variable

          The variable to be changed

        • childName: string

          The name of the child

          -

        Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • +

      Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Constructors

    constructor

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class MultiplayerObjectRuntimeBehavior

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

    -

    Hierarchy

    Index

    Properties

    Methods

    Constructors

    Properties

    actionOnPlayerDisconnect

    actionOnPlayerDisconnect: string

    name

    name: string

    owner

    owner: RuntimeObject

    playerNumber

    playerNumber: number = 0

    type

    type: string

    Methods

    activate

    • activate(enable: boolean): void

    Hierarchy

    Index

    Properties

    Methods

    Constructors

    Properties

    actionOnPlayerDisconnect

    actionOnPlayerDisconnect: string

    name

    name: string

    owner

    owner: RuntimeObject

    playerNumber

    playerNumber: number = 0

    type

    type: string

    Methods

    activate

    • activate(enable: boolean): void

    activated

    • activated(): boolean

    Returns void

    activated

    • activated(): boolean

    doStepPostEvents

    • doStepPostEvents(): void

    doStepPostEvents

    • doStepPostEvents(): void

    doStepPreEvents

    doStepPreEvents

    enableBehaviorSynchronization

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

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getActionOnPlayerDisconnect

    • getActionOnPlayerDisconnect(): string

    getName

    • getName(): string

    Returns void

    enableBehaviorSynchronization

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

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getActionOnPlayerDisconnect

    • getActionOnPlayerDisconnect(): string

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    getPlayerObjectOwnership

    • getPlayerObjectOwnership(): number

    isObjectOwnedByCurrentPlayer

    • isObjectOwnedByCurrentPlayer(): boolean

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    getPlayerObjectOwnership

    • getPlayerObjectOwnership(): number

    isObjectOwnedByCurrentPlayer

    • isObjectOwnedByCurrentPlayer(): boolean

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    onDeActivate

    • onDeActivate(): void

    onDeActivate

    • onDeActivate(): void

    onDestroy

    • onDestroy(): void

    onDestroy

    • onDestroy(): void

    onObjectHotReloaded

    • onObjectHotReloaded(): void

    onObjectHotReloaded

    • onObjectHotReloaded(): void

    removeObjectOwnership

    • removeObjectOwnership(): void

    setPlayerObjectOwnership

    • setPlayerObjectOwnership(newObjectPlayerNumber: number): void

    stepPostEvents

    removeObjectOwnership

    • removeObjectOwnership(): void

    setPlayerObjectOwnership

    • setPlayerObjectOwnership(newObjectPlayerNumber: number): void

    stepPostEvents

    stepPreEvents

    Returns void

    stepPreEvents

    takeObjectOwnership

    • takeObjectOwnership(): void

    updateFromBehaviorData

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

    Returns void

    takeObjectOwnership

    • takeObjectOwnership(): void

    updateFromBehaviorData

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

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    Returns void

    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

    Constructors

    constructor

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class OnceTriggers

    OnceTriggers is used to store the status of the conditions "Trigger once", that are used in events to have conditions that are only valid for one frame in a row.

    -

    Hierarchy

    • OnceTriggers

    Index

    Constructors

    Methods

    Constructors

    constructor

    Methods

    startNewFrame

    • startNewFrame(): void

    Hierarchy

    • OnceTriggers

    Index

    Constructors

    Methods

    Constructors

    constructor

    Methods

    startNewFrame

    • startNewFrame(): void

    triggerOnce

    • triggerOnce(triggerId: number): boolean

    triggerOnce

    • triggerOnce(triggerId: number): boolean

    activated

    • activated(): boolean

    doStepPostEvents

    doStepPostEvents

    doStepPreEvents

    doStepPreEvents

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getName

    • getName(): string

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    getOpacity

    • getOpacity(): number

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    getOpacity

    • getOpacity(): number

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    onDeActivate

    • onDeActivate(): void

    onDeActivate

    • onDeActivate(): void

    onDestroy

    • onDestroy(): 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

    onObjectHotReloaded

    • onObjectHotReloaded(): void

    setOpacity

    • setOpacity(opacity: number): void

    setOpacity

    • setOpacity(opacity: number): void

    stepPostEvents

    stepPostEvents

    stepPreEvents

    Returns void

    stepPreEvents

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    Returns void

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    Returns void

    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

    Constructors

    constructor

    Properties

    name

    name: string

    owner

    owner: RuntimeObject

    type

    type: string

    Private object

    object: RuntimeObject & OpacityHandler

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class PanelSpriteRuntimeObject

    The PanelSpriteRuntimeObject displays a tiled texture.

    -

    Hierarchy

    Implements

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    Hierarchy

    Implements

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    addEffect

    • addEffect(effectData: EffectData): boolean

    Returns void

    addEffect

    • addEffect(effectData: EffectData): boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    Returns boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    • Add a force to the object to move it.

      Parameters

      • x: number

        The x coordinates of the force

        @@ -18,7 +18,7 @@

        The y coordinates of the force

      • multiplier: number

        Set the force multiplier

        -

      Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    Returns void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    Returns void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    • Create the behavior described by the given BehaviorData

      Parameters

      • behaviorData: BehaviorData

        The data to be used to construct the behavior.

      Returns boolean

      true if the behavior was properly created, false otherwise.

      -

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns boolean

    true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

    -

    behaviorActivated

    • behaviorActivated(name: string): boolean

    behaviorActivated

    • behaviorActivated(name: string): boolean

    clearEffects

    • clearEffects(): boolean

    clearEffects

    • clearEffects(): boolean

    clearForces

    • clearForces(): void

    clearForces

    • clearForces(): void

    Static collisionTest

    Static collisionTest

    • Return true if the hitboxes of two objects are overlapping

      static

      Parameters

      • obj1: RuntimeObject

        The first runtimeObject

        @@ -78,67 +78,67 @@
      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if obj1 and obj2 are in collision

      -

    cursorOnObject

    cursorOnObject

    deleteFromScene

    deleteFromScene

    Static distanceTest

    Returns void

    Static distanceTest

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    Returns void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    • Get the AABB (axis aligned bounding box) for the object.

      The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

      You should probably redefine updateAABB instead of this function.

      Returns AABB

      The bounding box

      -

    getAABBBottom

    • getAABBBottom(): number

    getAABBBottom

    • getAABBBottom(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBRight

    • getAABBRight(): number

    getAABBRight

    • getAABBRight(): number

    getAABBTop

    • getAABBTop(): number

    getAABBTop

    • getAABBTop(): number

    getAngle

    • getAngle(): number

    getAngle

    • getAngle(): number

    getAngleToObject

    getAngleToObject

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    Returns number

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    getAverageForce

    Returns number

    getAverageForce

    getBehavior

    getBehavior

    • Get a behavior from its name. If the behavior does not exists, undefined is returned.

      Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -146,62 +146,62 @@

      Parameters

      • name: string

        The behavior name.

      Returns null | RuntimeBehavior

      The behavior with the given name, or undefined.

      -

    getCenterX

    • getCenterX(): number

    getCenterX

    • getCenterX(): number

    • Return the X position of the object center, relative to the object X position (getDrawableX). Use getCenterXInScene to get the position of the center in the scene.

      Returns number

      the X position of the object center, relative to getDrawableX().

      -

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterY

    • getCenterY(): number

    getCenterY

    • getCenterY(): number

    • Return the Y position of the object center, relative to the object position (getDrawableY). Use getCenterYInScene to get the position of the center in the scene.

      Returns number

      the Y position of the object center, relative to getDrawableY().

      -

    getCenterYInScene

    • getCenterYInScene(): number

    getCenterYInScene

    • getCenterYInScene(): number

    getColor

    • getColor(): string

    getColor

    • getColor(): string

    getDistanceToObject

    getDistanceToObject

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    getDrawableX

    • getDrawableX(): number

    Returns number

    getDrawableX

    • getDrawableX(): number

    • Get the X position of the rendered object.

      For most objects, this will returns the same value as getX(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableX will differ.

      Returns number

      The X position of the rendered object.

      -

    getDrawableY

    • getDrawableY(): number

    getDrawableY

    • getDrawableY(): number

    • Get the Y position of the rendered object.

      For most objects, this will returns the same value as getY(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableY will differ.

      Returns number

      The Y position of the rendered object.

      -

    getElapsedTime

    getElapsedTime

    getHeight

    • getHeight(): number

    Returns number

    getHeight

    • getHeight(): number

    getHitBoxes

    getHitBoxes

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    • Return at least all the hit boxes that overlap a given area.

      The hit boxes don't need to actually overlap the area, (i.e: it's correct to return more hit boxes than those in the specified area) @@ -226,177 +226,177 @@

    • bottom: number

      bound of the area in scene coordinates

    Returns Iterable<Polygon>

    at least all the hit boxes that overlap a given area.

    -

    getInstanceContainer

    getInstanceContainer

    getLayer

    • getLayer(): string

    getLayer

    • getLayer(): string

    getName

    • getName(): string

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    • Get the identifier associated to an object name. Some features may want to compare objects name a large number of time. In this case, it may be more efficient to compare objects name identifiers.

      -
      static

      Parameters

      • name: string

      Returns number

    getNetworkSyncData

    getNetworkSyncData

    getOpacity

    • getOpacity(): number

    getOpacity

    • getOpacity(): number

    getParent

    getParent

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererObject

    • getRendererObject(): Container<DisplayObject>

    getRuntimeScene

    getRendererObject

    • getRendererObject(): Container<DisplayObject>

    getRuntimeScene

    getScale

    • getScale(): number

    getScale

    • getScale(): number

    getScaleX

    • getScaleX(): number

    getScaleX

    • getScaleX(): number

    getScaleY

    • getScaleY(): number

    getScaleY

    • getScaleY(): number

    getSqDistanceToObject

    getSqDistanceToObject

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    Returns number

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    • Get a timer elapsed time.

      This is used by expressions to return 0 when a timer doesn't exist because numeric expressions must always return a number.

      Parameters

      • timerName: string

        The timer name.

      Returns number

      The timer elapsed time in seconds, 0 if the timer doesn't exist.

      -

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getUniqueId

    • getUniqueId(): number

    getUniqueId

    • getUniqueId(): number

    • Get the unique identifier of the object.
      The identifier is set by the runtimeScene owning the object.
      You can also use the id property (this._object.id) for increased efficiency instead of calling this method.

      Returns number

      The object identifier

      -

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableString

    • getVariableString(variable: Variable): string

    Static getVariableString

    • getVariableString(variable: Variable): string

    getVariables

    getVariables

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    • Get the AABB (axis aligned bounding box) to be used to determine if the object is visible on screen. The gdjs.RuntimeScene will hide the renderer object if the object is not visible on screen ("culling").

      The default implementation uses the AABB returned by getAABB.

      If null is returned, the object is assumed to be always visible.

      Returns null | AABB

      The bounding box or null.

      -

    getWidth

    • getWidth(): number

    getWidth

    • getWidth(): number

    getX

    • getX(): number

    getX

    • getX(): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    • Compute the X position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getY

    • getY(): number

    Returns number

    getY

    • getY(): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    • Compute the Y position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getZOrder

    • getZOrder(): number

    Returns number

    getZOrder

    • getZOrder(): number

    hasBehavior

    • hasBehavior(name: string): boolean

    hasBehavior

    • hasBehavior(name: string): boolean

    hasEffect

    • hasEffect(name: string): boolean

    Returns boolean

    hasEffect

    • hasEffect(name: string): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hide

    • hide(enable: boolean): void

    hide

    • hide(enable: boolean): void

    insideObject

    • insideObject(x: number, y: number): boolean

    Returns void

    insideObject

    • insideObject(x: number, y: number): boolean

    • Return true if the specified position is inside object bounding box.

      The position should be in "world" coordinates, i.e use gdjs.Layer.convertCoords if you need to pass the mouse or a touch position that you get from gdjs.InputManager. To check if a point is inside the object collision mask, you can use isCollidingWithPoint instead.

      -

      Parameters

      • x: number
      • y: number

      Returns boolean

    invalidateHitboxes

    • invalidateHitboxes(): void

    invalidateHitboxes

    • invalidateHitboxes(): void

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isHidden

    • isHidden(): boolean

    isHidden

    • isHidden(): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    • Return true if the angle of the total force applied on the object is in a given range.

      Parameters

      • angle: number
        @@ -405,43 +405,43 @@

        The maximum distance from the given angle.

      Returns boolean

      true if the difference between the force angle the given angle is less or equals the toleranceInDegrees.

      -

    isVisible

    • isVisible(): boolean

    isVisible

    • isVisible(): boolean

    • Return true if the object is not hidden.

      Note: This is unrelated to the actual visibility of the object on the screen. For this, see getVisibilityAABB to get the bounding boxes of the object as displayed on the scene.

      Returns boolean

      true if the object is not hidden.

      -

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    • To be called by the child classes in their constructor, at the very end. Notify the behaviors that they have been constructed (this must be done when the object is ready, otherwise behaviors can do operations on the object which could be not initialized yet).

      If you redefine this function, make sure to call the original method (RuntimeObject.prototype.onCreated.call(this);).

      -

      Returns void

    onDeletedFromScene

    onDeletedFromScene

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    Returns void

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    onSceneResumed

    Returns void

    onSceneResumed

    pauseTimer

    • pauseTimer(timerName: string): void

    Returns void

    pauseTimer

    • pauseTimer(timerName: string): void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    Returns void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    • Put the object around a position, with a specific distance and angle. The distance and angle are computed between the position and the center of the object.

      Parameters

      • x: number
        @@ -452,7 +452,7 @@

        The distance between the object and the target, in pixels.

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    • Put the object around another object, with a specific distance and angle. The distance and angle are computed between the centers of the objects.

      Parameters

      • obj: null | RuntimeObject
        @@ -461,7 +461,7 @@

        The distance between the object and the target

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    • Called to reset the object to its default state. This is used for objects that are "recycled": they are dismissed (at which point onDestroyFromScene is called) but still stored in a cache to be reused next time an object must be created. At this point, @@ -487,7 +487,7 @@

    • The _runtimeScene, _nameId, name and type are guaranteed to stay the same and do not need to be set again.
    -

    Parameters

    Returns void

    removeBehavior

    removeBehavior

    removeEffect

    removeEffect

    removeTimer

    Returns boolean

    removeTimer

    resetTimer

    Returns void

    resetTimer

    Static returnVariable

    Returns void

    Static returnVariable

    rotate

    rotate

    rotateTowardAngle

    rotateTowardAngle

    rotateTowardPosition

    separateFromObjects

    Returns void

    rotateTowardPosition

    separateFromObjects

    separateFromObjectsList

    separateFromObjectsList

    separateObjectsWithForces

    separateObjectsWithForces

    separateObjectsWithoutForces

    separateObjectsWithoutForces

    setAngle

    Returns void

    setAngle

    setCenterPositionInScene

    Returns void

    setCenterPositionInScene

    setCenterXInScene

    Returns void

    setCenterXInScene

    setCenterYInScene

    Returns void

    setCenterYInScene

    setColor

    setColor

    setEffectBooleanParameter

    Returns void

    setEffectBooleanParameter

    setEffectDoubleParameter

    Returns boolean

    setEffectDoubleParameter

    setEffectStringParameter

    Returns boolean

    setEffectStringParameter

    setHeight

    Returns boolean

    setHeight

    setIncludedInParentCollisionMask

    setLayer

    setIncludedInParentCollisionMask

    setLayer

    setOpacity

    Returns void

    setOpacity

    setPosition

    setPosition

    setScale

    Returns void

    setScale

    setScaleX

    Returns void

    setScaleX

    setScaleY

    Returns void

    setScaleY

    setSize

    Returns void

    setSize

    setTexture

    setTexture

    Static setVariableNumber

    Returns void

    Static setVariableNumber

    Static setVariableString

    Returns void

    Static setVariableString

    setWidth

    Returns void

    setWidth

    setX

    setX

    setY

    Returns void

    setY

    setZOrder

    Returns void

    setZOrder

    stepBehaviorsPostEvents

    Returns void

    stepBehaviorsPostEvents

    stepBehaviorsPreEvents

    stepBehaviorsPreEvents

    timerElapsedTime

    timerElapsedTime

    timerPaused

    timerPaused

    unpauseTimer

    unpauseTimer

    unregisterDestroyCallback

    update

    Returns void

    unregisterDestroyCallback

    update

    updateAABB

    updateAABB

    updateAllEffectParameters

    updateAllEffectParameters

    updateForces

    Returns boolean

    updateForces

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    updateFromObjectData

    updateFromObjectData

    updateHitBoxes

    updateHitBoxes

    updatePreRender

    updatePreRender

    updateTimers

    Returns void

    updateTimers

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []
    +

    Returns void

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []

    Global container for unused forces, avoiding recreating forces each tick.

    -
    static

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number
      • +

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number

      • Get the squared distance, in pixels, between the center of this object and a position.

        Parameters

        • targetX: number

          Target X position

        • targetY: number

          Target Y position

          -

        Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • +

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • Get the number of children from a variable

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The number of children

        -

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

      • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The value of the specified variable

        -

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

      • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns string

        The string of the specified variable

        -

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null
    +

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null

    A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

    -

    opacity

    opacity: number = 255

    persistentUuid

    persistentUuid: null | string = null
    +

    opacity

    opacity: number = 255

    persistentUuid

    persistentUuid: null | string = null

    An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

    -

    pick

    pick: boolean = false
    +

    pick

    pick: boolean = false

    A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

    -

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

      • Return the variable passed as argument without any change. Only for usage by events.

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns Variable

        The specified variable

        -

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void
      • +

      Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void

      • Shortcut to set the value of a variable considered as a number

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: number

          The value to be set

          -

        Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void
      • +

      Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void

      • Shortcut to set the value of a variable considered as a string

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: string

          The value to be set

          -

        Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • +

      Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable
          +

          Parameters

          • array: Variable
          • value: string | number | boolean

          Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable

          The variable to be tested

        • childName: string

          The name of the child

          -

        Returns boolean

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

      • static

        Parameters

        • variable: Variable

          The variable to be cleared

          -

        Returns void

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

        • variable: Variable

          The variable to be changed

        • childName: string

          The name of the child

          -

        Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • +

      Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Constructors

    constructor

    Constructors

    constructor

    addEffect

    • addEffect(effectData: EffectData): boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    Returns boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    • Add a force to the object to move it.

      Parameters

      • x: number

        The x coordinates of the force

        @@ -18,7 +18,7 @@

        The y coordinates of the force

      • multiplier: number

        Set the force multiplier

        -

      Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    Returns void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    Returns void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    • Create the behavior described by the given BehaviorData

      Parameters

      • behaviorData: BehaviorData

        The data to be used to construct the behavior.

      Returns boolean

      true if the behavior was properly created, false otherwise.

      -

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns boolean

    true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

    -

    behaviorActivated

    • behaviorActivated(name: string): boolean

    behaviorActivated

    • behaviorActivated(name: string): boolean

    clearEffects

    • clearEffects(): boolean

    clearEffects

    • clearEffects(): boolean

    clearForces

    • clearForces(): void

    clearForces

    • clearForces(): void

    Static collisionTest

    Static collisionTest

    • Return true if the hitboxes of two objects are overlapping

      static

      Parameters

      • obj1: RuntimeObject

        The first runtimeObject

        @@ -78,70 +78,70 @@
      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if obj1 and obj2 are in collision

      -

    cursorOnObject

    cursorOnObject

    deleteFromScene

    deleteFromScene

    Static distanceTest

    Returns void

    Static distanceTest

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    Returns void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    Returns void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    • Get the AABB (axis aligned bounding box) for the object.

      The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

      You should probably redefine updateAABB instead of this function.

      Returns AABB

      The bounding box

      -

    getAABBBottom

    • getAABBBottom(): number

    getAABBBottom

    • getAABBBottom(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBRight

    • getAABBRight(): number

    getAABBRight

    • getAABBRight(): number

    getAABBTop

    • getAABBTop(): number

    getAABBTop

    • getAABBTop(): number

    getAdditiveRendering

    • getAdditiveRendering(): boolean

    getAngle

    • getAngle(): number

    getAdditiveRendering

    • getAdditiveRendering(): boolean

    getAngle

    • getAngle(): number

    getAngleToObject

    getAngleToObject

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    Returns number

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    getAverageForce

    Returns number

    getAverageForce

    getBehavior

    getBehavior

    • Get a behavior from its name. If the behavior does not exists, undefined is returned.

      Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -149,61 +149,61 @@

      Parameters

      • name: string

        The behavior name.

      Returns null | RuntimeBehavior

      The behavior with the given name, or undefined.

      -

    getCenterX

    • getCenterX(): number

    getCenterX

    • getCenterX(): number

    • Return the X position of the object center, relative to the object X position (getDrawableX). Use getCenterXInScene to get the position of the center in the scene.

      Returns number

      the X position of the object center, relative to getDrawableX().

      -

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterY

    • getCenterY(): number

    getCenterY

    • getCenterY(): number

    • Return the Y position of the object center, relative to the object position (getDrawableY). Use getCenterYInScene to get the position of the center in the scene.

      Returns number

      the Y position of the object center, relative to getDrawableY().

      -

    getCenterYInScene

    • getCenterYInScene(): number

    getCenterYInScene

    • getCenterYInScene(): number

    getConeSprayAngle

    • getConeSprayAngle(): number

    getDistanceToObject

    getConeSprayAngle

    • getConeSprayAngle(): number

    getDistanceToObject

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    getDrawableX

    • getDrawableX(): number

    Returns number

    getDrawableX

    • getDrawableX(): number

    • Get the X position of the rendered object.

      For most objects, this will returns the same value as getX(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableX will differ.

      Returns number

      The X position of the rendered object.

      -

    getDrawableY

    • getDrawableY(): number

    getDrawableY

    • getDrawableY(): number

    • Get the Y position of the rendered object.

      For most objects, this will returns the same value as getY(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableY will differ.

      Returns number

      The Y position of the rendered object.

      -

    getElapsedTime

    getElapsedTime

    getEmitterAngle

    • getEmitterAngle(): number

    getEmitterAngleA

    • getEmitterAngleA(): number

    getEmitterAngleB

    • getEmitterAngleB(): number

    getEmitterForceMax

    • getEmitterForceMax(): number

    getEmitterForceMin

    • getEmitterForceMin(): number

    getFlow

    • getFlow(): number

    getHeight

    • getHeight(): number

    Returns number

    getEmitterAngle

    • getEmitterAngle(): number

    getEmitterAngleA

    • getEmitterAngleA(): number

    getEmitterAngleB

    • getEmitterAngleB(): number

    getEmitterForceMax

    • getEmitterForceMax(): number

    getEmitterForceMin

    • getEmitterForceMin(): number

    getFlow

    • getFlow(): number

    getHeight

    • getHeight(): number

    getHitBoxes

    getHitBoxes

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    • Return at least all the hit boxes that overlap a given area.

      The hit boxes don't need to actually overlap the area, (i.e: it's correct to return more hit boxes than those in the specified area) @@ -228,167 +228,167 @@

    • bottom: number

      bound of the area in scene coordinates

    Returns Iterable<Polygon>

    at least all the hit boxes that overlap a given area.

    -

    getInstanceContainer

    getInstanceContainer

    getLayer

    • getLayer(): string

    getLayer

    • getLayer(): string

    getMaxParticlesCount

    • getMaxParticlesCount(): number

    getName

    • getName(): string

    getMaxParticlesCount

    • getMaxParticlesCount(): number

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    • Get the identifier associated to an object name. Some features may want to compare objects name a large number of time. In this case, it may be more efficient to compare objects name identifiers.

      -
      static

      Parameters

      • name: string

      Returns number

    getNetworkSyncData

    getNetworkSyncData

    getParent

    getParent

    getParticleAlpha1

    • getParticleAlpha1(): number

    getParticleAlpha2

    • getParticleAlpha2(): number

    getParticleBlue1

    • getParticleBlue1(): number

    getParticleBlue2

    • getParticleBlue2(): number

    getParticleCount

    • getParticleCount(): number

    getParticleGravityAngle

    • getParticleGravityAngle(): number

    getParticleGravityLength

    • getParticleGravityLength(): number

    getParticleGravityX

    • getParticleGravityX(): number

    getParticleGravityY

    • getParticleGravityY(): number

    getParticleGreen1

    • getParticleGreen1(): number

    getParticleGreen2

    • getParticleGreen2(): number

    getParticleLifeTimeMax

    • getParticleLifeTimeMax(): number

    getParticleLifeTimeMin

    • getParticleLifeTimeMin(): number

    getParticleRed1

    • getParticleRed1(): number

    getParticleRed2

    • getParticleRed2(): number

    getParticleRotationMaxSpeed

    • getParticleRotationMaxSpeed(): number

    getParticleRotationMinSpeed

    • getParticleRotationMinSpeed(): number

    getParticleSize1

    • getParticleSize1(): number

    getParticleSize2

    • getParticleSize2(): number

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getParticleAlpha1

    • getParticleAlpha1(): number

    getParticleAlpha2

    • getParticleAlpha2(): number

    getParticleBlue1

    • getParticleBlue1(): number

    getParticleBlue2

    • getParticleBlue2(): number

    getParticleCount

    • getParticleCount(): number

    getParticleGravityAngle

    • getParticleGravityAngle(): number

    getParticleGravityLength

    • getParticleGravityLength(): number

    getParticleGravityX

    • getParticleGravityX(): number

    getParticleGravityY

    • getParticleGravityY(): number

    getParticleGreen1

    • getParticleGreen1(): number

    getParticleGreen2

    • getParticleGreen2(): number

    getParticleLifeTimeMax

    • getParticleLifeTimeMax(): number

    getParticleLifeTimeMin

    • getParticleLifeTimeMin(): number

    getParticleRed1

    • getParticleRed1(): number

    getParticleRed2

    • getParticleRed2(): number

    getParticleRotationMaxSpeed

    • getParticleRotationMaxSpeed(): number

    getParticleRotationMinSpeed

    • getParticleRotationMinSpeed(): number

    getParticleSize1

    • getParticleSize1(): number

    getParticleSize2

    • getParticleSize2(): number

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererObject

    • getRendererObject(): Container<DisplayObject>

    getRuntimeScene

    getRendererObject

    • getRendererObject(): Container<DisplayObject>

    getRuntimeScene

    getSqDistanceToObject

    getSqDistanceToObject

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    getTank

    • getTank(): number

    getTexture

    • getTexture(): string

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    Returns number

    getTank

    • getTank(): number

    getTexture

    • getTexture(): string

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    • Get a timer elapsed time.

      This is used by expressions to return 0 when a timer doesn't exist because numeric expressions must always return a number.

      Parameters

      • timerName: string

        The timer name.

      Returns number

      The timer elapsed time in seconds, 0 if the timer doesn't exist.

      -

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getUniqueId

    • getUniqueId(): number

    getUniqueId

    • getUniqueId(): number

    • Get the unique identifier of the object.
      The identifier is set by the runtimeScene owning the object.
      You can also use the id property (this._object.id) for increased efficiency instead of calling this method.

      Returns number

      The object identifier

      -

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableString

    • getVariableString(variable: Variable): string

    Static getVariableString

    • getVariableString(variable: Variable): string

    getVariables

    getVariables

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    • Get the AABB (axis aligned bounding box) to be used to determine if the object is visible on screen. The gdjs.RuntimeScene will hide the renderer object if the object is not visible on screen ("culling").

      The default implementation uses the AABB returned by getAABB.

      If null is returned, the object is assumed to be always visible.

      Returns null | AABB

      The bounding box or null.

      -

    getWidth

    • getWidth(): number

    getWidth

    • getWidth(): number

    getX

    • getX(): number

    getX

    • getX(): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    • Compute the X position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getY

    • getY(): number

    Returns number

    getY

    • getY(): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    • Compute the Y position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getZOrder

    • getZOrder(): number

    Returns number

    getZOrder

    • getZOrder(): number

    getZoneRadius

    • getZoneRadius(): number

    hasBehavior

    • hasBehavior(name: string): boolean

    getZoneRadius

    • getZoneRadius(): number

    hasBehavior

    • hasBehavior(name: string): boolean

    hasEffect

    • hasEffect(name: string): boolean

    Returns boolean

    hasEffect

    • hasEffect(name: string): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hide

    • hide(enable: boolean): void

    hide

    • hide(enable: boolean): void

    insideObject

    • insideObject(x: number, y: number): boolean

    Returns void

    insideObject

    • insideObject(x: number, y: number): boolean

    • Return true if the specified position is inside object bounding box.

      The position should be in "world" coordinates, i.e use gdjs.Layer.convertCoords if you need to pass the mouse or a touch position that you get from gdjs.InputManager. To check if a point is inside the object collision mask, you can use isCollidingWithPoint instead.

      -

      Parameters

      • x: number
      • y: number

      Returns boolean

    invalidateHitboxes

    • invalidateHitboxes(): void

    invalidateHitboxes

    • invalidateHitboxes(): void

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isEmitting

    • isEmitting(): boolean

    isHidden

    • isHidden(): boolean

    isEmitting

    • isEmitting(): boolean

    isHidden

    • isHidden(): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    • Return true if the angle of the total force applied on the object is in a given range.

      Parameters

      • angle: number
        @@ -397,43 +397,43 @@

        The maximum distance from the given angle.

      Returns boolean

      true if the difference between the force angle the given angle is less or equals the toleranceInDegrees.

      -

    isVisible

    • isVisible(): boolean

    isVisible

    • isVisible(): boolean

    • Return true if the object is not hidden.

      Note: This is unrelated to the actual visibility of the object on the screen. For this, see getVisibilityAABB to get the bounding boxes of the object as displayed on the scene.

      Returns boolean

      true if the object is not hidden.

      -

    jumpEmitterForwardInTime

    • jumpEmitterForwardInTime(timeSkipped: number): void

    noMoreParticles

    • noMoreParticles(): boolean

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    jumpEmitterForwardInTime

    • jumpEmitterForwardInTime(timeSkipped: number): void

    noMoreParticles

    • noMoreParticles(): boolean

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    • To be called by the child classes in their constructor, at the very end. Notify the behaviors that they have been constructed (this must be done when the object is ready, otherwise behaviors can do operations on the object which could be not initialized yet).

      If you redefine this function, make sure to call the original method (RuntimeObject.prototype.onCreated.call(this);).

      -

      Returns void

    onDeletedFromScene

    onDeletedFromScene

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    Returns void

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    onSceneResumed

    Returns void

    onSceneResumed

    pauseTimer

    • pauseTimer(timerName: string): void

    Returns void

    pauseTimer

    • pauseTimer(timerName: string): void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    Returns void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    • Put the object around a position, with a specific distance and angle. The distance and angle are computed between the position and the center of the object.

      Parameters

      • x: number
        @@ -444,7 +444,7 @@

        The distance between the object and the target, in pixels.

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    • Put the object around another object, with a specific distance and angle. The distance and angle are computed between the centers of the objects.

      Parameters

      • obj: null | RuntimeObject
        @@ -453,7 +453,7 @@

        The distance between the object and the target

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    recreateParticleSystem

    • recreateParticleSystem(): void

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    recreateParticleSystem

    • recreateParticleSystem(): void

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    • Called to reset the object to its default state. This is used for objects that are "recycled": they are dismissed (at which point onDestroyFromScene is called) but still stored in a cache to be reused next time an object must be created. At this point, @@ -479,7 +479,7 @@

    • The _runtimeScene, _nameId, name and type are guaranteed to stay the same and do not need to be set again.
    -

    Parameters

    • objectData: ObjectData

    Returns void

    removeBehavior

    • removeBehavior(name: string): boolean

    removeBehavior

    • removeBehavior(name: string): boolean

    • Remove the behavior with the given name. Usually only used by hot-reloading, as performance of this operation is not guaranteed (in the future, this could lead to re-organization of arrays @@ -487,69 +487,69 @@

      Parameters

      • name: string

        The name of the behavior to remove.

      Returns boolean

      true if the behavior was properly removed, false otherwise.

      -

    removeEffect

    • removeEffect(effectName: string): boolean

    removeEffect

    • removeEffect(effectName: string): boolean

    removeTimer

    • removeTimer(timerName: string): void

    Returns boolean

    removeTimer

    • removeTimer(timerName: string): void

    resetTimer

    • resetTimer(timerName: string): void

    Returns void

    resetTimer

    • resetTimer(timerName: string): void

    Static returnVariable

    Returns void

    Static returnVariable

    rotate

    rotate

    rotateTowardAngle

    rotateTowardAngle

    rotateTowardPosition

    • rotateTowardPosition(x: number, y: number, speed: number, scene: RuntimeScene): void

    separateFromObjects

    • separateFromObjects(objects: RuntimeObject[], ignoreTouchingEdges: boolean): boolean

    Returns void

    rotateTowardPosition

    • rotateTowardPosition(x: number, y: number, speed: number, scene: RuntimeScene): void

    separateFromObjects

    • separateFromObjects(objects: RuntimeObject[], ignoreTouchingEdges: boolean): boolean

    • Separate the object from others objects, using their hitboxes.

      Parameters

      • objects: RuntimeObject[]

        Objects

      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if the object was moved

      -

    separateFromObjectsList

    • separateFromObjectsList(objectsLists: ObjectsLists, ignoreTouchingEdges: boolean): boolean

    separateFromObjectsList

    • separateFromObjectsList(objectsLists: ObjectsLists, ignoreTouchingEdges: boolean): boolean

    • Separate the object from others objects, using their hitboxes.

      Parameters

      • objectsLists: ObjectsLists

        Tables of objects

      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if the object was moved

      -

    separateObjectsWithForces

    • separateObjectsWithForces(objectsLists: ObjectsLists): void

    separateObjectsWithForces

    • separateObjectsWithForces(objectsLists: ObjectsLists): void

    separateObjectsWithoutForces

    • separateObjectsWithoutForces(objectsLists: ObjectsLists): void

    separateObjectsWithoutForces

    • separateObjectsWithoutForces(objectsLists: ObjectsLists): void

    setAdditiveRendering

    • setAdditiveRendering(enabled: boolean): void

    setAngle

    • setAngle(angle: any): void

    Returns void

    setAdditiveRendering

    • setAdditiveRendering(enabled: boolean): void

    setAngle

    • setAngle(angle: any): void

    setCenterPositionInScene

    • setCenterPositionInScene(x: number, y: number): void

    setCenterPositionInScene

    • setCenterPositionInScene(x: number, y: number): void

    setCenterXInScene

    • setCenterXInScene(x: number): void

    Returns void

    setCenterXInScene

    • setCenterXInScene(x: number): void

    setCenterYInScene

    • setCenterYInScene(y: number): void

    Returns void

    setCenterYInScene

    • setCenterYInScene(y: number): void

    setConeSprayAngle

    • setConeSprayAngle(angle: number): void

    setEffectBooleanParameter

    • setEffectBooleanParameter(name: string, parameterName: string, value: boolean): boolean

    setConeSprayAngle

    • setConeSprayAngle(angle: number): void

    setEffectBooleanParameter

    • setEffectBooleanParameter(name: string, parameterName: string, value: boolean): boolean

    setEffectDoubleParameter

    • setEffectDoubleParameter(name: string, parameterName: string, value: number): boolean

    Returns boolean

    setEffectDoubleParameter

    • setEffectDoubleParameter(name: string, parameterName: string, value: number): boolean

    setEffectStringParameter

    • setEffectStringParameter(name: string, parameterName: string, value: string): boolean

    Returns boolean

    setEffectStringParameter

    • setEffectStringParameter(name: string, parameterName: string, value: string): boolean

    setEmitterAngle

    • setEmitterAngle(angle: number): void

    setEmitterAngleA

    • setEmitterAngleA(angle: number): void

    setEmitterAngleB

    • setEmitterAngleB(angle: number): void

    setEmitterForceMax

    • setEmitterForceMax(force: number): void

    setEmitterForceMin

    • setEmitterForceMin(force: number): void

    setFlow

    • setFlow(flow: number): void

    setHeight

    • setHeight(height: number): void

    Returns boolean

    setEmitterAngle

    • setEmitterAngle(angle: number): void

    setEmitterAngleA

    • setEmitterAngleA(angle: number): void

    setEmitterAngleB

    • setEmitterAngleB(angle: number): void

    setEmitterForceMax

    • setEmitterForceMax(force: number): void

    setEmitterForceMin

    • setEmitterForceMin(force: number): void

    setFlow

    • setFlow(flow: number): void

    setHeight

    • setHeight(height: number): void

    setIncludedInParentCollisionMask

    • setIncludedInParentCollisionMask(isIncluded: boolean): void

    setLayer

    • setLayer(layer: string): void

    Returns void

    setIncludedInParentCollisionMask

    • setIncludedInParentCollisionMask(isIncluded: boolean): void

    setLayer

    • setLayer(layer: string): void

    setMaxParticlesCount

    • setMaxParticlesCount(count: number): void

    setParticleAlpha1

    • setParticleAlpha1(alpha: number): void

    setParticleAlpha2

    • setParticleAlpha2(alpha: number): void

    setParticleBlue1

    • setParticleBlue1(blue: number): void

    setParticleBlue2

    • setParticleBlue2(blue: number): void

    setParticleColor1

    • setParticleColor1(rgbColor: string): void

    setParticleColor2

    • setParticleColor2(rgbColor: string): void

    setParticleGravityAngle

    • setParticleGravityAngle(angle: number): void

    setParticleGravityLength

    • setParticleGravityLength(length: number): void

    setParticleGravityX

    • setParticleGravityX(x: number): void

    setParticleGravityY

    • setParticleGravityY(y: number): void

    setParticleGreen1

    • setParticleGreen1(green: number): void

    setParticleGreen2

    • setParticleGreen2(green: number): void

    setParticleLifeTimeMax

    • setParticleLifeTimeMax(lifeTime: number): void

    setParticleLifeTimeMin

    • setParticleLifeTimeMin(lifeTime: number): void

    setParticleRed1

    • setParticleRed1(red: number): void

    setParticleRed2

    • setParticleRed2(red: number): void

    setParticleRotationMaxSpeed

    • setParticleRotationMaxSpeed(speed: number): void

    setParticleRotationMinSpeed

    • setParticleRotationMinSpeed(speed: number): void

    setParticleSize1

    • setParticleSize1(size: number): void

    setParticleSize2

    • setParticleSize2(size: number): void

    setPosition

    • setPosition(x: number, y: number): void

    Returns void

    setMaxParticlesCount

    • setMaxParticlesCount(count: number): void

    setParticleAlpha1

    • setParticleAlpha1(alpha: number): void

    setParticleAlpha2

    • setParticleAlpha2(alpha: number): void

    setParticleBlue1

    • setParticleBlue1(blue: number): void

    setParticleBlue2

    • setParticleBlue2(blue: number): void

    setParticleColor1

    • setParticleColor1(rgbColor: string): void

    setParticleColor2

    • setParticleColor2(rgbColor: string): void

    setParticleGravityAngle

    • setParticleGravityAngle(angle: number): void

    setParticleGravityLength

    • setParticleGravityLength(length: number): void

    setParticleGravityX

    • setParticleGravityX(x: number): void

    setParticleGravityY

    • setParticleGravityY(y: number): void

    setParticleGreen1

    • setParticleGreen1(green: number): void

    setParticleGreen2

    • setParticleGreen2(green: number): void

    setParticleLifeTimeMax

    • setParticleLifeTimeMax(lifeTime: number): void

    setParticleLifeTimeMin

    • setParticleLifeTimeMin(lifeTime: number): void

    setParticleRed1

    • setParticleRed1(red: number): void

    setParticleRed2

    • setParticleRed2(red: number): void

    setParticleRotationMaxSpeed

    • setParticleRotationMaxSpeed(speed: number): void

    setParticleRotationMinSpeed

    • setParticleRotationMinSpeed(speed: number): void

    setParticleSize1

    • setParticleSize1(size: number): void

    setParticleSize2

    • setParticleSize2(size: number): void

    setPosition

    • setPosition(x: number, y: number): void

    setTank

    • setTank(tank: number): void

    setTexture

    Static setVariableNumber

    • setVariableNumber(variable: Variable, newValue: number): void

    Returns void

    setTank

    • setTank(tank: number): void

    setTexture

    Static setVariableNumber

    • setVariableNumber(variable: Variable, newValue: number): void

    Static setVariableString

    • setVariableString(variable: Variable, newValue: string): void

    Returns void

    Static setVariableString

    • setVariableString(variable: Variable, newValue: string): void

    setWidth

    • setWidth(width: number): void

    Returns void

    setWidth

    • setWidth(width: number): void

    setX

    • setX(x: number): void

    Returns void

    setX

    • setX(x: number): void

    setY

    • setY(y: number): void

    setY

    • setY(y: number): void

    setZOrder

    • setZOrder(z: number): void

    setZOrder

    • setZOrder(z: number): void

    setZoneRadius

    • setZoneRadius(radius: number): void

    startEmission

    • startEmission(): void

    stepBehaviorsPostEvents

    Returns void

    setZoneRadius

    • setZoneRadius(radius: number): void

    startEmission

    • startEmission(): void

    stepBehaviorsPostEvents

    stepBehaviorsPreEvents

    stepBehaviorsPreEvents

    stopEmission

    • stopEmission(): void

    timerElapsedTime

    • timerElapsedTime(timerName: string, timeInSeconds: number): boolean

    stopEmission

    • stopEmission(): void

    timerElapsedTime

    • timerElapsedTime(timerName: string, timeInSeconds: number): boolean

    • Compare a timer elapsed time. If the timer does not exist, it is created.

      deprecated

      prefer using getTimerElapsedTimeInSecondsOrNaN.

      Parameters

      • timerName: string
        @@ -625,168 +625,168 @@
      • timeInSeconds: number

        The time value to check in seconds.

      Returns boolean

      True if the timer exists and its value is greater than or equal than the given time, false otherwise.

      -

    timerPaused

    • timerPaused(timerName: string): boolean

    timerPaused

    • timerPaused(timerName: string): boolean

    unpauseTimer

    • unpauseTimer(timerName: string): void

    unpauseTimer

    • unpauseTimer(timerName: string): void

    unregisterDestroyCallback

    • unregisterDestroyCallback(callback: () => void): void

    update

    Returns void

    unregisterDestroyCallback

    • unregisterDestroyCallback(callback: () => void): void

    update

    updateAABB

    • updateAABB(): void

    updateAABB

    • updateAABB(): void

    • Update the AABB (axis aligned bounding box) for the object.

      Default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box.

      You should not call this function by yourself, it is called when necessary by getAABB method. However, you can redefine it if your object can have a faster implementation.

      -

      Returns void

    updateAllEffectParameters

    • updateAllEffectParameters(effectData: EffectData): boolean

    updateAllEffectParameters

    • updateAllEffectParameters(effectData: EffectData): boolean

    updateForces

    • updateForces(elapsedTime: number): void

    Returns boolean

    updateForces

    • updateForces(elapsedTime: number): void

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    updateFromObjectData

    updateFromObjectData

    updateHitBoxes

    • updateHitBoxes(): void

    updateHitBoxes

    • updateHitBoxes(): void

    • Update the hit boxes for the object.

      The default implementation set a basic bounding box based on the size (getWidth and getHeight) and the center point of the object (getCenterX and getCenterY). Result is cached until invalidated (by a position change, angle change...).

      You should not call this function by yourself, it is called when necessary by getHitBoxes method. However, you can redefine it if your object need custom hit boxes.

      -

      Returns void

    updatePreRender

    updatePreRender

    updateTimers

    • updateTimers(elapsedTime: number): void

    Returns void

    updateTimers

    • updateTimers(elapsedTime: number): void

    Properties

    additiveRendering

    additiveRendering: boolean

    alpha1

    alpha1: number

    alpha2

    alpha2: number

    angle

    angle: number = 0

    angleA

    angleA: number
    deprecated

    Data not used

    -

    angleB

    angleB: number

    colorB1

    colorB1: number

    colorB2

    colorB2: number

    colorG1

    colorG1: number

    colorG2

    colorG2: number

    colorR1

    colorR1: number

    colorR2

    colorR2: number

    destroyWhenNoParticles

    destroyWhenNoParticles: boolean

    flow

    flow: number

    forceMax

    forceMax: number

    forceMin

    forceMin: number

    Static forcesGarbage

    forcesGarbage: Force[] = []
    +

    Returns void

    Properties

    additiveRendering

    additiveRendering: boolean

    alpha1

    alpha1: number

    alpha2

    alpha2: number

    angle

    angle: number = 0

    angleA

    angleA: number
    deprecated

    Data not used

    +

    angleB

    angleB: number

    colorB1

    colorB1: number

    colorB2

    colorB2: number

    colorG1

    colorG1: number

    colorG2

    colorG2: number

    colorR1

    colorR1: number

    colorR2

    colorR2: number

    destroyWhenNoParticles

    destroyWhenNoParticles: boolean

    flow

    flow: number

    forceMax

    forceMax: number

    forceMin

    forceMin: number

    Static forcesGarbage

    forcesGarbage: Force[] = []

    Global container for unused forces, avoiding recreating forces each tick.

    -
    static

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number
      • +

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number

      • Get the squared distance, in pixels, between the center of this object and a position.

        Parameters

        • targetX: number

          Target X position

        • targetY: number

          Target Y position

          -

        Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • +

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • Get the number of children from a variable

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The number of children

        -

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

      • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The value of the specified variable

        -

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

      • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns string

        The string of the specified variable

        -

    gravityX

    gravityX: number

    gravityY

    gravityY: number

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    jumpForwardInTimeOnCreation

    jumpForwardInTimeOnCreation: number

    layer

    layer: string = ''

    lifeTimeMax

    lifeTimeMax: number

    lifeTimeMin

    lifeTimeMin: number

    maxParticlesCount

    maxParticlesCount: number

    name

    name: string

    networkId

    networkId: null | string = null
    +

    gravityX

    gravityX: number

    gravityY

    gravityY: number

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    jumpForwardInTimeOnCreation

    jumpForwardInTimeOnCreation: number

    layer

    layer: string = ''

    lifeTimeMax

    lifeTimeMax: number

    lifeTimeMin

    lifeTimeMin: number

    maxParticlesCount

    maxParticlesCount: number

    name

    name: string

    networkId

    networkId: null | string = null

    A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

    -

    particleRotationMaxSpeed

    particleRotationMaxSpeed: number

    particleRotationMinSpeed

    particleRotationMinSpeed: number

    persistentUuid

    persistentUuid: null | string = null
    +

    particleRotationMaxSpeed

    particleRotationMaxSpeed: number

    particleRotationMinSpeed

    particleRotationMinSpeed: number

    persistentUuid

    persistentUuid: null | string = null

    An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

    -

    pick

    pick: boolean = false
    +

    pick

    pick: boolean = false

    A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

    -

    rendererParam1

    rendererParam1: number

    rendererParam2

    rendererParam2: number

    rendererType

    rendererType: string

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

    rendererParam1

    rendererParam1: number

    rendererParam2

    rendererParam2: number

    rendererType

    rendererType: string

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

      • Return the variable passed as argument without any change. Only for usage by events.

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns Variable

        The specified variable

        -

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void
      • +

      Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void

      • Shortcut to set the value of a variable considered as a number

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: number

          The value to be set

          -

        Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void
      • +

      Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void

      • Shortcut to set the value of a variable considered as a string

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: string

          The value to be set

          -

        Returns void

    size1

    size1: number

    size2

    size2: number

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    tank

    tank: number

    texture

    texture: string

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • +

      Returns void

    size1

    size1: number

    size2

    size2: number

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    tank

    tank: number

    texture

    texture: string

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable
          +

          Parameters

          • array: Variable
          • value: string | number | boolean

          Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable

          The variable to be tested

        • childName: string

          The name of the child

          -

        Returns boolean

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

      • static

        Parameters

        • variable: Variable

          The variable to be cleared

          -

        Returns void

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

        • variable: Variable

          The variable to be changed

        • childName: string

          The name of the child

          -

        Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    zoneRadius

    zoneRadius: number

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    zoneRadius

    zoneRadius: number

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • +

      Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Constructors

    constructor

    Constructors

    constructor

    activated

    • activated(): boolean

    doStepPostEvents

    doStepPostEvents

    doStepPreEvents

    doStepPreEvents

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getAABB

    getCost

    • getCost(): number

    getName

    • getName(): string

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getAABB

    getCost

    • getCost(): number

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    isImpassable

    • isImpassable(): boolean

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    isImpassable

    • isImpassable(): boolean

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    onDeActivate

    • onDeActivate(): void

    onDeActivate

    • onDeActivate(): void

    onDestroy

    • onDestroy(): void

    onDestroy

    • onDestroy(): void

    onObjectHotReloaded

    • onObjectHotReloaded(): void

    onObjectHotReloaded

    • onObjectHotReloaded(): void

    setCost

    • setCost(cost: number): void

    setImpassable

    • setImpassable(impassable: boolean): void

    stepPostEvents

    setCost

    • setCost(cost: number): void

    setImpassable

    • setImpassable(impassable: boolean): void

    stepPostEvents

    stepPreEvents

    Returns void

    stepPreEvents

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    Returns void

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    Returns void

    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

    Constructors

    constructor

    Properties

    currentRBushAABB

    currentRBushAABB: null | BehaviorRBushAABB<PathfindingObstacleRuntimeBehavior> = null

    name

    name: string

    owner

    owner: RuntimeObject

    type

    type: string

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Node

    Internal tool class representing a node when looking for a path

    -

    Hierarchy

    • Node

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new Node(xPos: number, yPos: number): Node

    Properties

    cost

    cost: number = 0

    estimateCost

    estimateCost: number = -1

    open

    open: boolean = true

    parent

    parent: null | Node = null

    pos

    pos: FloatPoint

    smallestCost

    smallestCost: number = -1

    Methods

    reinitialize

    • reinitialize(xPos: number, yPos: number): void

    Generated using TypeDoc

    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

    Hierarchy

    Index

    Methods

    Constructors

    Properties

    Methods

    activate

    • activate(enable: boolean): void

    activated

    • activated(): boolean

    Returns void

    activated

    • activated(): boolean

    allowDiagonals

    • allowDiagonals(allow: boolean): void

    destinationReached

    • destinationReached(): boolean

    allowDiagonals

    • allowDiagonals(allow: boolean): void

    destinationReached

    • destinationReached(): boolean

    diagonalsAllowed

    • diagonalsAllowed(): boolean

    doStepPostEvents

    diagonalsAllowed

    • diagonalsAllowed(): boolean

    doStepPostEvents

    doStepPreEvents

    doStepPreEvents

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    Static euclideanDistance

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

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    Static euclideanDistance

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

    getAcceleration

    • getAcceleration(): number

    getAngleOffset

    • getAngleOffset(): number

    getAngularMaxSpeed

    • getAngularMaxSpeed(): number

    getCellHeight

    • getCellHeight(): number

    getCellWidth

    • getCellWidth(): number

    getDestinationX

    • getDestinationX(): number

    getDestinationY

    • getDestinationY(): number

    getExtraBorder

    • getExtraBorder(): number

    getGridOffsetX

    • getGridOffsetX(): number

    getGridOffsetY

    • getGridOffsetY(): number

    getLastNodeX

    • getLastNodeX(): number

    getLastNodeY

    • getLastNodeY(): number

    getMaxSpeed

    • getMaxSpeed(): number

    getMovementAngle

    • getMovementAngle(): number

    getName

    • getName(): string

    getAcceleration

    • getAcceleration(): number

    getAngleOffset

    • getAngleOffset(): number

    getAngularMaxSpeed

    • getAngularMaxSpeed(): number

    getCellHeight

    • getCellHeight(): number

    getCellWidth

    • getCellWidth(): number

    getDestinationX

    • getDestinationX(): number

    getDestinationY

    • getDestinationY(): number

    getExtraBorder

    • getExtraBorder(): number

    getGridOffsetX

    • getGridOffsetX(): number

    getGridOffsetY

    • getGridOffsetY(): number

    getLastNodeX

    • getLastNodeX(): number

    getLastNodeY

    • getLastNodeY(): number

    getMaxSpeed

    • getMaxSpeed(): number

    getMovementAngle

    • getMovementAngle(): number

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    getNetworkSyncData

    getNextNodeIndex

    • getNextNodeIndex(): number

    getNextNodeX

    • getNextNodeX(): number

    getNextNodeY

    • getNextNodeY(): number

    getNodeCount

    • getNodeCount(): number

    getNodeX

    • getNodeX(index: number): number

    getNodeY

    • getNodeY(index: number): number

    getSpeed

    • getSpeed(): number

    isObjectRotated

    • isObjectRotated(): boolean

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    Static manhattanDistance

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

    getNetworkSyncData

    getNextNodeIndex

    • getNextNodeIndex(): number

    getNextNodeX

    • getNextNodeX(): number

    getNextNodeY

    • getNextNodeY(): number

    getNodeCount

    • getNodeCount(): number

    getNodeX

    • getNodeX(index: number): number

    getNodeY

    • getNodeY(index: number): number

    getSpeed

    • getSpeed(): number

    isObjectRotated

    • isObjectRotated(): boolean

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    Static manhattanDistance

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

    moveTo

    moveTo

    movementAngleIsAround

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

    onActivate

    • onActivate(): void

    movementAngleIsAround

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

    onActivate

    • onActivate(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    onDeActivate

    • onDeActivate(): void

    onDeActivate

    • onDeActivate(): void

    onDestroy

    • onDestroy(): 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

    onObjectHotReloaded

    • onObjectHotReloaded(): void

    pathFound

    • pathFound(): boolean

    pathFound

    • pathFound(): boolean

    setAcceleration

    • setAcceleration(acceleration: number): void

    setAngleOffset

    • setAngleOffset(angleOffset: number): void

    setAngularMaxSpeed

    • setAngularMaxSpeed(angularMaxSpeed: number): void

    setCellHeight

    • setCellHeight(height: number): void

    setCellWidth

    • setCellWidth(width: number): void

    setExtraBorder

    • setExtraBorder(extraBorder: any): void

    setGridOffsetX

    • setGridOffsetX(gridOffsetX: number): void

    setGridOffsetY

    • setGridOffsetY(gridOffsetY: number): void

    setMaxSpeed

    • setMaxSpeed(maxSpeed: number): void

    setRotateObject

    • setRotateObject(allow: boolean): void

    setSpeed

    • setSpeed(speed: number): void

    stepPostEvents

    setAcceleration

    • setAcceleration(acceleration: number): void

    setAngleOffset

    • setAngleOffset(angleOffset: number): void

    setAngularMaxSpeed

    • setAngularMaxSpeed(angularMaxSpeed: number): void

    setCellHeight

    • setCellHeight(height: number): void

    setCellWidth

    • setCellWidth(width: number): void

    setExtraBorder

    • setExtraBorder(extraBorder: any): void

    setGridOffsetX

    • setGridOffsetX(gridOffsetX: number): void

    setGridOffsetY

    • setGridOffsetY(gridOffsetY: number): void

    setMaxSpeed

    • setMaxSpeed(maxSpeed: number): void

    setRotateObject

    • setRotateObject(allow: boolean): void

    setSpeed

    • setSpeed(speed: number): void

    stepPostEvents

    stepPreEvents

    Returns void

    stepPreEvents

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    Returns void

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    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

    Constructors

    constructor

    Properties

    name

    name: string

    owner

    owner: RuntimeObject

    type

    type: string

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Physics2RuntimeBehavior

    Hierarchy

    Index

    Methods

    Properties

    Constructors

    Methods

    activate

    • activate(enable: boolean): void

    activated

    • activated(): boolean

    addDistanceJoint

    • addDistanceJoint(x1: number, y1: number, other: null | RuntimeObject, x2: number, y2: number, length: number, frequency: number, dampingRatio: number, collideConnected: boolean, variable: Variable): void

    addFrictionJoint

    • addFrictionJoint(x1: number, y1: number, other: null | RuntimeObject, x2: number, y2: number, maxForce: number, maxTorque: number, collideConnected: boolean, variable: Variable): void

    addGearJoint

    • addGearJoint(jointId1: any, jointId2: any, ratio: any, collideConnected: any, variable: any): void

    addMotorJoint

    • addMotorJoint(other: null | RuntimeObject, offsetX: number, offsetY: number, offsetAngle: number, maxForce: number, maxTorque: number, correctionFactor: number, collideConnected: boolean, variable: Variable): void

    addMouseJoint

    • addMouseJoint(targetX: number, targetY: number, maxForce: number, frequency: number, dampingRatio: number, variable: Variable): void

    addPrismaticJoint

    • addPrismaticJoint(x1: number, y1: number, other: null | RuntimeObject, x2: number, y2: number, axisAngle: number, referenceAngle: number, enableLimit: boolean, lowerTranslation: number, upperTranslation: number, enableMotor: boolean, motorSpeed: number, maxMotorForce: number, collideConnected: boolean, variable: Variable): void

    addPulleyJoint

    • addPulleyJoint(x1: number, y1: number, other: null | RuntimeObject, x2: number, y2: number, groundX1: number, groundY1: number, groundX2: number, groundY2: number, lengthA: number, lengthB: number, ratio: number, collideConnected: boolean, variable: Variable): void

    addRevoluteJoint

    • addRevoluteJoint(x: number, y: number, enableLimit: boolean, referenceAngle: number, lowerAngle: number, upperAngle: number, enableMotor: boolean, motorSpeed: number, maxMotorTorque: number, variable: Variable): void

    addRevoluteJointBetweenTwoBodies

    • addRevoluteJointBetweenTwoBodies(x1: number, y1: number, other: null | RuntimeObject, x2: number, y2: number, enableLimit: boolean, referenceAngle: number, lowerAngle: number, upperAngle: number, enableMotor: boolean, motorSpeed: number, maxMotorTorque: number, collideConnected: boolean, variable: Variable): void

    addRopeJoint

    • addRopeJoint(x1: number, y1: number, other: null | RuntimeObject, x2: number, y2: number, maxLength: number, collideConnected: boolean, variable: Variable): void

    addWeldJoint

    • addWeldJoint(x1: number, y1: number, other: null | RuntimeObject, x2: number, y2: number, referenceAngle: number, frequency: number, dampingRatio: number, collideConnected: boolean, variable: Variable): void

    addWheelJoint

    • addWheelJoint(x1: number, y1: number, other: null | RuntimeObject, x2: number, y2: number, axisAngle: number, frequency: number, dampingRatio: number, enableMotor: boolean, motorSpeed: number, maxMotorTorque: number, collideConnected: boolean, variable: Variable): void

    applyAngularImpulse

    • applyAngularImpulse(angularImpulse: number): void

    applyForce

    • applyForce(forceX: number, forceY: number, positionX: number, positionY: number): void

    applyForceTowardPosition

    • applyForceTowardPosition(length: number, towardX: number, towardY: number, positionX: number, positionY: number): void

    applyImpulse

    • applyImpulse(impulseX: number, impulseY: number, positionX: number, positionY: number): void

    applyImpulseTowardPosition

    • applyImpulseTowardPosition(length: number, towardX: number, towardY: number, positionX: number, positionY: number): void

    applyPolarForce

    • applyPolarForce(angle: number, length: number, positionX: number, positionY: number): void

    applyPolarImpulse

    • applyPolarImpulse(angle: number, length: number, positionX: number, positionY: number): void

    applyTorque

    • applyTorque(torque: number): void

    Static areObjectsColliding

    b2Vec2

    • b2Vec2(x: number, y: number): b2Vec2

    b2Vec2Sec

    • b2Vec2Sec(x: number, y: number): b2Vec2

    createBody

    • createBody(): boolean

    createShape

    • createShape(): b2FixtureDef

    doStepPostEvents

    addDistanceJoint

    • addDistanceJoint(x1: number, y1: number, other: null | RuntimeObject, x2: number, y2: number, length: number, frequency: number, dampingRatio: number, collideConnected: boolean, variable: Variable): void

    addFrictionJoint

    • addFrictionJoint(x1: number, y1: number, other: null | RuntimeObject, x2: number, y2: number, maxForce: number, maxTorque: number, collideConnected: boolean, variable: Variable): void

    addGearJoint

    • addGearJoint(jointId1: any, jointId2: any, ratio: any, collideConnected: any, variable: any): void

    addMotorJoint

    • addMotorJoint(other: null | RuntimeObject, offsetX: number, offsetY: number, offsetAngle: number, maxForce: number, maxTorque: number, correctionFactor: number, collideConnected: boolean, variable: Variable): void

    addMouseJoint

    • addMouseJoint(targetX: number, targetY: number, maxForce: number, frequency: number, dampingRatio: number, variable: Variable): void

    addPrismaticJoint

    • addPrismaticJoint(x1: number, y1: number, other: null | RuntimeObject, x2: number, y2: number, axisAngle: number, referenceAngle: number, enableLimit: boolean, lowerTranslation: number, upperTranslation: number, enableMotor: boolean, motorSpeed: number, maxMotorForce: number, collideConnected: boolean, variable: Variable): void

    addPulleyJoint

    • addPulleyJoint(x1: number, y1: number, other: null | RuntimeObject, x2: number, y2: number, groundX1: number, groundY1: number, groundX2: number, groundY2: number, lengthA: number, lengthB: number, ratio: number, collideConnected: boolean, variable: Variable): void

    addRevoluteJoint

    • addRevoluteJoint(x: number, y: number, enableLimit: boolean, referenceAngle: number, lowerAngle: number, upperAngle: number, enableMotor: boolean, motorSpeed: number, maxMotorTorque: number, variable: Variable): void

    addRevoluteJointBetweenTwoBodies

    • addRevoluteJointBetweenTwoBodies(x1: number, y1: number, other: null | RuntimeObject, x2: number, y2: number, enableLimit: boolean, referenceAngle: number, lowerAngle: number, upperAngle: number, enableMotor: boolean, motorSpeed: number, maxMotorTorque: number, collideConnected: boolean, variable: Variable): void

    addRopeJoint

    • addRopeJoint(x1: number, y1: number, other: null | RuntimeObject, x2: number, y2: number, maxLength: number, collideConnected: boolean, variable: Variable): void

    addWeldJoint

    • addWeldJoint(x1: number, y1: number, other: null | RuntimeObject, x2: number, y2: number, referenceAngle: number, frequency: number, dampingRatio: number, collideConnected: boolean, variable: Variable): void

    addWheelJoint

    • addWheelJoint(x1: number, y1: number, other: null | RuntimeObject, x2: number, y2: number, axisAngle: number, frequency: number, dampingRatio: number, enableMotor: boolean, motorSpeed: number, maxMotorTorque: number, collideConnected: boolean, variable: Variable): void

    applyAngularImpulse

    • applyAngularImpulse(angularImpulse: number): void

    applyForce

    • applyForce(forceX: number, forceY: number, positionX: number, positionY: number): void

    applyForceTowardPosition

    • applyForceTowardPosition(length: number, towardX: number, towardY: number, positionX: number, positionY: number): void

    applyImpulse

    • applyImpulse(impulseX: number, impulseY: number, positionX: number, positionY: number): void

    applyImpulseTowardPosition

    • applyImpulseTowardPosition(length: number, towardX: number, towardY: number, positionX: number, positionY: number): void

    applyPolarForce

    • applyPolarForce(angle: number, length: number, positionX: number, positionY: number): void

    applyPolarImpulse

    • applyPolarImpulse(angle: number, length: number, positionX: number, positionY: number): void

    applyTorque

    • applyTorque(torque: number): void

    Static areObjectsColliding

    b2Vec2

    • b2Vec2(x: number, y: number): b2Vec2

    b2Vec2Sec

    • b2Vec2Sec(x: number, y: number): b2Vec2

    createBody

    • createBody(): boolean

    createShape

    • createShape(): b2FixtureDef

    doStepPostEvents

    doStepPreEvents

    doStepPreEvents

    enableLayer

    • enableLayer(layer: number, enable: boolean): void

    enableMask

    • enableMask(mask: number, enable: boolean): void

    enablePrismaticJointLimits

    • enablePrismaticJointLimits(jointId: string | number, enable: boolean): void

    enablePrismaticJointMotor

    • enablePrismaticJointMotor(jointId: string | number, enable: boolean): void

    enableRevoluteJointLimits

    • enableRevoluteJointLimits(jointId: string | number, enable: boolean): void

    enableRevoluteJointMotor

    • enableRevoluteJointMotor(jointId: string | number, enable: any): void

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    enableWheelJointMotor

    • enableWheelJointMotor(jointId: string | number, enable: any): void

    getAngularDamping

    • getAngularDamping(): number

    getAngularVelocity

    • getAngularVelocity(): number

    getBody

    • getBody(): b2Body

    getDensity

    • getDensity(): number

    getDistanceJointDampingRatio

    • getDistanceJointDampingRatio(jointId: string | number): number

    getDistanceJointFrequency

    • getDistanceJointFrequency(jointId: string | number): number

    getDistanceJointLength

    • getDistanceJointLength(jointId: string | number): number

    getFriction

    • getFriction(): number

    getFrictionJointMaxForce

    • getFrictionJointMaxForce(jointId: string | number): number

    getFrictionJointMaxTorque

    • getFrictionJointMaxTorque(jointId: string | number): number

    getGearJointFirstJoint

    • getGearJointFirstJoint(jointId: string | number): number

    getGearJointRatio

    • getGearJointRatio(jointId: string | number): number

    getGearJointSecondJoint

    • getGearJointSecondJoint(jointId: string | number): number

    getGravityScale

    • getGravityScale(): number

    getGravityX

    • getGravityX(): number

    getGravityY

    • getGravityY(): number

    getInertia

    • getInertia(): number

    getJointFirstAnchorX

    • getJointFirstAnchorX(jointId: string | number): number

    getJointFirstAnchorY

    • getJointFirstAnchorY(jointId: string | number): number

    getJointReactionForce

    • getJointReactionForce(jointId: string | number): number

    getJointReactionTorque

    • getJointReactionTorque(jointId: string | number): number

    getJointSecondAnchorX

    • getJointSecondAnchorX(jointId: string | number): number

    getJointSecondAnchorY

    • getJointSecondAnchorY(jointId: string | number): number

    getLinearDamping

    • getLinearDamping(): number

    getLinearVelocityAngle

    • getLinearVelocityAngle(): number

    getLinearVelocityLength

    • getLinearVelocityLength(): number

    getLinearVelocityX

    • getLinearVelocityX(): number

    getLinearVelocityY

    • getLinearVelocityY(): number

    getMass

    • getMass(): number

    getMassCenterX

    • getMassCenterX(): number

    getMassCenterY

    • getMassCenterY(): number

    getMotorJointAngularOffset

    • getMotorJointAngularOffset(jointId: string | number): number

    getMotorJointCorrectionFactor

    • getMotorJointCorrectionFactor(jointId: string | number): number

    getMotorJointMaxForce

    • getMotorJointMaxForce(jointId: string | number): number

    getMotorJointMaxTorque

    • getMotorJointMaxTorque(jointId: string | number): number

    getMotorJointOffsetX

    • getMotorJointOffsetX(jointId: string | number): number

    getMotorJointOffsetY

    • getMotorJointOffsetY(jointId: string | number): number

    getMouseJointDampingRatio

    • getMouseJointDampingRatio(jointId: string | number): number

    getMouseJointFrequency

    • getMouseJointFrequency(jointId: string | number): number

    getMouseJointMaxForce

    • getMouseJointMaxForce(jointId: string | number): number

    getMouseJointTargetX

    • getMouseJointTargetX(jointId: string | number): number

    getMouseJointTargetY

    • getMouseJointTargetY(jointId: string | number): number

    getName

    • getName(): string

    enableLayer

    • enableLayer(layer: number, enable: boolean): void

    enableMask

    • enableMask(mask: number, enable: boolean): void

    enablePrismaticJointLimits

    • enablePrismaticJointLimits(jointId: string | number, enable: boolean): void

    enablePrismaticJointMotor

    • enablePrismaticJointMotor(jointId: string | number, enable: boolean): void

    enableRevoluteJointLimits

    • enableRevoluteJointLimits(jointId: string | number, enable: boolean): void

    enableRevoluteJointMotor

    • enableRevoluteJointMotor(jointId: string | number, enable: any): void

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    enableWheelJointMotor

    • enableWheelJointMotor(jointId: string | number, enable: any): void

    getAngularDamping

    • getAngularDamping(): number

    getAngularVelocity

    • getAngularVelocity(): number

    getBody

    • getBody(): b2Body

    getDensity

    • getDensity(): number

    getDistanceJointDampingRatio

    • getDistanceJointDampingRatio(jointId: string | number): number

    getDistanceJointFrequency

    • getDistanceJointFrequency(jointId: string | number): number

    getDistanceJointLength

    • getDistanceJointLength(jointId: string | number): number

    getFriction

    • getFriction(): number

    getFrictionJointMaxForce

    • getFrictionJointMaxForce(jointId: string | number): number

    getFrictionJointMaxTorque

    • getFrictionJointMaxTorque(jointId: string | number): number

    getGearJointFirstJoint

    • getGearJointFirstJoint(jointId: string | number): number

    getGearJointRatio

    • getGearJointRatio(jointId: string | number): number

    getGearJointSecondJoint

    • getGearJointSecondJoint(jointId: string | number): number

    getGravityScale

    • getGravityScale(): number

    getGravityX

    • getGravityX(): number

    getGravityY

    • getGravityY(): number

    getInertia

    • getInertia(): number

    getJointFirstAnchorX

    • getJointFirstAnchorX(jointId: string | number): number

    getJointFirstAnchorY

    • getJointFirstAnchorY(jointId: string | number): number

    getJointReactionForce

    • getJointReactionForce(jointId: string | number): number

    getJointReactionTorque

    • getJointReactionTorque(jointId: string | number): number

    getJointSecondAnchorX

    • getJointSecondAnchorX(jointId: string | number): number

    getJointSecondAnchorY

    • getJointSecondAnchorY(jointId: string | number): number

    getLinearDamping

    • getLinearDamping(): number

    getLinearVelocityAngle

    • getLinearVelocityAngle(): number

    getLinearVelocityLength

    • getLinearVelocityLength(): number

    getLinearVelocityX

    • getLinearVelocityX(): number

    getLinearVelocityY

    • getLinearVelocityY(): number

    getMass

    • getMass(): number

    getMassCenterX

    • getMassCenterX(): number

    getMassCenterY

    • getMassCenterY(): number

    getMotorJointAngularOffset

    • getMotorJointAngularOffset(jointId: string | number): number

    getMotorJointCorrectionFactor

    • getMotorJointCorrectionFactor(jointId: string | number): number

    getMotorJointMaxForce

    • getMotorJointMaxForce(jointId: string | number): number

    getMotorJointMaxTorque

    • getMotorJointMaxTorque(jointId: string | number): number

    getMotorJointOffsetX

    • getMotorJointOffsetX(jointId: string | number): number

    getMotorJointOffsetY

    • getMotorJointOffsetY(jointId: string | number): number

    getMouseJointDampingRatio

    • getMouseJointDampingRatio(jointId: string | number): number

    getMouseJointFrequency

    • getMouseJointFrequency(jointId: string | number): number

    getMouseJointMaxForce

    • getMouseJointMaxForce(jointId: string | number): number

    getMouseJointTargetX

    • getMouseJointTargetX(jointId: string | number): number

    getMouseJointTargetY

    • getMouseJointTargetY(jointId: string | number): number

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    getNetworkSyncData

    Static getPolygon

    • getPolygon(verticesData: b2Vec2[]): null | Polygon

    getPrismaticJointAxisAngle

    • getPrismaticJointAxisAngle(jointId: string | number): number

    getPrismaticJointMaxMotorForce

    • getPrismaticJointMaxMotorForce(jointId: string | number): number

    getPrismaticJointMaxTranslation

    • getPrismaticJointMaxTranslation(jointId: string | number): number

    getPrismaticJointMinTranslation

    • getPrismaticJointMinTranslation(jointId: string | number): number

    getPrismaticJointMotorForce

    • getPrismaticJointMotorForce(jointId: string | number): number

    getPrismaticJointMotorSpeed

    • getPrismaticJointMotorSpeed(jointId: string | number): number

    getPrismaticJointReferenceAngle

    • getPrismaticJointReferenceAngle(jointId: string | number): number

    getPrismaticJointSpeed

    • getPrismaticJointSpeed(jointId: string | number): number

    getPrismaticJointTranslation

    • getPrismaticJointTranslation(jointId: string | number): number

    getPulleyJointFirstGroundAnchorX

    • getPulleyJointFirstGroundAnchorX(jointId: string | number): number

    getPulleyJointFirstGroundAnchorY

    • getPulleyJointFirstGroundAnchorY(jointId: string | number): number

    getPulleyJointFirstLength

    • getPulleyJointFirstLength(jointId: string | number): number

    getPulleyJointRatio

    • getPulleyJointRatio(jointId: string | number): number

    getPulleyJointSecondGroundAnchorX

    • getPulleyJointSecondGroundAnchorX(jointId: string | number): number

    getPulleyJointSecondGroundAnchorY

    • getPulleyJointSecondGroundAnchorY(jointId: string | number): number

    getPulleyJointSecondLength

    • getPulleyJointSecondLength(jointId: string | number): number

    getRestitution

    • getRestitution(): number

    getRevoluteJointAngle

    • getRevoluteJointAngle(jointId: string | number): number

    getRevoluteJointMaxAngle

    • getRevoluteJointMaxAngle(jointId: string | number): number

    getRevoluteJointMaxMotorTorque

    • getRevoluteJointMaxMotorTorque(jointId: string | number): number

    getRevoluteJointMinAngle

    • getRevoluteJointMinAngle(jointId: string | number): number

    getRevoluteJointMotorSpeed

    • getRevoluteJointMotorSpeed(jointId: string | number): number

    getRevoluteJointMotorTorque

    • getRevoluteJointMotorTorque(jointId: string | number): number

    getRevoluteJointReferenceAngle

    • getRevoluteJointReferenceAngle(jointId: string | number): number

    getRevoluteJointSpeed

    • getRevoluteJointSpeed(jointId: string | number): number

    getRopeJointMaxLength

    • getRopeJointMaxLength(jointId: string | number): number

    getShapeScale

    • getShapeScale(): number

    getTimeScale

    • getTimeScale(): number

    getWeldJointDampingRatio

    • getWeldJointDampingRatio(jointId: string | number): number

    getWeldJointFrequency

    • getWeldJointFrequency(jointId: string | number): number

    getWeldJointReferenceAngle

    • getWeldJointReferenceAngle(jointId: string | number): number

    getWheelJointAxisAngle

    • getWheelJointAxisAngle(jointId: string | number): number

    getWheelJointDampingRatio

    • getWheelJointDampingRatio(jointId: string | number): number

    getWheelJointFrequency

    • getWheelJointFrequency(jointId: string | number): number

    getWheelJointMaxMotorTorque

    • getWheelJointMaxMotorTorque(jointId: string | number): number

    getWheelJointMotorSpeed

    • getWheelJointMotorSpeed(jointId: string | number): number

    getWheelJointMotorTorque

    • getWheelJointMotorTorque(jointId: string | number): number

    getWheelJointSpeed

    • getWheelJointSpeed(jointId: string | number): number

    getWheelJointTranslation

    • getWheelJointTranslation(jointId: string | number): number

    Static hasCollisionStartedBetween

    Static hasCollisionStoppedBetween

    hasFixedRotation

    • hasFixedRotation(): boolean

    isBullet

    • isBullet(): boolean

    isDynamic

    • isDynamic(): boolean

    isJointFirstObject

    • isJointFirstObject(jointId: string | number): boolean

    isJointSecondObject

    • isJointSecondObject(jointId: string | number): boolean

    isKinematic

    • isKinematic(): boolean

    Static isPolygonConvex

    • isPolygonConvex(polygon: Polygon): boolean

    isPrismaticJointLimitsEnabled

    • isPrismaticJointLimitsEnabled(jointId: string | number): boolean

    isPrismaticJointMotorEnabled

    • isPrismaticJointMotorEnabled(jointId: string | number): boolean

    isRevoluteJointLimitsEnabled

    • isRevoluteJointLimitsEnabled(jointId: string | number): boolean

    isRevoluteJointMotorEnabled

    • isRevoluteJointMotorEnabled(jointId: string | number): boolean

    isSleeping

    • isSleeping(): boolean

    isSleepingAllowed

    • isSleepingAllowed(): boolean

    isStatic

    • isStatic(): boolean

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    isWheelJointMotorEnabled

    • isWheelJointMotorEnabled(jointId: string | number): boolean

    layerEnabled

    • layerEnabled(layer: number): boolean

    maskEnabled

    • maskEnabled(mask: number): boolean

    onActivate

    • onActivate(): void

    getNetworkSyncData

    Static getPolygon

    • getPolygon(verticesData: b2Vec2[]): null | Polygon

    getPrismaticJointAxisAngle

    • getPrismaticJointAxisAngle(jointId: string | number): number

    getPrismaticJointMaxMotorForce

    • getPrismaticJointMaxMotorForce(jointId: string | number): number

    getPrismaticJointMaxTranslation

    • getPrismaticJointMaxTranslation(jointId: string | number): number

    getPrismaticJointMinTranslation

    • getPrismaticJointMinTranslation(jointId: string | number): number

    getPrismaticJointMotorForce

    • getPrismaticJointMotorForce(jointId: string | number): number

    getPrismaticJointMotorSpeed

    • getPrismaticJointMotorSpeed(jointId: string | number): number

    getPrismaticJointReferenceAngle

    • getPrismaticJointReferenceAngle(jointId: string | number): number

    getPrismaticJointSpeed

    • getPrismaticJointSpeed(jointId: string | number): number

    getPrismaticJointTranslation

    • getPrismaticJointTranslation(jointId: string | number): number

    getPulleyJointFirstGroundAnchorX

    • getPulleyJointFirstGroundAnchorX(jointId: string | number): number

    getPulleyJointFirstGroundAnchorY

    • getPulleyJointFirstGroundAnchorY(jointId: string | number): number

    getPulleyJointFirstLength

    • getPulleyJointFirstLength(jointId: string | number): number

    getPulleyJointRatio

    • getPulleyJointRatio(jointId: string | number): number

    getPulleyJointSecondGroundAnchorX

    • getPulleyJointSecondGroundAnchorX(jointId: string | number): number

    getPulleyJointSecondGroundAnchorY

    • getPulleyJointSecondGroundAnchorY(jointId: string | number): number

    getPulleyJointSecondLength

    • getPulleyJointSecondLength(jointId: string | number): number

    getRestitution

    • getRestitution(): number

    getRevoluteJointAngle

    • getRevoluteJointAngle(jointId: string | number): number

    getRevoluteJointMaxAngle

    • getRevoluteJointMaxAngle(jointId: string | number): number

    getRevoluteJointMaxMotorTorque

    • getRevoluteJointMaxMotorTorque(jointId: string | number): number

    getRevoluteJointMinAngle

    • getRevoluteJointMinAngle(jointId: string | number): number

    getRevoluteJointMotorSpeed

    • getRevoluteJointMotorSpeed(jointId: string | number): number

    getRevoluteJointMotorTorque

    • getRevoluteJointMotorTorque(jointId: string | number): number

    getRevoluteJointReferenceAngle

    • getRevoluteJointReferenceAngle(jointId: string | number): number

    getRevoluteJointSpeed

    • getRevoluteJointSpeed(jointId: string | number): number

    getRopeJointMaxLength

    • getRopeJointMaxLength(jointId: string | number): number

    getShapeScale

    • getShapeScale(): number

    getTimeScale

    • getTimeScale(): number

    getWeldJointDampingRatio

    • getWeldJointDampingRatio(jointId: string | number): number

    getWeldJointFrequency

    • getWeldJointFrequency(jointId: string | number): number

    getWeldJointReferenceAngle

    • getWeldJointReferenceAngle(jointId: string | number): number

    getWheelJointAxisAngle

    • getWheelJointAxisAngle(jointId: string | number): number

    getWheelJointDampingRatio

    • getWheelJointDampingRatio(jointId: string | number): number

    getWheelJointFrequency

    • getWheelJointFrequency(jointId: string | number): number

    getWheelJointMaxMotorTorque

    • getWheelJointMaxMotorTorque(jointId: string | number): number

    getWheelJointMotorSpeed

    • getWheelJointMotorSpeed(jointId: string | number): number

    getWheelJointMotorTorque

    • getWheelJointMotorTorque(jointId: string | number): number

    getWheelJointSpeed

    • getWheelJointSpeed(jointId: string | number): number

    getWheelJointTranslation

    • getWheelJointTranslation(jointId: string | number): number

    Static hasCollisionStartedBetween

    Static hasCollisionStoppedBetween

    hasFixedRotation

    • hasFixedRotation(): boolean

    isBullet

    • isBullet(): boolean

    isDynamic

    • isDynamic(): boolean

    isJointFirstObject

    • isJointFirstObject(jointId: string | number): boolean

    isJointSecondObject

    • isJointSecondObject(jointId: string | number): boolean

    isKinematic

    • isKinematic(): boolean

    Static isPolygonConvex

    • isPolygonConvex(polygon: Polygon): boolean

    isPrismaticJointLimitsEnabled

    • isPrismaticJointLimitsEnabled(jointId: string | number): boolean

    isPrismaticJointMotorEnabled

    • isPrismaticJointMotorEnabled(jointId: string | number): boolean

    isRevoluteJointLimitsEnabled

    • isRevoluteJointLimitsEnabled(jointId: string | number): boolean

    isRevoluteJointMotorEnabled

    • isRevoluteJointMotorEnabled(jointId: string | number): boolean

    isSleeping

    • isSleeping(): boolean

    isSleepingAllowed

    • isSleepingAllowed(): boolean

    isStatic

    • isStatic(): boolean

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    isWheelJointMotorEnabled

    • isWheelJointMotorEnabled(jointId: string | number): boolean

    layerEnabled

    • layerEnabled(layer: number): boolean

    maskEnabled

    • maskEnabled(mask: number): boolean

    onActivate

    • onActivate(): void

    onContactBegin

    onContactEnd

    onCreated

    • onCreated(): void

    onContactBegin

    onContactEnd

    onCreated

    • onCreated(): void

    onDeActivate

    • onDeActivate(): void

    onDeActivate

    • onDeActivate(): void

    onDestroy

    • onDestroy(): 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

    onObjectHotReloaded

    • onObjectHotReloaded(): void

    recreateShape

    • recreateShape(): void

    removeJoint

    • removeJoint(jointId: string | number): void

    setAngularDamping

    • setAngularDamping(angularDamping: number): void

    setAngularVelocity

    • setAngularVelocity(angularVelocity: number): void

    setBullet

    • setBullet(enable: boolean): void

    setDensity

    • setDensity(density: number): void

    setDistanceJointDampingRatio

    • setDistanceJointDampingRatio(jointId: string | number, dampingRatio: number): void

    setDistanceJointFrequency

    • setDistanceJointFrequency(jointId: string | number, frequency: number): void

    setDistanceJointLength

    • setDistanceJointLength(jointId: string | number, length: number): void

    setDynamic

    • setDynamic(): void

    setFixedRotation

    • setFixedRotation(enable: boolean): void

    setFriction

    • setFriction(friction: any): void

    setFrictionJointMaxForce

    • setFrictionJointMaxForce(jointId: string | number, maxForce: number): void

    setFrictionJointMaxTorque

    • setFrictionJointMaxTorque(jointId: string | number, maxTorque: number): void

    setGearJointRatio

    • setGearJointRatio(jointId: string | number, ratio: number): void

    setGravity

    • setGravity(x: number, y: number): void

    setGravityScale

    • setGravityScale(gravityScale: number): void

    setKinematic

    • setKinematic(): void

    setLinearDamping

    • setLinearDamping(linearDamping: number): void

    setLinearVelocityAngle

    • setLinearVelocityAngle(angle: number, linearVelocity: number): void

    setLinearVelocityX

    • setLinearVelocityX(linearVelocityX: number): void

    setLinearVelocityY

    • setLinearVelocityY(linearVelocityY: number): void

    setMotorJointAngularOffset

    • setMotorJointAngularOffset(jointId: string | number, offsetAngle: number): void

    setMotorJointCorrectionFactor

    • setMotorJointCorrectionFactor(jointId: string | number, correctionFactor: number): void

    setMotorJointMaxForce

    • setMotorJointMaxForce(jointId: string | number, maxForce: number): void

    setMotorJointMaxTorque

    • setMotorJointMaxTorque(jointId: string | number, maxTorque: number): void

    setMotorJointOffset

    • setMotorJointOffset(jointId: string | number, offsetX: number, offsetY: number): void

    setMouseJointDampingRatio

    • setMouseJointDampingRatio(jointId: string | number, dampingRatio: number): void

    setMouseJointFrequency

    • setMouseJointFrequency(jointId: string | number, frequency: number): void

    setMouseJointMaxForce

    • setMouseJointMaxForce(jointId: string | number, maxForce: number): void

    setMouseJointTarget

    • setMouseJointTarget(jointId: string | number, targetX: number, targetY: number): void

    setPrismaticJointLimits

    • setPrismaticJointLimits(jointId: string | number, lowerTranslation: number, upperTranslation: number): void

    setPrismaticJointMaxMotorForce

    • setPrismaticJointMaxMotorForce(jointId: string | number, maxForce: any): void

    setPrismaticJointMotorSpeed

    • setPrismaticJointMotorSpeed(jointId: string | number, speed: any): void

    setRestitution

    • setRestitution(restitution: number): void

    setRevoluteJointLimits

    • setRevoluteJointLimits(jointId: string | number, lowerAngle: number, upperAngle: number): void

    setRevoluteJointMaxMotorTorque

    • setRevoluteJointMaxMotorTorque(jointId: string | number, maxTorque: any): void

    setRevoluteJointMotorSpeed

    • setRevoluteJointMotorSpeed(jointId: string | number, speed: any): void

    setRopeJointMaxLength

    • setRopeJointMaxLength(jointId: string | number, maxLength: number): void

    setShapeScale

    • setShapeScale(shapeScale: number): void

    setSleepingAllowed

    • setSleepingAllowed(enable: boolean): void

    setStatic

    • setStatic(): void

    setTimeScale

    • setTimeScale(timeScale: number): void

    Static setTimeScaleFromObject

    • setTimeScaleFromObject(object: any, behaviorName: any, timeScale: any): void

    setWeldJointDampingRatio

    • setWeldJointDampingRatio(jointId: string | number, dampingRatio: number): void

    setWeldJointFrequency

    • setWeldJointFrequency(jointId: string | number, frequency: number): void

    setWheelJointDampingRatio

    • setWheelJointDampingRatio(jointId: string | number, dampingRatio: any): void

    setWheelJointFrequency

    • setWheelJointFrequency(jointId: string | number, frequency: any): void

    setWheelJointMaxMotorTorque

    • setWheelJointMaxMotorTorque(jointId: string | number, maxTorque: number): void

    setWheelJointMotorSpeed

    • setWheelJointMotorSpeed(jointId: string | number, speed: any): void

    stepPostEvents

    recreateShape

    • recreateShape(): void

    removeJoint

    • removeJoint(jointId: string | number): void

    setAngularDamping

    • setAngularDamping(angularDamping: number): void

    setAngularVelocity

    • setAngularVelocity(angularVelocity: number): void

    setBullet

    • setBullet(enable: boolean): void

    setDensity

    • setDensity(density: number): void

    setDistanceJointDampingRatio

    • setDistanceJointDampingRatio(jointId: string | number, dampingRatio: number): void

    setDistanceJointFrequency

    • setDistanceJointFrequency(jointId: string | number, frequency: number): void

    setDistanceJointLength

    • setDistanceJointLength(jointId: string | number, length: number): void

    setDynamic

    • setDynamic(): void

    setFixedRotation

    • setFixedRotation(enable: boolean): void

    setFriction

    • setFriction(friction: any): void

    setFrictionJointMaxForce

    • setFrictionJointMaxForce(jointId: string | number, maxForce: number): void

    setFrictionJointMaxTorque

    • setFrictionJointMaxTorque(jointId: string | number, maxTorque: number): void

    setGearJointRatio

    • setGearJointRatio(jointId: string | number, ratio: number): void

    setGravity

    • setGravity(x: number, y: number): void

    setGravityScale

    • setGravityScale(gravityScale: number): void

    setKinematic

    • setKinematic(): void

    setLinearDamping

    • setLinearDamping(linearDamping: number): void

    setLinearVelocityAngle

    • setLinearVelocityAngle(angle: number, linearVelocity: number): void

    setLinearVelocityX

    • setLinearVelocityX(linearVelocityX: number): void

    setLinearVelocityY

    • setLinearVelocityY(linearVelocityY: number): void

    setMotorJointAngularOffset

    • setMotorJointAngularOffset(jointId: string | number, offsetAngle: number): void

    setMotorJointCorrectionFactor

    • setMotorJointCorrectionFactor(jointId: string | number, correctionFactor: number): void

    setMotorJointMaxForce

    • setMotorJointMaxForce(jointId: string | number, maxForce: number): void

    setMotorJointMaxTorque

    • setMotorJointMaxTorque(jointId: string | number, maxTorque: number): void

    setMotorJointOffset

    • setMotorJointOffset(jointId: string | number, offsetX: number, offsetY: number): void

    setMouseJointDampingRatio

    • setMouseJointDampingRatio(jointId: string | number, dampingRatio: number): void

    setMouseJointFrequency

    • setMouseJointFrequency(jointId: string | number, frequency: number): void

    setMouseJointMaxForce

    • setMouseJointMaxForce(jointId: string | number, maxForce: number): void

    setMouseJointTarget

    • setMouseJointTarget(jointId: string | number, targetX: number, targetY: number): void

    setPrismaticJointLimits

    • setPrismaticJointLimits(jointId: string | number, lowerTranslation: number, upperTranslation: number): void

    setPrismaticJointMaxMotorForce

    • setPrismaticJointMaxMotorForce(jointId: string | number, maxForce: any): void

    setPrismaticJointMotorSpeed

    • setPrismaticJointMotorSpeed(jointId: string | number, speed: any): void

    setRestitution

    • setRestitution(restitution: number): void

    setRevoluteJointLimits

    • setRevoluteJointLimits(jointId: string | number, lowerAngle: number, upperAngle: number): void

    setRevoluteJointMaxMotorTorque

    • setRevoluteJointMaxMotorTorque(jointId: string | number, maxTorque: any): void

    setRevoluteJointMotorSpeed

    • setRevoluteJointMotorSpeed(jointId: string | number, speed: any): void

    setRopeJointMaxLength

    • setRopeJointMaxLength(jointId: string | number, maxLength: number): void

    setShapeScale

    • setShapeScale(shapeScale: number): void

    setSleepingAllowed

    • setSleepingAllowed(enable: boolean): void

    setStatic

    • setStatic(): void

    setTimeScale

    • setTimeScale(timeScale: number): void

    Static setTimeScaleFromObject

    • setTimeScaleFromObject(object: any, behaviorName: any, timeScale: any): void

    setWeldJointDampingRatio

    • setWeldJointDampingRatio(jointId: string | number, dampingRatio: number): void

    setWeldJointFrequency

    • setWeldJointFrequency(jointId: string | number, frequency: number): void

    setWheelJointDampingRatio

    • setWheelJointDampingRatio(jointId: string | number, dampingRatio: any): void

    setWheelJointFrequency

    • setWheelJointFrequency(jointId: string | number, frequency: any): void

    setWheelJointMaxMotorTorque

    • setWheelJointMaxMotorTorque(jointId: string | number, maxTorque: number): void

    setWheelJointMotorSpeed

    • setWheelJointMotorSpeed(jointId: string | number, speed: any): void

    stepPostEvents

    stepPreEvents

    Returns void

    stepPreEvents

    updateBodyFromObject

    • updateBodyFromObject(): void

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    Returns void

    updateBodyFromObject

    • updateBodyFromObject(): void

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    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

    Properties

    angularDamping

    angularDamping: number

    bodyType

    bodyType: string

    bullet

    bullet: boolean

    canSleep

    canSleep: boolean

    Static collisionTest

    collisionTest: (object1: RuntimeObject, object2: RuntimeObject, behaviorName: string) => boolean = Physics2RuntimeBehavior.areObjectsColliding

    Type declaration

    contactsEndedThisFrame

    contactsEndedThisFrame: Physics2RuntimeBehavior[]
    +

    Returns boolean

    Properties

    angularDamping

    angularDamping: number

    bodyType

    bodyType: string

    bullet

    bullet: boolean

    canSleep

    canSleep: boolean

    Static collisionTest

    collisionTest: (object1: RuntimeObject, object2: RuntimeObject, behaviorName: string) => boolean = Physics2RuntimeBehavior.areObjectsColliding

    Type declaration

    contactsEndedThisFrame

    contactsEndedThisFrame: Physics2RuntimeBehavior[]

    Array containing the end of contacts reported by onContactEnd. The array is updated each time the method onContactEnd is called by the listener, which can be called at any time. This array is cleared just before stepping the world.

    -

    contactsStartedThisFrame

    contactsStartedThisFrame: Physics2RuntimeBehavior[]
    +

    contactsStartedThisFrame

    contactsStartedThisFrame: Physics2RuntimeBehavior[]

    Array containing the beginning of contacts reported by onContactBegin. Each contact should be unique to avoid recording glitches where the object loses and regain contact between two frames. The array is updated each time the method onContactBegin is called by the listener, which is only called when stepping the world i.e. in the first preEvent called by a physics behavior. This array is cleared just before stepping the world.

    -

    currentContacts

    currentContacts: Physics2RuntimeBehavior[]
    +

    currentContacts

    currentContacts: Physics2RuntimeBehavior[]

    Array containing the exact current contacts with the objects. It is updated each time the methods onContactBegin and onContactEnd are called by the contact listener.

    -

    density

    density: number

    destroyedDuringFrameLogic

    destroyedDuringFrameLogic: boolean

    fixedRotation

    fixedRotation: boolean

    friction

    friction: number

    gravityScale

    gravityScale: number

    layers

    layers: number

    linearDamping

    linearDamping: number

    masks

    masks: number

    name

    name: string

    owner

    owner: RuntimeObject

    polygon

    polygon: null | Polygon

    polygonOrigin

    polygonOrigin: string

    restitution

    restitution: number

    shape

    shape: string

    shapeDimensionA

    shapeDimensionA: any

    shapeDimensionB

    shapeDimensionB: any

    shapeOffsetX

    shapeOffsetX: number

    shapeOffsetY

    shapeOffsetY: number

    shapeScale

    shapeScale: number = 1

    type

    type: string

    Constructors

    constructor

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Physics2SharedData

    Hierarchy

    • Physics2SharedData

    Index

    Methods

    Constructors

    Properties

    Methods

    addJoint

    • addJoint(joint: b2Joint): number

    addToBehaviorsList

    Constructors

    constructor

    Properties

    contactListener

    contactListener: JSContactListener

    Contact listener to keep track of current collisions

    -

    frameTime

    frameTime: number = 0

    gravityX

    gravityX: number

    gravityY

    gravityY: number

    invScaleX

    invScaleX: number

    invScaleY

    invScaleY: number

    joints

    joints: {} = {}
    +

    frameTime

    frameTime: number = 0

    gravityX

    gravityX: number

    gravityY

    gravityY: number

    invScaleX

    invScaleX: number

    invScaleY

    invScaleY: number

    joints

    joints: {} = {}

    Start with 1 so the user is safe from default variables value (0)

    -

    Type declaration

    • [key: string]: Box2D.b2Joint

    scaleX

    scaleX: number

    scaleY

    scaleY: number

    staticBody

    staticBody: b2Body

    stepped

    stepped: boolean = false

    timeScale

    timeScale: number = 1

    timeStep

    timeStep: number

    world

    world: b2World

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class PhysicsRuntimeBehavior

    Allows objects to be moved in a realistic way thanks to a physics engine (Box2D).

    -

    Hierarchy

    Index

    Methods

    Constructors

    Properties

    Methods

    activate

    • activate(enable: boolean): void

    Hierarchy

    Index

    Methods

    Constructors

    Properties

    Methods

    activate

    • activate(enable: boolean): void

    activated

    • activated(): boolean

    Returns void

    activated

    • activated(): boolean

    addGearJointBetweenObjects

    • addGearJointBetweenObjects(object: any, ratio: any): void

    addRevoluteJoint

    • addRevoluteJoint(xPosition: any, yPosition: any): void

    addRevoluteJointBetweenObjects

    • addRevoluteJointBetweenObjects(object: any, scene: any, xPosRelativeToMassCenter: any, yPosRelativeToMassCenter: any): void

    applyForce

    • applyForce(xCoordinate: any, yCoordinate: any): void

    applyForceTowardPosition

    • applyForceTowardPosition(xPosition: any, yPosition: any, length: any): void

    applyForceUsingPolarCoordinates

    • applyForceUsingPolarCoordinates(angle: any, length: any): void

    applyImpulse

    • applyImpulse(xCoordinate: any, yCoordinate: any): void

    applyImpulseTowardPosition

    • applyImpulseTowardPosition(xPosition: any, yPosition: any, length: any): void

    applyImpulseUsingPolarCoordinates

    • applyImpulseUsingPolarCoordinates(angle: any, length: any): void

    applyTorque

    • applyTorque(torque: any): void

    b2Vec2

    • b2Vec2(x: any, y: any): any

    addGearJointBetweenObjects

    • addGearJointBetweenObjects(object: any, ratio: any): void

    addRevoluteJoint

    • addRevoluteJoint(xPosition: any, yPosition: any): void

    addRevoluteJointBetweenObjects

    • addRevoluteJointBetweenObjects(object: any, scene: any, xPosRelativeToMassCenter: any, yPosRelativeToMassCenter: any): void

    applyForce

    • applyForce(xCoordinate: any, yCoordinate: any): void

    applyForceTowardPosition

    • applyForceTowardPosition(xPosition: any, yPosition: any, length: any): void

    applyForceUsingPolarCoordinates

    • applyForceUsingPolarCoordinates(angle: any, length: any): void

    applyImpulse

    • applyImpulse(xCoordinate: any, yCoordinate: any): void

    applyImpulseTowardPosition

    • applyImpulseTowardPosition(xPosition: any, yPosition: any, length: any): void

    applyImpulseUsingPolarCoordinates

    • applyImpulseUsingPolarCoordinates(angle: any, length: any): void

    applyTorque

    • applyTorque(torque: any): void

    b2Vec2

    • b2Vec2(x: any, y: any): any

    collisionWith

    • collisionWith(otherObjectsTable: any): boolean

    createBody

    • createBody(): void

    doStepPostEvents

    • doStepPostEvents(runtimeScene: any): void

    collisionWith

    • collisionWith(otherObjectsTable: any): boolean

    createBody

    • createBody(): void

    doStepPostEvents

    • doStepPostEvents(runtimeScene: any): void

    doStepPreEvents

    • doStepPreEvents(runtimeScene: any): void

    doStepPreEvents

    • doStepPreEvents(runtimeScene: any): void

    dontSetAsBullet

    • dontSetAsBullet(): void

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getAngularDamping

    • getAngularDamping(): any

    getAngularVelocity

    • getAngularVelocity(): any

    getBox2DBody

    • getBox2DBody(): any

    getLinearDamping

    • getLinearDamping(): any

    getLinearVelocity

    • getLinearVelocity(): number

    getLinearVelocityX

    • getLinearVelocityX(): number

    getLinearVelocityY

    • getLinearVelocityY(): number

    getName

    • getName(): string

    dontSetAsBullet

    • dontSetAsBullet(): void

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getAngularDamping

    • getAngularDamping(): any

    getAngularVelocity

    • getAngularVelocity(): any

    getBox2DBody

    • getBox2DBody(): any

    getLinearDamping

    • getLinearDamping(): any

    getLinearVelocity

    • getLinearVelocity(): number

    getLinearVelocityX

    • getLinearVelocityX(): number

    getLinearVelocityY

    • getLinearVelocityY(): number

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    isDynamic

    • isDynamic(): boolean

    isStatic

    • isStatic(): boolean

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    isDynamic

    • isDynamic(): boolean

    isStatic

    • isStatic(): boolean

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    onDeActivate

    • onDeActivate(): void

    onDeActivate

    • onDeActivate(): void

    onDestroy

    • onDestroy(): 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

    onObjectHotReloaded

    • onObjectHotReloaded(): void

    setAngularDamping

    • setAngularDamping(angularDamping: any): void

    setAngularVelocity

    • setAngularVelocity(angularVelocity: any): void

    setAsBullet

    • setAsBullet(): void

    setDynamic

    • setDynamic(): void

    setFixedRotation

    • setFixedRotation(): void

    setFreeRotation

    • setFreeRotation(): void

    setGravity

    • setGravity(xGravity: any, yGravity: any): void

    setLinearDamping

    • setLinearDamping(linearDamping: any): void

    setLinearVelocity

    • setLinearVelocity(xVelocity: any, yVelocity: any): void

    setLinearVelocityX

    • setLinearVelocityX(xVelocity: any): void

    setLinearVelocityY

    • setLinearVelocityY(yVelocity: any): void

    setStatic

    • setStatic(): void

    stepPostEvents

    setAngularDamping

    • setAngularDamping(angularDamping: any): void

    setAngularVelocity

    • setAngularVelocity(angularVelocity: any): void

    setAsBullet

    • setAsBullet(): void

    setDynamic

    • setDynamic(): void

    setFixedRotation

    • setFixedRotation(): void

    setFreeRotation

    • setFreeRotation(): void

    setGravity

    • setGravity(xGravity: any, yGravity: any): void

    setLinearDamping

    • setLinearDamping(linearDamping: any): void

    setLinearVelocity

    • setLinearVelocity(xVelocity: any, yVelocity: any): void

    setLinearVelocityX

    • setLinearVelocityX(xVelocity: any): void

    setLinearVelocityY

    • setLinearVelocityY(yVelocity: any): void

    setStatic

    • setStatic(): void

    stepPostEvents

    stepPreEvents

    Returns void

    stepPreEvents

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    Returns void

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    Returns void

    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

    Constructors

    constructor

    Properties

    currentContacts

    currentContacts: any = []

    name

    name: string

    owner

    owner: RuntimeObject

    type

    type: string

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class PhysicsSharedData

    Manage the common objects shared by objects having a physics behavior.

    -

    Hierarchy

    • PhysicsSharedData

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    Properties

    contactListener

    contactListener: any

    fixedTimeStep

    fixedTimeStep: any

    invScaleX

    invScaleX: any

    invScaleY

    invScaleY: any

    scaleX

    scaleX: any

    scaleY

    scaleY: any

    staticBody

    staticBody: any

    stepped

    stepped: boolean = false

    totalTime

    totalTime: number = 0

    world

    world: any

    Methods

    Static getSharedData

    • getSharedData(runtimeScene: any, name: any): any

    Hierarchy

    • PhysicsSharedData

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    Properties

    contactListener

    contactListener: any

    fixedTimeStep

    fixedTimeStep: any

    invScaleX

    invScaleX: any

    invScaleY

    invScaleY: any

    scaleX

    scaleX: any

    scaleY

    scaleY: any

    staticBody

    staticBody: any

    stepped

    stepped: boolean = false

    totalTime

    totalTime: number = 0

    world

    world: any

    Methods

    Static getSharedData

    • getSharedData(runtimeScene: any, name: any): any

    step

    • step(dt: any): void

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class PixiBitmapFontManager

    PixiBitmapFontManager loads fnt/xml files (using fetch), from the "bitmapFont" resources of the game.

    It installs the "BitmapFont" with PixiJS to be used with PIXI.BitmapText.

    -

    Hierarchy

    • PixiBitmapFontManager

    Implements

    Index

    Constructors

    Methods

    Constructors

    constructor

    Hierarchy

    • PixiBitmapFontManager

    Implements

    Index

    Constructors

    Methods

    Constructors

    constructor

    Methods

    getDefaultBitmapFont

    • getDefaultBitmapFont(): BitmapFont

    Returns PixiBitmapFontManager

    Methods

    getDefaultBitmapFont

    • getDefaultBitmapFont(): BitmapFont

    getResourceKinds

    • getResourceKinds(): ResourceKind[]

    getResourceKinds

    • getResourceKinds(): ResourceKind[]

    loadResource

    • loadResource(resourceName: string): Promise<void>

    loadResource

    • loadResource(resourceName: string): Promise<void>

    obtainBitmapFont

    • obtainBitmapFont(bitmapFontResourceName: string, textureAtlasResourceName: string): BitmapFont

    obtainBitmapFont

    • obtainBitmapFont(bitmapFontResourceName: string, textureAtlasResourceName: string): BitmapFont

    • Given a bitmap font resource name and a texture atlas resource name, returns the PIXI.BitmapFont for it. The font is register and should be released with releaseBitmapFont - so that it can be removed from memory when unused.

      -

      Parameters

      • bitmapFontResourceName: string
      • textureAtlasResourceName: string

      Returns BitmapFont

    processResource

    • processResource(resourceName: string): Promise<void>

    processResource

    • processResource(resourceName: string): Promise<void>

    releaseBitmapFont

    • releaseBitmapFont(bitmapFontInstallKey: string): void

    releaseBitmapFont

    • releaseBitmapFont(bitmapFontInstallKey: string): void

    Methods

    getInvalidPIXITexture

    • getInvalidPIXITexture(): Texture<Resource>

    getOrCreateDiskTexture

    • getOrCreateDiskTexture(radius: number, pixiRenderer: Renderer): Texture<Resource>

    getOrCreateDiskTexture

    • getOrCreateDiskTexture(radius: number, pixiRenderer: Renderer): Texture<Resource>

    getOrCreateRectangleTexture

    • getOrCreateRectangleTexture(width: number, height: number, pixiRenderer: Renderer): Texture<Resource>

    Returns Texture<Resource>

    getOrCreateRectangleTexture

    • getOrCreateRectangleTexture(width: number, height: number, pixiRenderer: Renderer): Texture<Resource>

    • Return a texture filled with white.

      Parameters

      • width: number

        The texture width

        @@ -19,7 +19,7 @@

        The texture height

      • pixiRenderer: Renderer

        The renderer used to generate the texture

        -

      Returns Texture<Resource>

    getOrCreateScaledTexture

    • getOrCreateScaledTexture(imageResourceName: string, width: number, height: number, pixiRenderer: Renderer): Texture<Resource>

    Returns Texture<Resource>

    getOrCreateScaledTexture

    • getOrCreateScaledTexture(imageResourceName: string, width: number, height: number, pixiRenderer: Renderer): Texture<Resource>

    • Return a texture rescaled according to given dimensions.

      Parameters

      • imageResourceName: string
      • width: number

        The texture width

        @@ -27,7 +27,7 @@

        The texture height

      • pixiRenderer: Renderer

        The renderer used to generate the texture

        -

      Returns Texture<Resource>

    getOrLoadPIXITexture

    • getOrLoadPIXITexture(resourceName: string): Texture<Resource>

    Returns Texture<Resource>

    getOrLoadPIXITexture

    • getOrLoadPIXITexture(resourceName: string): Texture<Resource>

    • Return the PIXI texture associated to the specified resource name. If not found in the loaded textures, this method will try to load it. Warning: this method should only be used in specific cases that cannot rely on @@ -35,34 +35,34 @@

      Parameters

      • resourceName: string

        The name of the resource

      Returns Texture<Resource>

      The requested texture, or a placeholder if not valid.

      -

    getPIXITexture

    • getPIXITexture(resourceName: string): Texture<Resource>

    getPIXITexture

    • getPIXITexture(resourceName: string): Texture<Resource>

    • Return the PIXI texture associated to the specified resource name. Returns a placeholder texture if not found.

      Parameters

      • resourceName: string

        The name of the resource

      Returns Texture<Resource>

      The requested texture, or a placeholder if not found.

      -

    getPIXIVideoTexture

    • getPIXIVideoTexture(resourceName: string): Texture<Resource>

    getPIXIVideoTexture

    • getPIXIVideoTexture(resourceName: string): Texture<Resource>

    • Return the PIXI video texture associated to the specified resource name. Returns a placeholder texture if not found.

      Parameters

      • resourceName: string

        The name of the resource to get.

        -

      Returns Texture<Resource>

    getResourceKinds

    • getResourceKinds(): ResourceKind[]

    Returns Texture<Resource>

    getResourceKinds

    • getResourceKinds(): ResourceKind[]

    getThreeMaterial

    • getThreeMaterial(resourceName: string, options: { forceBasicMaterial: boolean; useTransparentTexture: boolean }): Material

    getThreeMaterial

    • getThreeMaterial(resourceName: string, options: { forceBasicMaterial: boolean; useTransparentTexture: boolean }): Material

    • Return the three.js material associated to the specified resource name.

      Parameters

      • resourceName: string

        The name of the resource

      • options: { forceBasicMaterial: boolean; useTransparentTexture: boolean }
        • forceBasicMaterial: boolean
        • useTransparentTexture: boolean

      Returns Material

      The requested material.

      -

    getThreeTexture

    • getThreeTexture(resourceName: string): Texture

    getThreeTexture

    • getThreeTexture(resourceName: string): Texture

    • Return the three.js texture associated to the specified resource name. Returns a placeholder texture if not found.

      Parameters

      • resourceName: string

        The name of the resource

      Returns Texture

      The requested texture, or a placeholder if not found.

      -

    loadResource

    • loadResource(resourceName: string): Promise<void>

    loadResource

    • loadResource(resourceName: string): Promise<void>

    processResource

    • processResource(resourceName: string): Promise<void>

    processResource

    • processResource(resourceName: string): Promise<void>

    • Process the specified resource.

      This method will only be run while loading screen is shown. It can do heavy tasks like parsing data.

      diff --git a/GDJS Runtime Documentation/classes/gdjs.PlatformObjectsManager.html b/GDJS Runtime Documentation/classes/gdjs.PlatformObjectsManager.html index c49e49ae9..11ee017fb 100644 --- a/GDJS Runtime Documentation/classes/gdjs.PlatformObjectsManager.html +++ b/GDJS Runtime Documentation/classes/gdjs.PlatformObjectsManager.html @@ -3,19 +3,19 @@ platform behavior: in particular, the platforms behaviors are required to declare themselves (see PlatformObjectsManager.addPlatform) to the manager of their associated container (see PlatformRuntimeBehavior.getManager).

      -

    Hierarchy

    • PlatformObjectsManager

    Index

    Methods

    Constructors

    Methods

    addPlatform

    Hierarchy

    • PlatformObjectsManager

    Index

    Methods

    Constructors

    Methods

    addPlatform

    getAllPlatformsAround

    getAllPlatformsAround

    Static getManager

    Static getManager

    removePlatform

    removePlatform

    Constructors

    constructor

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class PlatformRuntimeBehavior

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

    -

    Hierarchy

    Index

    Properties

    Methods

    Constructors

    Properties

    Static JUMPTHRU

    JUMPTHRU: number = 1

    Static LADDER

    LADDER: number = 2

    Static NORMALPLAFTORM

    NORMALPLAFTORM: number = PlatformRuntimeBehavior.NORMALPLATFORM
    deprecated

    Use NORMALPLATFORM instead.

    -

    Static NORMALPLATFORM

    NORMALPLATFORM: number = 0

    currentRBushAABB

    currentRBushAABB: null | BehaviorRBushAABB<PlatformRuntimeBehavior> = null

    name

    name: string

    owner

    owner: RuntimeObject

    type

    type: string

    Methods

    activate

    • activate(enable: boolean): void

    Hierarchy

    Index

    Properties

    Methods

    Constructors

    Properties

    Static JUMPTHRU

    JUMPTHRU: number = 1

    Static LADDER

    LADDER: number = 2

    Static NORMALPLAFTORM

    NORMALPLAFTORM: number = PlatformRuntimeBehavior.NORMALPLATFORM
    deprecated

    Use NORMALPLATFORM instead.

    +

    Static NORMALPLATFORM

    NORMALPLATFORM: number = 0

    currentRBushAABB

    currentRBushAABB: null | BehaviorRBushAABB<PlatformRuntimeBehavior> = null

    name

    name: string

    owner

    owner: RuntimeObject

    type

    type: string

    Methods

    activate

    • activate(enable: boolean): void

    activated

    • activated(): boolean

    Returns void

    activated

    • activated(): boolean

    canBeGrabbed

    • canBeGrabbed(): boolean

    changePlatformType

    • changePlatformType(platformType: string): void

    doStepPostEvents

    canBeGrabbed

    • canBeGrabbed(): boolean

    changePlatformType

    • changePlatformType(platformType: string): void

    doStepPostEvents

    doStepPreEvents

    doStepPreEvents

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getName

    • getName(): string

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    getPlatformType

    • getPlatformType(): number

    getYGrabOffset

    • getYGrabOffset(): number

    Static isOnPlatformTest

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    getPlatformType

    • getPlatformType(): number

    getYGrabOffset

    • getYGrabOffset(): number

    Static isOnPlatformTest

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    onDeActivate

    • onDeActivate(): void

    onDeActivate

    • onDeActivate(): void

    onDestroy

    • onDestroy(): 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

    onObjectHotReloaded

    • onObjectHotReloaded(): void

    stepPostEvents

    stepPostEvents

    stepPreEvents

    Returns void

    stepPreEvents

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    Returns void

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    Returns void

    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

    Constructors

    constructor

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class PlatformerObjectRuntimeBehavior

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

    -

    Hierarchy

    Index

    Methods

    Constructors

    Properties

    Methods

    abortJump

    • abortJump(): void

    Hierarchy

    Index

    Methods

    Constructors

    Properties

    Methods

    abortJump

    • abortJump(): void

    activate

    • activate(enable: boolean): void

    activate

    • activate(enable: boolean): void

    activated

    • activated(): boolean

    Returns void

    activated

    • activated(): boolean

    canGrabPlatforms

    • canGrabPlatforms(): boolean

    canGrabPlatforms

    • canGrabPlatforms(): boolean

    canJump

    • canJump(): boolean

    canJump

    • canJump(): boolean

    doStepPostEvents

    doStepPostEvents

    doStepPreEvents

    doStepPreEvents

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getAcceleration

    • getAcceleration(): number

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getAcceleration

    • getAcceleration(): number

    getCurrentFallSpeed

    • getCurrentFallSpeed(): number

    getCurrentFallSpeed

    • getCurrentFallSpeed(): number

    getCurrentJumpSpeed

    • getCurrentJumpSpeed(): number

    getCurrentJumpSpeed

    • getCurrentJumpSpeed(): number

    getCurrentSpeed

    • getCurrentSpeed(): number

    getCurrentSpeed

    • getCurrentSpeed(): number

    getDeceleration

    • getDeceleration(): number

    getDeceleration

    • getDeceleration(): number

    getGravity

    • getGravity(): number

    getGravity

    • getGravity(): number

    getJumpSpeed

    • getJumpSpeed(): number

    getJumpSpeed

    • getJumpSpeed(): number

    getJumpSustainTime

    • getJumpSustainTime(): number

    getJumpSustainTime

    • getJumpSustainTime(): number

    getLadderClimbingSpeed

    • getLadderClimbingSpeed(): number

    getLadderClimbingSpeed

    • getLadderClimbingSpeed(): number

    getMaxFallingSpeed

    • getMaxFallingSpeed(): number

    getMaxFallingSpeed

    • getMaxFallingSpeed(): number

    getMaxSpeed

    • getMaxSpeed(): number

    getMaxSpeed

    • getMaxSpeed(): number

    getName

    • getName(): string

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    getNetworkSyncData

    getSlopeMaxAngle

    • getSlopeMaxAngle(): number

    getNetworkSyncData

    getSlopeMaxAngle

    • getSlopeMaxAngle(): number

    ignoreDefaultControls

    • ignoreDefaultControls(ignore: boolean): void

    ignoreDefaultControls

    • ignoreDefaultControls(ignore: boolean): void

    isFalling

    • isFalling(): boolean

    Returns void

    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 @@ -75,157 +75,157 @@ 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.

      -

    isFallingWithoutJumping

    • isFallingWithoutJumping(): boolean

    isFallingWithoutJumping

    • isFallingWithoutJumping(): boolean

    isGrabbingPlatform

    • isGrabbingPlatform(): boolean

    isGrabbingPlatform

    • isGrabbingPlatform(): boolean

    isJumping

    • isJumping(): boolean

    isJumping

    • isJumping(): boolean

    isMoving

    • isMoving(): boolean

    isMoving

    • isMoving(): boolean

    isMovingEvenALittle

    • isMovingEvenALittle(): boolean

    isMovingEvenALittle

    • isMovingEvenALittle(): boolean

    isOnFloor

    • isOnFloor(): boolean

    isOnFloor

    • isOnFloor(): boolean

    isOnFloorObject

    isOnFloorObject

    isOnLadder

    • isOnLadder(): boolean

    isOnLadder

    • isOnLadder(): boolean

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    isUsingControl

    • isUsingControl(input: string): boolean

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    isUsingControl

    • isUsingControl(input: string): boolean

    onActivate

    • onActivate(): void

    onActivate

    • onActivate(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    onDeActivate

    • onDeActivate(): void

    onDeActivate

    • onDeActivate(): void

    onDestroy

    • onDestroy(): 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

    onObjectHotReloaded

    • onObjectHotReloaded(): void

    setAcceleration

    • setAcceleration(acceleration: number): void

    setAcceleration

    • setAcceleration(acceleration: number): void

    setCanGrabPlatforms

    • setCanGrabPlatforms(enable: boolean): void

    Returns void

    setCanGrabPlatforms

    • setCanGrabPlatforms(enable: boolean): void

    setCanJump

    • setCanJump(): void

    Returns void

    setCanJump

    • setCanJump(): void

    setCanNotAirJump

    • setCanNotAirJump(): void

    setCanNotAirJump

    • setCanNotAirJump(): void

    setCurrentFallSpeed

    • setCurrentFallSpeed(currentFallSpeed: number): void

    setCurrentFallSpeed

    • setCurrentFallSpeed(currentFallSpeed: number): void

    setCurrentSpeed

    • setCurrentSpeed(currentSpeed: number): void

    setCurrentSpeed

    • setCurrentSpeed(currentSpeed: number): void

    setDeceleration

    • setDeceleration(deceleration: number): void

    Returns void

    setDeceleration

    • setDeceleration(deceleration: number): void

    setGravity

    • setGravity(gravity: number): void

    Returns void

    setGravity

    • setGravity(gravity: number): void

    setJumpSpeed

    • setJumpSpeed(jumpSpeed: number): void

    Returns void

    setJumpSpeed

    • setJumpSpeed(jumpSpeed: number): void

    setJumpSustainTime

    • setJumpSustainTime(jumpSustainTime: number): void

    Returns void

    setJumpSustainTime

    • setJumpSustainTime(jumpSustainTime: number): void

    setLadderClimbingSpeed

    • setLadderClimbingSpeed(ladderClimbingSpeed: number): void

    setLadderClimbingSpeed

    • setLadderClimbingSpeed(ladderClimbingSpeed: number): void

    setMaxFallingSpeed

    • setMaxFallingSpeed(maxFallingSpeed: number, tryToPreserveAirSpeed?: boolean): void

    Returns void

    setMaxFallingSpeed

    • setMaxFallingSpeed(maxFallingSpeed: number, tryToPreserveAirSpeed?: boolean): 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

    setMaxSpeed

    • setMaxSpeed(maxSpeed: number): void

    Returns void

    setMaxSpeed

    • setMaxSpeed(maxSpeed: number): void

    setSlopeMaxAngle

    • setSlopeMaxAngle(slopeMaxAngle: number): void

    Returns void

    setSlopeMaxAngle

    • setSlopeMaxAngle(slopeMaxAngle: number): void

    shouldIgnoreDefaultControls

    • shouldIgnoreDefaultControls(): boolean

    Returns void

    shouldIgnoreDefaultControls

    • shouldIgnoreDefaultControls(): boolean

    simulateControl

    • simulateControl(input: string): void

    simulateControl

    • simulateControl(input: string): void

    simulateDownKey

    • simulateDownKey(): void

    Returns void

    simulateDownKey

    • simulateDownKey(): void

    simulateJumpKey

    • simulateJumpKey(): void

    simulateJumpKey

    • simulateJumpKey(): void

    simulateLadderKey

    • simulateLadderKey(): void

    simulateLadderKey

    • simulateLadderKey(): void

    simulateLeftKey

    • simulateLeftKey(): void

    simulateLeftKey

    • simulateLeftKey(): void

    simulateReleaseLadderKey

    • simulateReleaseLadderKey(): void

    simulateReleaseLadderKey

    • simulateReleaseLadderKey(): void

    simulateReleasePlatformKey

    • simulateReleasePlatformKey(): void

    simulateReleasePlatformKey

    • simulateReleasePlatformKey(): void

    simulateRightKey

    • simulateRightKey(): void

    simulateRightKey

    • simulateRightKey(): void

    simulateUpKey

    • simulateUpKey(): void

    simulateUpKey

    • simulateUpKey(): void

    stepPostEvents

    stepPostEvents

    stepPreEvents

    Returns void

    stepPreEvents

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    Returns void

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    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

    Constructors

    constructor

    Properties

    name

    name: string

    owner

    owner: RuntimeObject

    type

    type: string

    Static Private Readonly epsilon

    epsilon: number = ...
    +

    Returns boolean

    Constructors

    constructor

    Properties

    name

    name: string

    owner

    owner: RuntimeObject

    type

    type: string

    Static Private Readonly epsilon

    epsilon: number = ...

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

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Polygon

    Polygon represents a polygon which can be used to create collisions masks for RuntimeObject.

    -

    Hierarchy

    • Polygon

    Index

    Properties

    Methods

    Constructors

    Properties

    center

    center: FloatPoint = ...
    +

    Hierarchy

    • Polygon

    Index

    Properties

    Methods

    Constructors

    Properties

    center

    center: FloatPoint = ...

    The center of the polygon. This property is only valid after calling computeCenter, and remains valid until vertices are modified.

    -

    edges

    edges: FloatPoint[] = []
    +

    edges

    edges: FloatPoint[] = []

    The edges of the polygon. This property is only valid after calling computeEdges, and remains valid until vertices are modified.

    -

    Static makeNewCollisionTestResult

    makeNewCollisionTestResult: () => CollisionTestResult = makeNewCollisionTestResult

    Type declaration

    Static makeNewCollisionTestResult

    makeNewCollisionTestResult: () => CollisionTestResult = makeNewCollisionTestResult

    Type declaration

    Static makeNewRaycastTestResult

    makeNewRaycastTestResult: () => RaycastTestResult = makeNewRaycastTestResult

    Type declaration

    Static makeNewRaycastTestResult

    makeNewRaycastTestResult: () => RaycastTestResult = makeNewRaycastTestResult

    Type declaration

    vertices

    vertices: FloatPoint[] = []
    +

    Returns RaycastTestResult

    vertices

    vertices: FloatPoint[] = []

    The vertices of the polygon

    -

    Methods

    Static collisionTest

    Methods

    Static collisionTest

    • Do a collision test between two polygons. Please note that polygons must convexes!

      You can read the result but do not keep a reference to it as it's a static object @@ -27,15 +27,15 @@

    • ignoreTouchingEdges: boolean

      If true, then edges that are touching each other, without the polygons actually overlapping, won't be considered in collision.

    Returns CollisionTestResult

    A collision result. collision property is equal to true if polygons are overlapping. Do NOT keep a reference to this.

    -

    computeCenter

    • computeCenter(): FloatPoint

    computeEdges

    • computeEdges(): void

    Static copyCollisionTestResult

    computeCenter

    • computeCenter(): FloatPoint

    computeEdges

    • computeEdges(): void

    Static copyCollisionTestResult

    Static copyRaycastTestResult

    Static copyRaycastTestResult

    Static createRectangle

    • createRectangle(width: number, height: number): Polygon

    Static crossProduct

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

    Static distance

    • distance(minA: number, maxA: number, minB: number, maxB: number): number

    Static dotProduct

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

    isConvex

    • isConvex(): boolean

    Static isPointInside

    • isPointInside(poly: Polygon, x: number, y: number): boolean

    Static createRectangle

    • createRectangle(width: number, height: number): Polygon

    Static crossProduct

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

    Static distance

    • distance(minA: number, maxA: number, minB: number, maxB: number): number

    Static dotProduct

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

    isConvex

    • isConvex(): boolean

    Static isPointInside

    • isPointInside(poly: Polygon, x: number, y: number): boolean

    • Check if a point is inside a polygon.

      Uses PNPOLY by W. Randolph Franklin.

      Parameters

      • poly: Polygon
        @@ -45,7 +45,7 @@
      • y: number

        The point y coordinate

      Returns boolean

      true if the point is inside the polygon

      -

    move

    • move(x: number, y: number): void

    Static normalise

    • normalise(v: FloatPoint): void

    Static project

    • project(axis: FloatPoint, p: Polygon, result: FloatPoint): void

    Static raycastTest

    move

    • move(x: number, y: number): void

    Static normalise

    • normalise(v: FloatPoint): void

    Static project

    • project(axis: FloatPoint, p: Polygon, result: FloatPoint): void

    Static raycastTest

    • Do a raycast test. Please note that the polygon must be convex!

      You can read the result but do not keep a reference to it as it's a static object @@ -62,7 +62,7 @@

    • endY: number

      The raycast end point Y

    Returns RaycastTestResult

    A raycast result with the contact points and distances. Do NOT keep a reference to this.

    -

    rotate

    • rotate(angle: number): void

    Constructors

    constructor

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Profiler

    A basic profiling tool that can be used to measure time spent in sections of the engine.

    -

    Hierarchy

    • Profiler

    Index

    Methods

    Constructors

    Methods

    begin

    • begin(sectionName: string): void

    beginFrame

    • beginFrame(): void

    end

    • end(sectionName?: string): void

    endFrame

    • endFrame(): void

    getFramesAverageMeasures

    Hierarchy

    • Profiler

    Index

    Methods

    Constructors

    Methods

    begin

    • begin(sectionName: string): void

    beginFrame

    • beginFrame(): void

    end

    • end(sectionName?: string): void

    endFrame

    • endFrame(): void

    getFramesAverageMeasures

    Static getProfilerSectionTexts

    • getProfilerSectionTexts(sectionName: string, profilerSection: any, outputs: any): void

    Static getProfilerSectionTexts

    • getProfilerSectionTexts(sectionName: string, profilerSection: any, outputs: any): void

    • Convert measures for a section into texts. Useful for ingame profiling.

      Parameters

      • sectionName: string
        @@ -12,9 +12,9 @@

        The section measures

      • outputs: any

        The array where to push the results

        -

      Returns void

    getStats

    Returns void

    getStats

    Constructors

    constructor

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class PromiseTask<ResultType>

    A task that resolves with a promise.

    -

    Type parameters

    • ResultType = void

    Hierarchy

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new PromiseTask<ResultType>(promise: Promise<ResultType>): PromiseTask<ResultType>

    Properties

    promise

    promise: Promise<ResultType>

    Private isResolved

    isResolved: boolean = false

    Methods

    update

    • update(): boolean

    Type parameters

    • ResultType = void

    Hierarchy

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new PromiseTask<ResultType>(promise: Promise<ResultType>): PromiseTask<ResultType>

    Properties

    promise

    promise: Promise<ResultType>

    Private isResolved

    isResolved: boolean = false

    Methods

    update

    • update(): boolean

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ResizableBehavior

    A behavior that forwards the Resizable interface to its object.

    -

    Hierarchy

    Implements

    Index

    Methods

    Constructors

    Properties

    Methods

    activate

    • activate(enable: boolean): void

    Hierarchy

    Implements

    Index

    Methods

    Constructors

    Properties

    Methods

    activate

    • activate(enable: boolean): void

    activated

    • activated(): boolean

    Returns void

    activated

    • activated(): boolean

    doStepPostEvents

    doStepPostEvents

    doStepPreEvents

    doStepPreEvents

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getHeight

    • getHeight(): number

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getHeight

    • getHeight(): number

    getName

    • getName(): string

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    getWidth

    • getWidth(): number

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    getWidth

    • getWidth(): number

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    onDeActivate

    • onDeActivate(): void

    onDeActivate

    • onDeActivate(): void

    onDestroy

    • onDestroy(): 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

    onObjectHotReloaded

    • onObjectHotReloaded(): void

    setHeight

    • setHeight(newHeight: number): void

    setHeight

    • setHeight(newHeight: number): void

    setSize

    • setSize(newWidth: number, newHeight: number): void

    setSize

    • setSize(newWidth: number, newHeight: number): void

    setWidth

    • setWidth(newWidth: number): void

    setWidth

    • setWidth(newWidth: number): void

    stepPostEvents

    stepPostEvents

    stepPreEvents

    Returns void

    stepPreEvents

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    Returns void

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    Returns void

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    Constructors

    constructor

    Properties

    name

    name: string

    owner

    owner: RuntimeObject

    type

    type: string

    Private object

    object: RuntimeObject & Resizable

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ResolveTask

    Hierarchy

    Index

    Constructors

    Methods

    Constructors

    constructor

    Methods

    update

    • update(): boolean
    • +ResolveTask | GDevelop JavaScript game engine
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class ResolveTask

      Hierarchy

      Index

      Constructors

      Methods

      Constructors

      constructor

      Methods

      update

      • update(): boolean

      Legend

      • Method
      • Inherited constructor

      Settings

      Theme

      Generated using TypeDoc

      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class ResourceCache<C>

      A cache of resources that helps ensuring that files are only downloaded once.

      -

      Type parameters

      • C

      Hierarchy

      • ResourceCache

      Index

      Methods

      Constructors

      Methods

      clear

      • clear(): void

      delete

      • delete(resource: ResourceData): void

      get

      • get(resource: ResourceData): null | C

      getFromName

      • getFromName(name: string): null | C

      Type parameters

      • C

      Hierarchy

      • ResourceCache

      Index

      Methods

      Constructors

      Methods

      clear

      • clear(): void

      delete

      • delete(resource: ResourceData): void

      get

      • get(resource: ResourceData): null | C

      getFromName

      • getFromName(name: string): null | C

      • Gives a fast access to asset content when they were pre-loaded and on-the-fly loading is not allowed.

        -

        Parameters

        • name: string

        Returns null | C

      set

      • set(resource: ResourceData, content: C): void

      Constructors

      constructor

      Legend

      • Method

      Settings

      Theme

      Generated using TypeDoc

      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class ResourceLoader

      Pre-load resources of any kind needed for a game or a scene.

      -

      Hierarchy

      • ResourceLoader

      Index

      Methods

      Constructors

      Properties

      Methods

      areSceneAssetsLoaded

      • areSceneAssetsLoaded(sceneName: string): boolean

    Hierarchy

    • ResourceLoader

    Index

    Methods

    Constructors

    Properties

    Methods

    areSceneAssetsLoaded

    • areSceneAssetsLoaded(sceneName: string): boolean

    • Parameters

      • sceneName: string

      Returns boolean

      true when all the resources of the given scene are loaded (but maybe not parsed).

      -

    areSceneAssetsReady

    • areSceneAssetsReady(sceneName: string): boolean

    areSceneAssetsReady

    • areSceneAssetsReady(sceneName: string): boolean

    checkIfCredentialsRequired

    • checkIfCredentialsRequired(url: string): boolean

    checkIfCredentialsRequired

    • checkIfCredentialsRequired(url: string): boolean

    • Return true if the specified URL must be loaded with cookies ("credentials") sent to grant access to them.

      -

      Parameters

      • url: string

      Returns boolean

    getBitmapFontManager

    getBitmapFontManager

    getFontManager

    getFontManager

    getFullUrl

    • getFullUrl(url: string): string

    getFullUrl

    • getFullUrl(url: string): string

    • Complete the given URL with any specific parameter required to access the resource (this can be for example a token needed to access the resource).

      -

      Parameters

      • url: string

      Returns string

    getImageManager

    getImageManager

    getJsonManager

    getJsonManager

    getModel3DManager

    getModel3DManager

    getResource

    • getResource(resourceName: string): null | ResourceData

    getRuntimeGame

    getSceneLoadingProgress

    • getSceneLoadingProgress(sceneName: string): number

    getSoundManager

    getResource

    • getResource(resourceName: string): null | ResourceData

    getRuntimeGame

    getSceneLoadingProgress

    • getSceneLoadingProgress(sceneName: string): number

    getSoundManager

    getSpineAtlasManager

    getSpineAtlasManager

    getSpineManager

    getSpineManager

    loadAllResources

    • loadAllResources(onProgress: (loadingCount: number, totalCount: number) => void): Promise<void>

    • Parameters

      • onProgress: (loadingCount: number, totalCount: number) => void
          • (loadingCount: number, totalCount: number): void

          • Parameters

            • loadingCount: number
            • totalCount: number

            Returns void

      Returns Promise<void>

    loadAllSceneInBackground

    • loadAllSceneInBackground(): Promise<void>

    loadAllResources

    • loadAllResources(onProgress: (loadingCount: number, totalCount: number) => void): Promise<void>

    • Parameters

      • onProgress: (loadingCount: number, totalCount: number) => void
          • (loadingCount: number, totalCount: number): void

          • Parameters

            • loadingCount: number
            • totalCount: number

            Returns void

      Returns Promise<void>

    loadAllSceneInBackground

    • loadAllSceneInBackground(): Promise<void>

    • Load each scene in order.

      This is done in background to try to avoid loading screens when changing scenes.

      -

      Returns Promise<void>

    loadAndProcessSceneResources

    • loadAndProcessSceneResources(sceneName: string, onProgress?: (count: number, total: number) => Promise<void>): Promise<void>

    loadAndProcessSceneResources

    • loadAndProcessSceneResources(sceneName: string, onProgress?: (count: number, total: number) => Promise<void>): Promise<void>

    • Load and process a scene that is needed right away.

      The renderer will show a loading screen while its done.

      -

      Parameters

      • sceneName: string
      • Optional onProgress: (count: number, total: number) => Promise<void>
          • (count: number, total: number): Promise<void>

          • Parameters

            • count: number
            • total: number

            Returns Promise<void>

      Returns Promise<void>

    loadGlobalAndFirstSceneResources

    • loadGlobalAndFirstSceneResources(firstSceneName: string, onProgress: (count: number, total: number) => void): Promise<void>
    • +

      Parameters

      • sceneName: string
      • Optional onProgress: (count: number, total: number) => Promise<void>
          • (count: number, total: number): Promise<void>

          • Parameters

            • count: number
            • total: number

            Returns Promise<void>

      Returns Promise<void>

    loadGlobalAndFirstSceneResources

    • loadGlobalAndFirstSceneResources(firstSceneName: string, onProgress: (count: number, total: number) => void): Promise<void>

    • Load the resources that are needed to launch the first scene.

      -

      Parameters

      • firstSceneName: string
      • onProgress: (count: number, total: number) => void
          • (count: number, total: number): void

          • Parameters

            • count: number
            • total: number

            Returns void

      Returns Promise<void>

    loadSceneResources

    • loadSceneResources(sceneName: string, onProgress?: (count: number, total: number) => void): Promise<void>
    • +

      Parameters

      • firstSceneName: string
      • onProgress: (count: number, total: number) => void
          • (count: number, total: number): void

          • Parameters

            • count: number
            • total: number

            Returns void

      Returns Promise<void>

    loadSceneResources

    • loadSceneResources(sceneName: string, onProgress?: (count: number, total: number) => void): Promise<void>

    • Load a scene resources without parsing them.

      When another scene resources are loading in background, it waits for all its resources to be loaded before loading resources of the given scene.

      -

      Parameters

      • sceneName: string
      • Optional onProgress: (count: number, total: number) => void
          • (count: number, total: number): void

          • Parameters

            • count: number
            • total: number

            Returns void

      Returns Promise<void>

    setResources

    • setResources(resourceDataArray: ResourceData[], globalResources: string[], layoutDataArray: LayoutData[]): void
    • +

      Parameters

      • sceneName: string
      • Optional onProgress: (count: number, total: number) => void
          • (count: number, total: number): void

          • Parameters

            • count: number
            • total: number

            Returns void

      Returns Promise<void>

    setResources

    • setResources(resourceDataArray: ResourceData[], globalResources: string[], layoutDataArray: LayoutData[]): void

    • Update the resources data of the game. Useful for hot-reloading, should not be used otherwise.

      -

      Parameters

      • resourceDataArray: ResourceData[]
      • globalResources: string[]
      • layoutDataArray: LayoutData[]

      Returns void

    Constructors

    constructor

    • new ResourceLoader(runtimeGame: RuntimeGame, resourceDataArray: ResourceData[], globalResources: string[], layoutDataArray: LayoutData[]): ResourceLoader

    Constructors

    constructor

    • new ResourceLoader(runtimeGame: RuntimeGame, resourceDataArray: ResourceData[], globalResources: string[], layoutDataArray: LayoutData[]): ResourceLoader

    • Parameters

      • runtimeGame: RuntimeGame

        The game.

      • resourceDataArray: ResourceData[]

        The resources data of the game.

        @@ -64,9 +64,9 @@

        The resources needed for any layer.

      • layoutDataArray: LayoutData[]

        The resources used by each layer.

        -

      Returns ResourceLoader

    Properties

    Private currentLoadingSceneName

    currentLoadingSceneName: string = ''
    +

    Returns ResourceLoader

    Properties

    Private currentLoadingSceneName

    currentLoadingSceneName: string = ''

    Only used by events.

    -

    Private currentSceneLoadingProgress

    currentSceneLoadingProgress: number = 0
    +

    Private currentSceneLoadingProgress

    currentSceneLoadingProgress: number = 0

    Only used by events.

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class RuntimeBehavior

    RuntimeBehavior represents a behavior being used by a RuntimeObject.

    -

    Hierarchy

    Index

    Methods

    Constructors

    Properties

    Methods

    activate

    • activate(enable: boolean): void

    Hierarchy

    Index

    Methods

    Constructors

    Properties

    Methods

    activate

    • activate(enable: boolean): void

    activated

    • activated(): boolean

    Returns void

    activated

    • activated(): boolean

    doStepPostEvents

    doStepPostEvents

    doStepPreEvents

    Returns void

    doStepPreEvents

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getName

    • getName(): string

    Returns void

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    isSyncedOverNetwork

    • isSyncedOverNetwork(): 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

    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

    onDeActivate

    • onDeActivate(): void

    onDestroy

    • onDestroy(): 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

    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

    stepPostEvents

    stepPostEvents

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

      Parameters

      Returns void

    stepPreEvents

    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: BehaviorData, newBehaviorData: BehaviorData): boolean

    Returns void

    updateFromBehaviorData

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

      see

      gdjs.RuntimeBehavior#onObjectHotReloaded

      @@ -58,24 +58,24 @@
  • 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

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    • Update the behavior properties using the provided data.

      Parameters

      • networkSyncData: BehaviorNetworkSyncData

        The new properties of the behavior.

        -

      Returns void

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    Returns void

    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

    Constructors

    constructor

    Constructors

    constructor

    Properties

    name

    name: string

    owner

    owner: RuntimeObject

    type

    type: string

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class RuntimeCustomObjectLayer

    Represents a layer of a custom object. It doesn't allow to move any camera because it doesn't make sense inside an object.

    -

    Hierarchy

    Index

    Methods

    Constructors

    Methods

    addEffect

    • addEffect(effectData: EffectData): void

    Hierarchy

    Index

    Methods

    Constructors

    Methods

    addEffect

    • addEffect(effectData: EffectData): void

    applyLayerInverseTransformation

    • applyLayerInverseTransformation(x: number, y: number, cameraId: number, result: FloatPoint): FloatPoint

    Returns void

    applyLayerInverseTransformation

    • applyLayerInverseTransformation(x: number, y: number, cameraId: number, result: FloatPoint): FloatPoint

    applyLayerTransformation

    • applyLayerTransformation(x: number, y: number, cameraId: number, result: FloatPoint): FloatPoint

    applyLayerTransformation

    • applyLayerTransformation(x: number, y: number, cameraId: number, result: FloatPoint): FloatPoint

    convertCoords

    • convertCoords(x: number, y: number, cameraId: number, result: FloatPoint): FloatPoint

    convertCoords

    • convertCoords(x: number, y: number, cameraId: number, result: FloatPoint): FloatPoint

    convertInverseCoords

    • convertInverseCoords(x: number, y: number, cameraId: number, result: FloatPoint): FloatPoint

    convertInverseCoords

    • convertInverseCoords(x: number, y: number, cameraId: number, result: FloatPoint): FloatPoint

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    followBaseLayer

    • followBaseLayer(): void

    Returns void

    followBaseLayer

    • followBaseLayer(): void

    get3DRendererObject

    • get3DRendererObject(): null | Scene

    getCameraHeight

    • getCameraHeight(cameraId?: number): number

    get3DRendererObject

    • get3DRendererObject(): null | Scene

    getCameraHeight

    • getCameraHeight(cameraId?: number): number

    getCameraRotation

    • getCameraRotation(cameraId?: number): number

    getCameraRotation

    • getCameraRotation(cameraId?: number): number

    getCameraType

    getCameraWidth

    • getCameraWidth(cameraId?: number): number

    getCameraType

    getCameraWidth

    • getCameraWidth(cameraId?: number): number

    getCameraX

    • getCameraX(cameraId?: number): number

    getCameraX

    • getCameraX(cameraId?: number): number

    getCameraY

    • getCameraY(cameraId?: number): number

    getCameraY

    • getCameraY(cameraId?: number): number

    getCameraZ

    • getCameraZ(fov: null | number, cameraId?: number): number

    getCameraZ

    • getCameraZ(fov: null | number, cameraId?: number): number

    getCameraZoom

    • getCameraZoom(cameraId?: number): number

    getCameraZoom

    • getCameraZoom(cameraId?: number): number

    getClearColor

    • getClearColor(): number[]

    getClearColor

    • getClearColor(): number[]

    getDefaultZOrder

    • getDefaultZOrder(): number

    getDefaultZOrder

    • getDefaultZOrder(): number

    getElapsedTime

    getElapsedTime

    getHeight

    • getHeight(): number

    getInitialCamera3DFarPlaneDistance

    • getInitialCamera3DFarPlaneDistance(): number

    getInitialCamera3DFieldOfView

    • getInitialCamera3DFieldOfView(): number

    getInitialCamera3DNearPlaneDistance

    • getInitialCamera3DNearPlaneDistance(): number

    getInitialEffectsData

    • getInitialEffectsData(): EffectData[]

    Returns number

    getHeight

    • getHeight(): number

    getInitialCamera3DFarPlaneDistance

    • getInitialCamera3DFarPlaneDistance(): number

    getInitialCamera3DFieldOfView

    • getInitialCamera3DFieldOfView(): number

    getInitialCamera3DNearPlaneDistance

    • getInitialCamera3DNearPlaneDistance(): number

    getInitialEffectsData

    • getInitialEffectsData(): EffectData[]

    getName

    • getName(): string

    getName

    • getName(): string

    getRenderer

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRenderer

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererObject

    • getRendererObject(): Container<DisplayObject>

    getRenderingType

    getRuntimeScene

    getRendererObject

    • getRendererObject(): Container<DisplayObject>

    getRenderingType

    getRuntimeScene

    getTimeScale

    • getTimeScale(): number

    getTimeScale

    • getTimeScale(): number

    getWidth

    • getWidth(): number

    hasEffect

    • hasEffect(name: string): boolean

    getWidth

    • getWidth(): number

    hasEffect

    • hasEffect(name: string): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isLightingLayer

    • isLightingLayer(): boolean

    isLightingLayer

    • isLightingLayer(): boolean

    isVisible

    • isVisible(): boolean

    isVisible

    • isVisible(): boolean

    onGameResolutionResized

    • onGameResolutionResized(oldGameResolutionOriginX: number, oldGameResolutionOriginY: number): void

    onGameResolutionResized

    • onGameResolutionResized(oldGameResolutionOriginX: number, oldGameResolutionOriginY: number): void

    removeEffect

    • removeEffect(effectName: string): void

    removeEffect

    • removeEffect(effectName: string): void

    setCameraRotation

    • setCameraRotation(rotation: number, cameraId?: number): void

    Returns void

    setCameraRotation

    • setCameraRotation(rotation: number, cameraId?: number): void

    setCameraX

    • setCameraX(x: number, cameraId?: number): void

    setCameraX

    • setCameraX(x: number, cameraId?: number): void

    setCameraY

    • setCameraY(y: number, cameraId?: number): void

    setCameraY

    • setCameraY(y: number, cameraId?: number): void

    setCameraZ

    • setCameraZ(z: number, fov: number, cameraId?: number): void

    setCameraZ

    • setCameraZ(z: number, fov: number, cameraId?: number): void

    setCameraZoom

    • setCameraZoom(newZoom: number, cameraId?: number): void

    setCameraZoom

    • setCameraZoom(newZoom: number, cameraId?: number): void

    setClearColor

    • setClearColor(r: number, g: number, b: number): void

    setClearColor

    • setClearColor(r: number, g: number, b: number): void

    • Set the clear color in format [r, g, b], with components in the range of 0 to 1.;

      Parameters

      • r: number

        Red color component in the range 0-255.

        @@ -118,11 +118,11 @@

        Green color component in the range 0-255.

      • b: number

        Blue color component in the range 0-255.

        -

      Returns void

    setDefaultZOrder

    • setDefaultZOrder(defaultZOrder: number): void

    Returns void

    setDefaultZOrder

    • setDefaultZOrder(defaultZOrder: number): void

    setEffectBooleanParameter

    • setEffectBooleanParameter(name: string, parameterName: string, value: boolean): void

    Returns void

    setEffectBooleanParameter

    • setEffectBooleanParameter(name: string, parameterName: string, value: boolean): void

    setEffectDoubleParameter

    • setEffectDoubleParameter(name: string, parameterName: string, value: number): void

    Returns void

    setEffectDoubleParameter

    • setEffectDoubleParameter(name: string, parameterName: string, value: number): void

    setEffectStringParameter

    • setEffectStringParameter(name: string, parameterName: string, value: string): void

    Returns void

    setEffectStringParameter

    • setEffectStringParameter(name: string, parameterName: string, value: string): void

    setFollowBaseLayerCamera

    • setFollowBaseLayerCamera(follow: boolean): void

    Returns void

    setFollowBaseLayerCamera

    • setFollowBaseLayerCamera(follow: boolean): void

    setTimeScale

    • setTimeScale(timeScale: number): void

    setTimeScale

    • setTimeScale(timeScale: number): void

    show

    • show(enable: boolean): void

    Returns void

    show

    • show(enable: boolean): void

    updatePreRender

    Returns void

    updatePreRender

    Constructors

    constructor

    Constructors

    constructor

    Hierarchy

    • RuntimeGame

    Index

    Methods

    Constructors

    Properties

    Methods

    areSceneAssetsLoaded

    • areSceneAssetsLoaded(sceneName: string): boolean

    • Parameters

      • sceneName: string

      Returns boolean

      true when all the resources of the given scene are loaded (but maybe not parsed).

      -

    areSceneAssetsReady

    • areSceneAssetsReady(sceneName: string): boolean

    areSceneAssetsReady

    • areSceneAssetsReady(sceneName: string): boolean

    • Parameters

      • sceneName: string

      Returns boolean

      true when all the resources of the given scene are loaded and parsed.

      -

    enableMetrics

    • enableMetrics(enable: boolean): void

    enableMetrics

    • enableMetrics(enable: boolean): void

    getAdaptGameResolutionAtRuntime

    • getAdaptGameResolutionAtRuntime(): boolean

    getAdaptGameResolutionAtRuntime

    • getAdaptGameResolutionAtRuntime(): boolean

    • Returns if the game resolution should be automatically adapted when the game window or screen size change. This will only be the case if the game resolution resize mode is configured to adapt the width or the height of the game.

      Returns boolean

      true if the game resolution is automatically changed according to the window/screen size.

      -

    getAdditionalOptions

    getAdditionalOptions

    getAntialiasingMode

    • getAntialiasingMode(): "none" | "MSAA"

    getAntialiasingMode

    • getAntialiasingMode(): "none" | "MSAA"

    getBitmapFontManager

    getBitmapFontManager

    getEffectsManager

    • getEffectsManager(): PixiEffectsManager

    getEffectsManager

    • getEffectsManager(): PixiEffectsManager

    • Get the effects manager of the game, which allows to manage effects on runtime objects or runtime layers.

      Returns PixiEffectsManager

      The effects manager for the game

      -

    getEmbeddedResourcesNames

    • getEmbeddedResourcesNames(resourceName: string): string[]

    getEmbeddedResourcesNames

    • getEmbeddedResourcesNames(resourceName: string): string[]

    • Returns the array of resources that are embedded to passed one.

      Parameters

      • resourceName: string

        The name of resource to find embedded resources of.

      Returns string[]

      The array of related resources names.

      -

    getEventsBasedObjectData

    • getEventsBasedObjectData(type: string): null | EventsBasedObjectData

    getExtensionProperty

    • getExtensionProperty(extensionName: string, propertyName: string): null | string

    getEventsBasedObjectData

    • getEventsBasedObjectData(type: string): null | EventsBasedObjectData

    getExtensionProperty

    • getExtensionProperty(extensionName: string, propertyName: string): null | string

    • Gets an extension property from the project data.

      Parameters

      • extensionName: string

        The extension name.

      • propertyName: string

        The property name.

      Returns null | string

      The property value.

      -

    getExternalLayoutData

    • getExternalLayoutData(name: string): null | ExternalLayoutData

    getExternalLayoutData

    • getExternalLayoutData(name: string): null | ExternalLayoutData

    • Get the data associated to an external layout.

      Parameters

      • name: string

        The name of the external layout.

      Returns null | ExternalLayoutData

      The data associated to the external layout or null if not found.

      -

    getFontManager

    getFontManager

    getGameData

    • getGameData(): ProjectData

    getGameData

    • getGameData(): ProjectData

    getGameResolutionHeight

    • getGameResolutionHeight(): number

    getGameResolutionHeight

    • getGameResolutionHeight(): number

    • Get the game resolution (the size at which the game is played and rendered) height.

      Returns number

      The game resolution height, in pixels.

      -

    getGameResolutionResizeMode

    • getGameResolutionResizeMode(): string

    getGameResolutionResizeMode

    • getGameResolutionResizeMode(): string

    • Returns if the width or the height of the game resolution should be changed to fit the game window - or if the game resolution should not be updated automatically (empty string).

      Returns string

      Either "" (don't change game resolution), "adaptWidth" or "adaptHeight".

      -

    getGameResolutionWidth

    • getGameResolutionWidth(): number

    getGameResolutionWidth

    • getGameResolutionWidth(): number

    • Get the game resolution (the size at which the game is played and rendered) width.

      Returns number

      The game resolution width, in pixels.

      -

    getImageManager

    getImageManager

    getInitialObjectsData

    • getInitialObjectsData(): ObjectData[]

    getInitialObjectsData

    • getInitialObjectsData(): ObjectData[]

    • Get the data representing all the global objects of the game.

      Returns ObjectData[]

      The data associated to the global objects.

      -

    getInputManager

    getInputManager

    getJsonManager

    getJsonManager

    getMinimalFramerate

    • getMinimalFramerate(): number

    getMinimalFramerate

    • getMinimalFramerate(): number

    getModel3DManager

    getModel3DManager

    getNetworkSyncData

    • getNetworkSyncData(syncOptions: GetNetworkSyncDataOptions): null | GameNetworkSyncData

    getOriginalHeight

    • getOriginalHeight(): number

    getNetworkSyncData

    • getNetworkSyncData(syncOptions: GetNetworkSyncDataOptions): null | GameNetworkSyncData

    getOriginalHeight

    • getOriginalHeight(): number

    • Get the original height of the game, as set on the startup of the game.

      This is guaranteed to never change, even if the size of the game is changed afterwards.

      -

      Returns number

    getOriginalWidth

    • getOriginalWidth(): number

    getOriginalWidth

    • getOriginalWidth(): number

    • Get the original width of the game, as set on the startup of the game.

      This is guaranteed to never change, even if the size of the game is changed afterwards.

      -

      Returns number

    getPixelsRounding

    • getPixelsRounding(): boolean

    getPixelsRounding

    • getPixelsRounding(): boolean

    getPlatformInfo

    • getPlatformInfo(): { devicePlatform: any; hasTouch: boolean; isCordova: boolean; navigatorPlatform: string; supportedCompressionMethods: ("cs:gzip" | "cs:deflate")[] }

    getPlatformInfo

    • getPlatformInfo(): { devicePlatform: any; hasTouch: boolean; isCordova: boolean; navigatorPlatform: string; supportedCompressionMethods: ("cs:gzip" | "cs:deflate")[] }

    • Helper function to get information about the platform running the game.

      -

      Returns { devicePlatform: any; hasTouch: boolean; isCordova: boolean; navigatorPlatform: string; supportedCompressionMethods: ("cs:gzip" | "cs:deflate")[] }

      • devicePlatform: any
      • hasTouch: boolean
      • isCordova: boolean
      • navigatorPlatform: string
      • supportedCompressionMethods: ("cs:gzip" | "cs:deflate")[]

    getPlayerId

    • getPlayerId(): null | string

    getRenderer

    getScaleMode

    • getScaleMode(): "linear" | "nearest"
    • +

      Returns { devicePlatform: any; hasTouch: boolean; isCordova: boolean; navigatorPlatform: string; supportedCompressionMethods: ("cs:gzip" | "cs:deflate")[] }

      • devicePlatform: any
      • hasTouch: boolean
      • isCordova: boolean
      • navigatorPlatform: string
      • supportedCompressionMethods: ("cs:gzip" | "cs:deflate")[]

    getPlayerId

    • getPlayerId(): null | string

    getRenderer

    getScaleMode

    • getScaleMode(): "linear" | "nearest"

    getSceneAndExtensionsData

    • getSceneAndExtensionsData(sceneName?: string): null | SceneAndExtensionsData

    getSceneAndExtensionsData

    • getSceneAndExtensionsData(sceneName?: string): null | SceneAndExtensionsData

    • Get the data associated to a scene.

      Parameters

      • Optional sceneName: string

        The name of the scene. If not defined, the first scene will be returned.

      Returns null | SceneAndExtensionsData

      The data associated to the scene.

      -

    getSceneLoadingProgress

    • getSceneLoadingProgress(sceneName: string): number

    getSceneLoadingProgress

    • getSceneLoadingProgress(sceneName: string): number

    • Parameters

      • sceneName: string

      Returns number

      The progress of assets loading in background for a scene (between 0 and 1).

      -

    getSceneStack

    getSceneStack

    getSessionId

    • getSessionId(): null | string

    getSoundManager

    getSessionId

    • getSessionId(): null | string

    getSoundManager

    getSpineAtlasManager

    getSpineAtlasManager

    getSpineManager

    getSpineManager

    getVariables

    getVariables

    getVariablesForExtension

    getVariablesForExtension

    hasJustResumed

    • hasJustResumed(): boolean

    hasJustResumed

    • hasJustResumed(): boolean

    • Returns boolean

      true during the first frame the game is back from being hidden. This has nothing to do with _paused.

      -

    hasScene

    • hasScene(sceneName?: string): boolean

    hasScene

    • hasScene(sceneName?: string): boolean

    • Check if a scene exists

      Parameters

      • Optional sceneName: string

        The name of the scene to search.

      Returns boolean

      true if the scene exists. If sceneName is undefined, true if the game has a scene.

      -

    isAntialisingEnabledOnMobile

    • isAntialisingEnabledOnMobile(): boolean

    isAntialisingEnabledOnMobile

    • isAntialisingEnabledOnMobile(): boolean

    isPreview

    • isPreview(): boolean

    isPreview

    • isPreview(): boolean

    • Check if the game is running as a preview, launched from an editor.

      Returns boolean

      true if the current game is a preview.

      -

    isUsingGDevelopDevelopmentEnvironment

    • isUsingGDevelopDevelopmentEnvironment(): boolean

    isUsingGDevelopDevelopmentEnvironment

    • isUsingGDevelopDevelopmentEnvironment(): boolean

    • Check if the game should call GDevelop development APIs or not.

      Unless you are contributing to GDevelop, avoid using this.

      -

      Returns boolean

    loadAllAssets

    • loadAllAssets(callback: () => void, progressCallback?: (progress: number) => void): void

    loadAllAssets

    • loadAllAssets(callback: () => void, progressCallback?: (progress: number) => void): void

    • Load all assets needed to display the 1st scene, displaying progress in renderer.

      -

      Parameters

      • callback: () => void
          • (): void

          • Returns void

      • Optional progressCallback: (progress: number) => void
          • (progress: number): void

          • Parameters

            • progress: number

            Returns void

      Returns void

    loadFirstAssetsAndStartBackgroundLoading

    • loadFirstAssetsAndStartBackgroundLoading(firstSceneName: string, progressCallback?: (progress: number) => void): Promise<void>
    • +

      Parameters

      • callback: () => void
          • (): void

          • Returns void

      • Optional progressCallback: (progress: number) => void
          • (progress: number): void

          • Parameters

            • progress: number

            Returns void

      Returns void

    loadFirstAssetsAndStartBackgroundLoading

    • loadFirstAssetsAndStartBackgroundLoading(firstSceneName: string, progressCallback?: (progress: number) => void): Promise<void>

    • Load all assets needed to display the 1st scene, displaying progress in renderer.

      When a game is hot-reload, this method can be called with the current scene.

      -

      Parameters

      • firstSceneName: string
      • Optional progressCallback: (progress: number) => void
          • (progress: number): void

          • Parameters

            • progress: number

            Returns void

      Returns Promise<void>

    loadSceneAssets

    • loadSceneAssets(sceneName: string, progressCallback?: (progress: number) => void): Promise<void>
    • +

      Parameters

      • firstSceneName: string
      • Optional progressCallback: (progress: number) => void
          • (progress: number): void

          • Parameters

            • progress: number

            Returns void

      Returns Promise<void>

    loadSceneAssets

    • loadSceneAssets(sceneName: string, progressCallback?: (progress: number) => void): Promise<void>

    • Load all assets for a given scene, displaying progress in renderer.

      -

      Parameters

      • sceneName: string
      • Optional progressCallback: (progress: number) => void
          • (progress: number): void

          • Parameters

            • progress: number

            Returns void

      Returns Promise<void>

    onWindowInnerSizeChanged

    • onWindowInnerSizeChanged(): void
    • +

      Parameters

      • sceneName: string
      • Optional progressCallback: (progress: number) => void
          • (progress: number): void

          • Parameters

            • progress: number

            Returns void

      Returns Promise<void>

    onWindowInnerSizeChanged

    • onWindowInnerSizeChanged(): void

    • Called by the game renderer when the window containing the game has changed size (this can result from a resize of the window, but also other factors like a device orientation change on mobile).

      -

      Returns void

    pause

    • pause(enable: boolean): void

    pause

    • pause(enable: boolean): void

    • Set or unset the game as paused. When paused, the game won't step and will be freezed. Useful for debugging.

      Parameters

      • enable: boolean

        true to pause the game, false to unpause

        -

      Returns void

    prioritizeLoadingOfScene

    • prioritizeLoadingOfScene(sceneName: string): void

    Returns void

    prioritizeLoadingOfScene

    • prioritizeLoadingOfScene(sceneName: string): void

    resolveEmbeddedResource

    • resolveEmbeddedResource(mainResourceName: string, embeddedResourceName: string): string

    resolveEmbeddedResource

    • resolveEmbeddedResource(mainResourceName: string, embeddedResourceName: string): string

    • Resolves the name of an embedded resource.

      Parameters

      • mainResourceName: string

        The name of the resource containing the embedded resource.

      • embeddedResourceName: string

        The name of the embedded resource.

      Returns string

      The resource name.

      -

    setAdaptGameResolutionAtRuntime

    • setAdaptGameResolutionAtRuntime(enable: boolean): void

    setAdaptGameResolutionAtRuntime

    • setAdaptGameResolutionAtRuntime(enable: boolean): void

    • Set if the game resolution should be automatically adapted when the game window or screen size change. This will only be the case if the game resolution resize mode is configured to adapt the width or the height of the game.

      Parameters

      • enable: boolean

        true to change the game resolution according to the window/screen size.

        -

      Returns void

    setGameResolutionResizeMode

    • setGameResolutionResizeMode(resizeMode: string): void

    Returns void

    setGameResolutionResizeMode

    • setGameResolutionResizeMode(resizeMode: string): void

    • Set if the width or the height of the game resolution should be changed to fit the game window - or if the game resolution should not be updated automatically.

      Parameters

      • resizeMode: string

        Either "" (don't change game resolution), "adaptWidth" or "adaptHeight".

        -

      Returns void

    setGameResolutionSize

    • setGameResolutionSize(width: number, height: number): void

    Returns void

    setGameResolutionSize

    • setGameResolutionSize(width: number, height: number): void

    setProjectData

    • setProjectData(projectData: ProjectData): void

    Returns void

    setProjectData

    • setProjectData(projectData: ProjectData): void

    • Update the project data. Useful for hot-reloading, should not be used otherwise.

      Parameters

      • projectData: ProjectData

        The object (usually stored in data.json) containing the full project data

        -

      Returns void

    startCurrentSceneProfiler

    • startCurrentSceneProfiler(onProfilerStopped: (oldProfiler: Profiler) => void): boolean

    Returns void

    startCurrentSceneProfiler

    • startCurrentSceneProfiler(onProfilerStopped: (oldProfiler: Profiler) => void): boolean

    • Start a profiler for the currently running scene.

      Parameters

      • onProfilerStopped: (oldProfiler: Profiler) => void

        Function to be called when the profiler is stopped. Will be passed the profiler as argument.

        -

      Returns boolean

    startGameLoop

    • startGameLoop(): void

    Returns boolean

    startGameLoop

    • startGameLoop(): void

    stopCurrentSceneProfiler

    • stopCurrentSceneProfiler(): void

    stopCurrentSceneProfiler

    • stopCurrentSceneProfiler(): void

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(syncData: GameNetworkSyncData): void

    wasFirstSceneLoaded

    • wasFirstSceneLoaded(): boolean

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(syncData: GameNetworkSyncData): void

    wasFirstSceneLoaded

    • wasFirstSceneLoaded(): boolean

    Constructors

    constructor

    Constructors

    constructor

    Properties

    inventories

    inventories: {}

    Type declaration

    shopifyClients

    shopifyClients: {}

    Type declaration

    • [name: string]: any

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class RuntimeGamePixiRenderer

    The renderer for a gdjs.RuntimeGame using Pixi.js.

    -

    Hierarchy

    • RuntimeGamePixiRenderer

    Index

    Methods

    Constructors

    Methods

    bindStandardEvents

    • bindStandardEvents(manager: InputManager, window: Window, document: Document): void

    Hierarchy

    • RuntimeGamePixiRenderer

    Index

    Methods

    Constructors

    Methods

    bindStandardEvents

    • bindStandardEvents(manager: InputManager, window: Window, document: Document): void

    centerWindow

    • centerWindow(): void

    centerWindow

    • centerWindow(): void

    convertCanvasToDomElementContainerCoords

    • convertCanvasToDomElementContainerCoords(canvasCoords: FloatPoint, result: FloatPoint): FloatPoint

    convertCanvasToDomElementContainerCoords

    • convertCanvasToDomElementContainerCoords(canvasCoords: FloatPoint, result: FloatPoint): FloatPoint

    • Convert a point from the canvas coordinates to the dom element container coordinates.

      Parameters

      • canvasCoords: FloatPoint

        The point in the canvas coordinates.

      • result: FloatPoint

        The point to return.

      Returns FloatPoint

      The point in the dom element container coordinates.

      -

    createStandardCanvas

    • createStandardCanvas(parentElement: HTMLElement): void

    createStandardCanvas

    • createStandardCanvas(parentElement: HTMLElement): void

    getCanvas

    • getCanvas(): null | HTMLCanvasElement

    getCanvas

    • getCanvas(): null | HTMLCanvasElement

    getCanvasToDomElementContainerHeightScale

    • getCanvasToDomElementContainerHeightScale(): number

    getCanvasToDomElementContainerHeightScale

    • getCanvasToDomElementContainerHeightScale(): number

    • Return the scale factor between the renderer height and the actual canvas height, which is also the height of the container for DOM elements to be superimposed on top of it.

      Useful to scale font sizes of DOM elements so that they follow the size of the game.

      -

      Returns number

    getDomElementContainer

    • getDomElementContainer(): null | HTMLDivElement

    getDomElementContainer

    • getDomElementContainer(): null | HTMLDivElement

    getElectron

    • getElectron(): any

    getElectron

    • getElectron(): any

    getElectronRemote

    • getElectronRemote(): any

    getElectronRemote

    • getElectronRemote(): any

    getGame

    getPIXIRenderer

    • getPIXIRenderer(): null | Renderer

    getThreeRenderer

    • getThreeRenderer(): null | WebGLRenderer

    getGame

    getPIXIRenderer

    • getPIXIRenderer(): null | Renderer

    getThreeRenderer

    • getThreeRenderer(): null | WebGLRenderer

    Static getWindowInnerHeight

    • getWindowInnerHeight(): number

    Static getWindowInnerWidth

    • getWindowInnerWidth(): number

    getWindowTitle

    • getWindowTitle(): string

    isFullScreen

    • isFullScreen(): boolean

    Static getWindowInnerHeight

    • getWindowInnerHeight(): number

    Static getWindowInnerWidth

    • getWindowInnerWidth(): number

    getWindowTitle

    • getWindowTitle(): string

    isFullScreen

    • isFullScreen(): boolean

    isWebGLSupported

    • isWebGLSupported(): boolean

    isWebGLSupported

    • isWebGLSupported(): boolean

    keepAspectRatio

    • keepAspectRatio(enable: any): void

    keepAspectRatio

    • keepAspectRatio(enable: any): void

    openURL

    • openURL(url: string): void

    openURL

    • openURL(url: string): void

    setFullScreen

    • setFullScreen(enable: any): void

    setFullScreen

    • setFullScreen(enable: any): void

    setMargins

    • setMargins(top: any, right: any, bottom: any, left: any): void

    setMargins

    • setMargins(top: any, right: any, bottom: any, left: any): void

    setWindowSize

    • setWindowSize(width: number, height: number): void

    setWindowSize

    • setWindowSize(width: number, height: number): void

    setWindowTitle

    • setWindowTitle(title: any): void

    startGameLoop

    • startGameLoop(fn: any): void

    stopGame

    • stopGame(): void

    Returns void

    setWindowTitle

    • setWindowTitle(title: any): void

    startGameLoop

    • startGameLoop(fn: any): void

    stopGame

    • stopGame(): void

    updateRendererSize

    • updateRendererSize(): void

    updateRendererSize

    • updateRendererSize(): void

    • Update the game renderer size according to the "game resolution". Called when game resolution changes.

      Note that if the canvas is fullscreen, it won't be resized, but when going back to non fullscreen mode, the requested size will be used.

      -

      Returns void

    Constructors

    constructor

    Constructors

    constructor

    addObject

    Abstract convertCoords

    • convertCoords(x: number, y: number, result?: FloatPoint): FloatPoint

    Returns void

    Abstract convertCoords

    • convertCoords(x: number, y: number, result?: FloatPoint): FloatPoint

    • Convert a point from the canvas coordinates (for example, the mouse position) to the container coordinates.

      Parameters

      • x: number
        @@ -17,7 +17,7 @@

        The y position, in container coordinates.

      • Optional result: FloatPoint

        The point instance that is used to return the result.

        -

      Returns FloatPoint

    Abstract convertInverseCoords

    • convertInverseCoords(sceneX: number, sceneY: number, result: FloatPoint): FloatPoint

    Returns FloatPoint

    Abstract convertInverseCoords

    • convertInverseCoords(sceneX: number, sceneY: number, result: FloatPoint): FloatPoint

    • Convert a point from the container coordinates (for example, an object position) to the canvas coordinates.

      Parameters

      • sceneX: number
        @@ -26,13 +26,13 @@

        The y position, in container coordinates.

      • result: FloatPoint

        The point instance that is used to return the result.

        -

      Returns FloatPoint

    createObject

    Returns FloatPoint

    createObject

    createObjectsFrom

    • createObjectsFrom(data: InstanceData[], xPos: number, yPos: number, zPos: number, trackByPersistentUuid: boolean): void

    createObjectsFrom

    • createObjectsFrom(data: InstanceData[], xPos: number, yPos: number, zPos: number, trackByPersistentUuid: boolean): void

    • Create objects from initial instances data (for example, the initial instances of the scene or the instances of an external layout).

      Parameters

      • data: InstanceData[]
        @@ -46,121 +46,121 @@
      • trackByPersistentUuid: boolean

        If true, objects are tracked by setting their persistentUuid to the same as the associated instance. Useful for hot-reloading when instances are changed.

        -

      Returns void

    enableDebugDraw

    • enableDebugDraw(enableDebugDraw: boolean, showHiddenInstances: boolean, showPointsNames: boolean, showCustomPoints: boolean): void

    Returns void

    enableDebugDraw

    • enableDebugDraw(enableDebugDraw: boolean, showHiddenInstances: boolean, showPointsNames: boolean, showCustomPoints: boolean): void

    • Activate or deactivate the debug visualization for collisions and points.

      -

      Parameters

      • enableDebugDraw: boolean
      • showHiddenInstances: boolean
      • showPointsNames: boolean
      • showCustomPoints: boolean

      Returns void

    getAdhocListOfAllInstances

    getAdhocListOfAllInstances

    getAllLayerNames

    • getAllLayerNames(result: string[]): void

    getAllLayerNames

    • getAllLayerNames(result: string[]): void

    Abstract getDebuggerRenderer

    Returns void

    Abstract getDebuggerRenderer

    Abstract getElapsedTime

    • getElapsedTime(): number

    Abstract getElapsedTime

    • getElapsedTime(): number

    Abstract getGame

    Abstract getGame

    getInitialSharedDataForBehavior

    • getInitialSharedDataForBehavior(name: string): null | BehaviorSharedData

    getInitialSharedDataForBehavior

    • getInitialSharedDataForBehavior(name: string): null | BehaviorSharedData

    • Get the data representing the initial shared data of the scene for the specified behavior.

      Parameters

      • name: string

        The name of the behavior

      Returns null | BehaviorSharedData

      The shared data for the behavior, if any.

      -

    getInstancesCountOnScene

    • getInstancesCountOnScene(objectName: string): number

    getInstancesCountOnScene

    • getInstancesCountOnScene(objectName: string): number

    • Return the number of instances of the specified object living in the container.

      Parameters

      • objectName: string

        The object name for which instances must be counted.

        -

      Returns number

    getInstancesOf

    getInstancesOf

    getLayer

    getLayer

    getObjects

    getObjects

    Abstract getRenderer

    Abstract getRenderer

    Abstract getScene

    Abstract getScene

    Abstract getViewportHeight

    • getViewportHeight(): number

    Returns RuntimeScene

    Abstract getViewportHeight

    • getViewportHeight(): number

    Abstract getViewportOriginX

    • getViewportOriginX(): number

    Abstract getViewportOriginX

    • getViewportOriginX(): number

    Abstract getViewportOriginY

    • getViewportOriginY(): number

    Abstract getViewportOriginY

    • getViewportOriginY(): number

    Abstract getViewportWidth

    • getViewportWidth(): number

    Abstract getViewportWidth

    • getViewportWidth(): number

    hasLayer

    • hasLayer(name: string): boolean

    hasLayer

    • hasLayer(name: string): boolean

    isObjectRegistered

    • isObjectRegistered(objectName: string): boolean

    Returns boolean

    isObjectRegistered

    • isObjectRegistered(objectName: string): boolean

    • Check if an object is registered, meaning that instances of it can be created and lives in the container.

      see

      gdjs.RuntimeInstanceContainer#registerObject

      -

      Parameters

      • objectName: string

      Returns boolean

    markObjectForDeletion

    markObjectForDeletion

    Abstract onChildrenLocationChanged

    • onChildrenLocationChanged(): void

    Returns void

    Abstract onChildrenLocationChanged

    • onChildrenLocationChanged(): void

    registerObject

    • registerObject(objectData: ObjectData): void

    registerObject

    • registerObject(objectData: ObjectData): void

    removeLayer

    • removeLayer(layerName: string): void

    Returns void

    removeLayer

    • removeLayer(layerName: string): void

    setInitialSharedDataForBehavior

    • setInitialSharedDataForBehavior(name: string, sharedData: null | BehaviorSharedData): void

    Returns void

    setInitialSharedDataForBehavior

    • setInitialSharedDataForBehavior(name: string, sharedData: null | BehaviorSharedData): void

    • Set the data representing the initial shared data of the scene for the specified behavior.

      Parameters

      • name: string

        The name of the behavior

      • sharedData: null | BehaviorSharedData

        The shared data for the behavior, or null to remove it.

        -

      Returns void

    setLayerIndex

    • setLayerIndex(layerName: string, newIndex: number): void

    Returns void

    setLayerIndex

    • setLayerIndex(layerName: string, newIndex: number): void

    unregisterObject

    • unregisterObject(objectName: string): void

    Returns void

    unregisterObject

    • unregisterObject(objectName: string): void

    updateObject

    • updateObject(objectData: ObjectData): void

    Returns void

    updateObject

    • updateObject(objectData: ObjectData): void

    updateObjectsForces

    • updateObjectsForces(): void

    Returns void

    updateObjectsForces

    • updateObjectsForces(): void

    Constructors

    constructor

    Properties

    pathfindingObstaclesManager

    pathfindingObstaclesManager: PathfindingObstaclesManager

    tileMapCollisionMaskManager

    tileMapCollisionMaskManager: TileMapRuntimeManager

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class RuntimeObject3D

    Base class for 3D objects.

    -

    Hierarchy

    Implements

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    Hierarchy

    Implements

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    addEffect

    • addEffect(effectData: EffectData): boolean

    Returns void

    addEffect

    • addEffect(effectData: EffectData): boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    Returns boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    • Add a force to the object to move it.

      Parameters

      • x: number

        The x coordinates of the force

        @@ -18,7 +18,7 @@

        The y coordinates of the force

      • multiplier: number

        Set the force multiplier

        -

      Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    Returns void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    Returns void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    • Create the behavior described by the given BehaviorData

      Parameters

      • behaviorData: BehaviorData

        The data to be used to construct the behavior.

      Returns boolean

      true if the behavior was properly created, false otherwise.

      -

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns boolean

    true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

    -

    behaviorActivated

    • behaviorActivated(name: string): boolean

    behaviorActivated

    • behaviorActivated(name: string): boolean

    clearEffects

    • clearEffects(): boolean

    clearEffects

    • clearEffects(): boolean

    clearForces

    • clearForces(): void

    clearForces

    • clearForces(): void

    Static collisionTest

    Static collisionTest

    • Return true if the hitboxes of two objects are overlapping

      static

      Parameters

      • obj1: RuntimeObject

        The first runtimeObject

        @@ -78,68 +78,68 @@
      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if obj1 and obj2 are in collision

      -

    cursorOnObject

    cursorOnObject

    deleteFromScene

    deleteFromScene

    Static distanceTest

    Returns void

    Static distanceTest

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    Returns void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    flipX

    • flipX(enable: boolean): void

    flipY

    • flipY(enable: boolean): void

    flipZ

    • flipZ(enable: boolean): void

    get3DRendererObject

    • get3DRendererObject(): Object3D<Object3DEventMap>

    getAABB

    flipX

    • flipX(enable: boolean): void

    flipY

    • flipY(enable: boolean): void

    flipZ

    • flipZ(enable: boolean): void

    get3DRendererObject

    • get3DRendererObject(): Object3D<Object3DEventMap>

    getAABB

    • Get the AABB (axis aligned bounding box) for the object.

      The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

      You should probably redefine updateAABB instead of this function.

      Returns AABB

      The bounding box

      -

    getAABBBottom

    • getAABBBottom(): number

    getAABBBottom

    • getAABBBottom(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBRight

    • getAABBRight(): number

    getAABBRight

    • getAABBRight(): number

    getAABBTop

    • getAABBTop(): number

    getAABBTop

    • getAABBTop(): number

    getAngle

    • getAngle(): number

    getAngle

    • getAngle(): number

    getAngleToObject

    getAngleToObject

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    Returns number

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    getAverageForce

    Returns number

    getAverageForce

    getBehavior

    getBehavior

    • Get a behavior from its name. If the behavior does not exists, undefined is returned.

      Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -147,75 +147,75 @@

      Parameters

      • name: string

        The behavior name.

      Returns null | RuntimeBehavior

      The behavior with the given name, or undefined.

      -

    getCenterX

    • getCenterX(): number

    getCenterX

    • getCenterX(): number

    • Return the X position of the object center, relative to the object X position (getDrawableX). Use getCenterXInScene to get the position of the center in the scene.

      Returns number

      the X position of the object center, relative to getDrawableX().

      -

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterY

    • getCenterY(): number

    getCenterY

    • getCenterY(): number

    • Return the Y position of the object center, relative to the object position (getDrawableY). Use getCenterYInScene to get the position of the center in the scene.

      Returns number

      the Y position of the object center, relative to getDrawableY().

      -

    getCenterYInScene

    • getCenterYInScene(): number

    getCenterYInScene

    • getCenterYInScene(): number

    getCenterZ

    • getCenterZ(): number

    getCenterZ

    • getCenterZ(): number

    • Return the Z position of the object center, relative to the object Z position (getDrawableX).

      Use getCenterZInScene to get the position of the center in the scene.

      Returns number

      the Z position of the object center, relative to getDrawableZ().

      -

    getCenterZInScene

    • getCenterZInScene(): number

    getCenterZInScene

    • getCenterZInScene(): number

    getDepth

    • getDepth(): number

    getDepth

    • getDepth(): number

    getDistanceToObject

    getDistanceToObject

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    getDrawableX

    • getDrawableX(): number

    Returns number

    getDrawableX

    • getDrawableX(): number

    • Get the X position of the rendered object.

      For most objects, this will returns the same value as getX(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableX will differ.

      Returns number

      The X position of the rendered object.

      -

    getDrawableY

    • getDrawableY(): number

    getDrawableY

    • getDrawableY(): number

    • Get the Y position of the rendered object.

      For most objects, this will returns the same value as getY(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableY will differ.

      Returns number

      The Y position of the rendered object.

      -

    getDrawableZ

    • getDrawableZ(): number

    getDrawableZ

    • getDrawableZ(): number

    • Get the Z position of the rendered object.

      For most objects, this will returns the same value as getZ(). But if the object has an origin that is not the same as the point (0,0,0) of the object displayed, getDrawableZ will differ.

      Returns number

      The Z position of the rendered object.

      -

    getElapsedTime

    getElapsedTime

    getHeight

    • getHeight(): number

    Returns number

    getHeight

    • getHeight(): number

    getHitBoxes

    getHitBoxes

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    • Return at least all the hit boxes that overlap a given area.

      The hit boxes don't need to actually overlap the area, (i.e: it's correct to return more hit boxes than those in the specified area) @@ -240,191 +240,191 @@

    • bottom: number

      bound of the area in scene coordinates

    Returns Iterable<Polygon>

    at least all the hit boxes that overlap a given area.

    -

    getInstanceContainer

    getInstanceContainer

    getLayer

    • getLayer(): string

    getLayer

    • getLayer(): string

    getName

    • getName(): string

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    • Get the identifier associated to an object name. Some features may want to compare objects name a large number of time. In this case, it may be more efficient to compare objects name identifiers.

      -
      static

      Parameters

      • name: string

      Returns number

    getNetworkSyncData

    getNetworkSyncData

    getParent

    getParent

    Abstract getRenderer

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    Abstract getRenderer

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererObject

    • getRendererObject(): null

    getRotationX

    • getRotationX(): number

    getRendererObject

    • getRendererObject(): null

    getRotationX

    • getRotationX(): number

    getRotationY

    • getRotationY(): number

    getRotationY

    • getRotationY(): number

    getRuntimeScene

    getRuntimeScene

    getScale

    • getScale(): number

    getScale

    • getScale(): number

    • Get the scale of the object (or the geometric average of X, Y and Z scale in case they are different).

      Returns number

      the scale of the object (or the geometric average of X, Y and Z scale in case they are different).

      -

    getScaleX

    • getScaleX(): number

    getScaleX

    • getScaleX(): number

    getScaleY

    • getScaleY(): number

    getScaleY

    • getScaleY(): number

    getScaleZ

    • getScaleZ(): number

    getScaleZ

    • getScaleZ(): number

    getSqDistanceToObject

    getSqDistanceToObject

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    Returns number

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    • Get a timer elapsed time.

      This is used by expressions to return 0 when a timer doesn't exist because numeric expressions must always return a number.

      Parameters

      • timerName: string

        The timer name.

      Returns number

      The timer elapsed time in seconds, 0 if the timer doesn't exist.

      -

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getUniqueId

    • getUniqueId(): number

    getUniqueId

    • getUniqueId(): number

    • Get the unique identifier of the object.
      The identifier is set by the runtimeScene owning the object.
      You can also use the id property (this._object.id) for increased efficiency instead of calling this method.

      Returns number

      The object identifier

      -

    getUnrotatedAABBMaxZ

    • getUnrotatedAABBMaxZ(): number

    getUnrotatedAABBMaxZ

    • getUnrotatedAABBMaxZ(): number

    getUnrotatedAABBMinZ

    • getUnrotatedAABBMinZ(): number

    getUnrotatedAABBMinZ

    • getUnrotatedAABBMinZ(): number

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableString

    • getVariableString(variable: Variable): string

    Static getVariableString

    • getVariableString(variable: Variable): string

    getVariables

    getVariables

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    • Get the AABB (axis aligned bounding box) to be used to determine if the object is visible on screen. The gdjs.RuntimeScene will hide the renderer object if the object is not visible on screen ("culling").

      The default implementation uses the AABB returned by getAABB.

      If null is returned, the object is assumed to be always visible.

      Returns null | AABB

      The bounding box or null.

      -

    getWidth

    • getWidth(): number

    getWidth

    • getWidth(): number

    getX

    • getX(): number

    getX

    • getX(): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    • Compute the X position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getY

    • getY(): number

    Returns number

    getY

    • getY(): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    • Compute the Y position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getZ

    • getZ(): number

    Returns number

    getZ

    • getZ(): number

    getZOrder

    • getZOrder(): number

    getZOrder

    • getZOrder(): number

    hasBehavior

    • hasBehavior(name: string): boolean

    hasBehavior

    • hasBehavior(name: string): boolean

    hasEffect

    • hasEffect(name: string): boolean

    Returns boolean

    hasEffect

    • hasEffect(name: string): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hide

    • hide(enable: boolean): void

    hide

    • hide(enable: boolean): void

    insideObject

    • insideObject(x: number, y: number): boolean

    insideObject

    • insideObject(x: number, y: number): boolean

    • Return true if the specified position is inside object bounding box.

      The position should be in "world" coordinates, i.e use gdjs.Layer.convertCoords if you need to pass the mouse or a touch position that you get from gdjs.InputManager. To check if a point is inside the object collision mask, you can use isCollidingWithPoint instead.

      -

      Parameters

      • x: number
      • y: number

      Returns boolean

    invalidateHitboxes

    • invalidateHitboxes(): void

    invalidateHitboxes

    • invalidateHitboxes(): void

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isFlippedX

    • isFlippedX(): boolean

    isFlippedY

    • isFlippedY(): boolean

    isFlippedZ

    • isFlippedZ(): boolean

    isHidden

    • isHidden(): boolean

    isFlippedX

    • isFlippedX(): boolean

    isFlippedY

    • isFlippedY(): boolean

    isFlippedZ

    • isFlippedZ(): boolean

    isHidden

    • isHidden(): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    • Return true if the angle of the total force applied on the object is in a given range.

      Parameters

      • angle: number
        @@ -433,43 +433,43 @@

        The maximum distance from the given angle.

      Returns boolean

      true if the difference between the force angle the given angle is less or equals the toleranceInDegrees.

      -

    isVisible

    • isVisible(): boolean

    isVisible

    • isVisible(): boolean

    • Return true if the object is not hidden.

      Note: This is unrelated to the actual visibility of the object on the screen. For this, see getVisibilityAABB to get the bounding boxes of the object as displayed on the scene.

      Returns boolean

      true if the object is not hidden.

      -

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    • To be called by the child classes in their constructor, at the very end. Notify the behaviors that they have been constructed (this must be done when the object is ready, otherwise behaviors can do operations on the object which could be not initialized yet).

      If you redefine this function, make sure to call the original method (RuntimeObject.prototype.onCreated.call(this);).

      -

      Returns void

    onDeletedFromScene

    onDeletedFromScene

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    Returns void

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    onSceneResumed

    Returns void

    onSceneResumed

    pauseTimer

    • pauseTimer(timerName: string): void

    Returns void

    pauseTimer

    • pauseTimer(timerName: string): void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    Returns void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    • Put the object around a position, with a specific distance and angle. The distance and angle are computed between the position and the center of the object.

      Parameters

      • x: number
        @@ -480,7 +480,7 @@

        The distance between the object and the target, in pixels.

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    • Put the object around another object, with a specific distance and angle. The distance and angle are computed between the centers of the objects.

      Parameters

      • obj: null | RuntimeObject
        @@ -489,7 +489,7 @@

        The distance between the object and the target

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    • Called to reset the object to its default state. This is used for objects that are "recycled": they are dismissed (at which point onDestroyFromScene is called) but still stored in a cache to be reused next time an object must be created. At this point, @@ -515,7 +515,7 @@

    • The _runtimeScene, _nameId, name and type are guaranteed to stay the same and do not need to be set again.
    -

    Parameters

    Returns void

    removeBehavior

    removeBehavior

    removeEffect

    removeEffect

    removeTimer

    Returns boolean

    removeTimer

    resetTimer

    Returns void

    resetTimer

    Static returnVariable

    Returns void

    Static returnVariable

    rotate

    rotate

    rotateTowardAngle

    rotateTowardAngle

    rotateTowardPosition

    separateFromObjects

    Returns void

    rotateTowardPosition

    separateFromObjects

    separateFromObjectsList

    separateFromObjectsList

    separateObjectsWithForces

    separateObjectsWithForces

    separateObjectsWithoutForces

    separateObjectsWithoutForces

    setAngle

    Returns void

    setAngle

    setCenterPositionInScene

    setCenterPositionInScene

    setCenterXInScene

    Returns void

    setCenterXInScene

    setCenterYInScene

    Returns void

    setCenterYInScene

    setCenterZInScene

    setCenterZInScene

    setDepth

    setDepth

    setEffectBooleanParameter

    setEffectBooleanParameter

    setEffectDoubleParameter

    Returns boolean

    setEffectDoubleParameter

    setEffectStringParameter

    Returns boolean

    setEffectStringParameter

    setHeight

    Returns boolean

    setHeight

    setIncludedInParentCollisionMask

    setLayer

    setIncludedInParentCollisionMask

    setLayer

    setPosition

    Returns void

    setPosition

    setRotationX

    Returns void

    setRotationX

    setRotationY

    setRotationY

    setScale

    setScale

    setScaleX

    Returns void

    setScaleX

    setScaleY

    Returns void

    setScaleY

    setScaleZ

    Returns void

    setScaleZ

    setSize

    Returns void

    setSize

    Static setVariableNumber

    Static setVariableNumber

    Static setVariableString

    Returns void

    Static setVariableString

    setWidth

    Returns void

    setWidth

    setX

    setX

    setY

    setY

    setZ

    setZ

    setZOrder

    setZOrder

    stepBehaviorsPostEvents

    Returns void

    stepBehaviorsPostEvents

    stepBehaviorsPreEvents

    stepBehaviorsPreEvents

    timerElapsedTime

    timerElapsedTime

    timerPaused

    timerPaused

    turnAroundX

    turnAroundX

    turnAroundY

    Returns void

    turnAroundY

    turnAroundZ

    Returns void

    turnAroundZ

    unpauseTimer

    Returns void

    unpauseTimer

    unregisterDestroyCallback

    update

    Returns void

    unregisterDestroyCallback

    update

    updateAABB

    Returns void

    updateAABB

    updateAllEffectParameters

    updateAllEffectParameters

    updateForces

    Returns boolean

    updateForces

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    updateFromObjectData

    updateFromObjectData

    updateHitBoxes

    updateHitBoxes

    updatePreRender

    updatePreRender

    updateTimers

    Returns void

    updateTimers

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []
    +

    Returns void

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []

    Global container for unused forces, avoiding recreating forces each tick.

    -
    static

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number
      • +

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number

      • Get the squared distance, in pixels, between the center of this object and a position.

        Parameters

        • targetX: number

          Target X position

        • targetY: number

          Target Y position

          -

        Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • +

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • Get the number of children from a variable

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The number of children

        -

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

      • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The value of the specified variable

        -

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

      • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns string

        The string of the specified variable

        -

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null
    +

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null

    A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

    -

    persistentUuid

    persistentUuid: null | string = null
    +

    persistentUuid

    persistentUuid: null | string = null

    An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

    -

    pick

    pick: boolean = false
    +

    pick

    pick: boolean = false

    A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

    -

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

      • Return the variable passed as argument without any change. Only for usage by events.

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns Variable

        The specified variable

        -

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void
      • +

      Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void

      • Shortcut to set the value of a variable considered as a number

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: number

          The value to be set

          -

        Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void
      • +

      Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void

      • Shortcut to set the value of a variable considered as a string

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: string

          The value to be set

          -

        Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • +

      Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable
          +

          Parameters

          • array: Variable
          • value: string | number | boolean

          Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable

          The variable to be tested

        • childName: string

          The name of the child

          -

        Returns boolean

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

      • static

        Parameters

        • variable: Variable

          The variable to be cleared

          -

        Returns void

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

        • variable: Variable

          The variable to be changed

        • childName: string

          The name of the child

          -

        Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • +

      Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Constructors

    constructor

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class RuntimeObject3DRenderer

    Hierarchy

    • RuntimeObject3DRenderer

    Index

    Constructors

    Methods

    Constructors

    constructor

    Methods

    get3DRendererObject

    • get3DRendererObject(): Object3D<Object3DEventMap>

    updatePosition

    • updatePosition(): void

    updateRotation

    • updateRotation(): void

    updateSize

    • updateSize(): void

    updateVisibility

    • updateVisibility(): void

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class RuntimeObject3DRenderer

    Hierarchy

    • RuntimeObject3DRenderer

    Index

    Constructors

    Methods

    Constructors

    constructor

    Methods

    get3DRendererObject

    • get3DRendererObject(): Object3D<Object3DEventMap>

    updatePosition

    • updatePosition(): void

    updateRotation

    • updateRotation(): void

    updateSize

    • updateSize(): void

    updateVisibility

    • updateVisibility(): void

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class RuntimeScene

    A scene being played, containing instances of objects rendered on screen.

    -

    Hierarchy

    Index

    Methods

    Constructors

    Properties

    Methods

    addLayer

    • addLayer(layerData: LayerData): void

    Hierarchy

    Index

    Methods

    Constructors

    Properties

    Methods

    addLayer

    • addLayer(layerData: LayerData): void

    addObject

    addObject

    convertCoords

    • convertCoords(x: number, y: number, result: FloatPoint): FloatPoint

    Returns void

    convertCoords

    • convertCoords(x: number, y: number, result: FloatPoint): FloatPoint

    convertInverseCoords

    • convertInverseCoords(sceneX: number, sceneY: number, result: FloatPoint): FloatPoint

    convertInverseCoords

    • convertInverseCoords(sceneX: number, sceneY: number, result: FloatPoint): FloatPoint

    createNewUniqueId

    • createNewUniqueId(): number

    createNewUniqueId

    • createNewUniqueId(): number

    createObject

    createObject

    createObjectsFrom

    • createObjectsFrom(data: InstanceData[], xPos: number, yPos: number, zPos: number, trackByPersistentUuid: boolean): void

    createObjectsFrom

    • createObjectsFrom(data: InstanceData[], xPos: number, yPos: number, zPos: number, trackByPersistentUuid: boolean): void

    • Create objects from initial instances data (for example, the initial instances of the scene or the instances of an external layout).

      Parameters

      • data: InstanceData[]
        @@ -34,160 +34,160 @@
      • trackByPersistentUuid: boolean

        If true, objects are tracked by setting their persistentUuid to the same as the associated instance. Useful for hot-reloading when instances are changed.

        -

      Returns void

    enableDebugDraw

    • enableDebugDraw(enableDebugDraw: boolean, showHiddenInstances: boolean, showPointsNames: boolean, showCustomPoints: boolean): void

    Returns void

    enableDebugDraw

    • enableDebugDraw(enableDebugDraw: boolean, showHiddenInstances: boolean, showPointsNames: boolean, showCustomPoints: boolean): void

    getAdhocListOfAllInstances

    getAdhocListOfAllInstances

    getAllLayerNames

    • getAllLayerNames(result: string[]): void

    getAllLayerNames

    • getAllLayerNames(result: string[]): void

    getAsyncTasksManager

    getBackgroundColor

    • getBackgroundColor(): number

    Returns void

    getAsyncTasksManager

    getBackgroundColor

    • getBackgroundColor(): number

    getClearCanvas

    • getClearCanvas(): boolean

    getClearCanvas

    • getClearCanvas(): boolean

    getDebuggerRenderer

    getDebuggerRenderer

    getElapsedTime

    • getElapsedTime(): number

    getElapsedTime

    • getElapsedTime(): number

    getGame

    getGame

    getInitialSharedDataForBehavior

    • getInitialSharedDataForBehavior(name: string): null | BehaviorSharedData

    getInitialSharedDataForBehavior

    • getInitialSharedDataForBehavior(name: string): null | BehaviorSharedData

    getInstancesCountOnScene

    • getInstancesCountOnScene(objectName: string): number

    getInstancesCountOnScene

    • getInstancesCountOnScene(objectName: string): number

    getInstancesOf

    getInstancesOf

    getLayer

    getLayer

    getName

    • getName(): string

    getName

    • getName(): string

    getNetworkSyncData

    • getNetworkSyncData(syncOptions: GetNetworkSyncDataOptions): null | LayoutNetworkSyncData

    getObjects

    getNetworkSyncData

    • getNetworkSyncData(syncOptions: GetNetworkSyncDataOptions): null | LayoutNetworkSyncData

    getObjects

    getOnceTriggers

    getOnceTriggers

    getOrCreateNetworkId

    • getOrCreateNetworkId(): string

    getProfiler

    getOrCreateNetworkId

    • getOrCreateNetworkId(): string

    getProfiler

    getRenderer

    getRenderer

    getRequestedChange

    getRequestedChange

    getRequestedScene

    • getRequestedScene(): string

    getRequestedScene

    • getRequestedScene(): string

    getScene

    getScene

    getSoundManager

    getSoundManager

    getTimeManager

    getTimeManager

    getVariables

    getVariables

    getVariablesForExtension

    getVariablesForExtension

    getViewportHeight

    • getViewportHeight(): number

    getViewportHeight

    • getViewportHeight(): number

    getViewportOriginX

    • getViewportOriginX(): number

    getViewportOriginX

    • getViewportOriginX(): number

    getViewportOriginY

    • getViewportOriginY(): number

    getViewportOriginY

    • getViewportOriginY(): number

    getViewportWidth

    • getViewportWidth(): number

    getViewportWidth

    • getViewportWidth(): number

    hasLayer

    • hasLayer(name: string): boolean

    hasLayer

    • hasLayer(name: string): boolean

    isObjectRegistered

    • isObjectRegistered(objectName: string): boolean

    Returns boolean

    isObjectRegistered

    • isObjectRegistered(objectName: string): boolean

    loadFromScene

    • loadFromScene(sceneAndExtensionsData: null | SceneAndExtensionsData): void

    loadFromScene

    • loadFromScene(sceneAndExtensionsData: null | SceneAndExtensionsData): void

    • Load the runtime scene from the given scene.

      see

      gdjs.RuntimeGame#getSceneAndExtensionsData

      -

      Parameters

      • sceneAndExtensionsData: null | SceneAndExtensionsData

      Returns void

    markObjectForDeletion

    markObjectForDeletion

    onChildrenLocationChanged

    • onChildrenLocationChanged(): void

    Returns void

    onChildrenLocationChanged

    • onChildrenLocationChanged(): void

    onGameResolutionResized

    • onGameResolutionResized(): void

    onGameResolutionResized

    • onGameResolutionResized(): void

    • Should be called when the canvas where the scene is rendered has been resized. See gdjs.RuntimeGame.startGameLoop in particular.

      -

      Returns void

    onPause

    • onPause(): void

    onPause

    • onPause(): void

    • Called when a scene is "paused", i.e it will be not be rendered again for some time, until it's resumed or unloaded.

      -

      Returns void

    onResume

    • onResume(): void

    onResume

    • onResume(): void

    registerObject

    • registerObject(objectData: ObjectData): void

    registerObject

    • registerObject(objectData: ObjectData): void

    removeLayer

    • removeLayer(layerName: string): void

    Returns void

    removeLayer

    • removeLayer(layerName: string): void

    render

    • render(): void

    Returns void

    render

    • render(): void

    renderAndStep

    • renderAndStep(elapsedTime: number): boolean

    renderAndStep

    • renderAndStep(elapsedTime: number): boolean

    • Step and render the scene.

      Parameters

      • elapsedTime: number

        In milliseconds

      Returns boolean

      true if the game loop should continue, false if a scene change/push/pop or a game stop was requested.

      -

    requestChange

    requestChange

    • Request a scene change to be made. The change is handled externally (see gdjs.SceneStack) thanks to getRequestedChange and getRequestedScene methods.

      Parameters

      • change: SceneChangeRequest

        One of RuntimeScene.CONTINUE|PUSH_SCENE|POP_SCENE|REPLACE_SCENE|CLEAR_SCENES|STOP_GAME.

      • Optional sceneName: string

        The name of the new scene to launch, if applicable.

        -

      Returns void

    sceneJustResumed

    • sceneJustResumed(): boolean

    Returns void

    sceneJustResumed

    • sceneJustResumed(): boolean

    • Check if the scene was just resumed. This is true during the first frame after the scene has been unpaused.

      Returns boolean

      true if the scene was just resumed

      -

    setBackgroundColor

    • setBackgroundColor(r: number, g: number, b: number): void

    setBackgroundColor

    • setBackgroundColor(r: number, g: number, b: number): void

    • Change the background color, by setting the RGB components. Internally, the color is stored as an hexadecimal number.

      Parameters

      • r: number
        @@ -196,62 +196,62 @@

        The color green component (0-255).

      • b: number

        The color blue component (0-255).

        -

      Returns void

    setClearCanvas

    • setClearCanvas(shouldClearCanvas: boolean): void

    Returns void

    setClearCanvas

    • setClearCanvas(shouldClearCanvas: boolean): void

    • Set whether the canvas should be cleared before this scene rendering. This is experimental: if possible, try to avoid relying on this and use custom objects to build complex scenes.

      -

      Parameters

      • shouldClearCanvas: boolean

      Returns void

    setEventsFunction

    • setEventsFunction(func: () => void): void

    setEventsFunction

    • setEventsFunction(func: () => void): void

    • Set the function called each time the scene is stepped. The function will be passed the runtimeScene as argument.

      Note that this is already set up by the gdjs.RuntimeScene constructor and that you should not need to use this method.

      Parameters

      • func: () => void

        The function to be called.

        -
          • (): void

          • Returns void

      Returns void

    setEventsGeneratedCodeFunction

    • setEventsGeneratedCodeFunction(sceneData: LayoutData): void

    Returns void

    setEventsGeneratedCodeFunction

    • setEventsGeneratedCodeFunction(sceneData: LayoutData): void

    • Set the function called each time the scene is stepped to be the events generated code, which is by convention assumed to be a function in gdjs with a name based on the scene mangled name.

      Parameters

      • sceneData: LayoutData

        The scene data, used to find where the code was generated.

        -

      Returns void

    setInitialSharedDataForBehavior

    • setInitialSharedDataForBehavior(name: string, sharedData: null | BehaviorSharedData): void

    Returns void

    setInitialSharedDataForBehavior

    • setInitialSharedDataForBehavior(name: string, sharedData: null | BehaviorSharedData): void

    setLayerIndex

    • setLayerIndex(layerName: string, newIndex: number): void

    Returns void

    setLayerIndex

    • setLayerIndex(layerName: string, newIndex: number): void

    startProfiler

    • startProfiler(onProfilerStopped: (oldProfiler: Profiler) => void): void

    Returns void

    startProfiler

    • startProfiler(onProfilerStopped: (oldProfiler: Profiler) => void): void

    • Start a new profiler to measures the time passed in sections of the engine in the scene.

      Parameters

      • onProfilerStopped: (oldProfiler: Profiler) => void

        Function to be called when the profiler is stopped. Will be passed the profiler as argument.

        -

      Returns void

    stopProfiler

    • stopProfiler(): void

    Returns void

    stopProfiler

    • stopProfiler(): void

    unloadScene

    • unloadScene(): void

    unloadScene

    • unloadScene(): void

    unregisterObject

    • unregisterObject(objectName: string): void

    unregisterObject

    • unregisterObject(objectName: string): void

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(syncData: LayoutNetworkSyncData): void

    updateObject

    • updateObject(objectData: ObjectData): void

    Returns void

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(syncData: LayoutNetworkSyncData): void

    updateObject

    • updateObject(objectData: ObjectData): void

    updateObjectsForces

    • updateObjectsForces(): void

    Returns void

    updateObjectsForces

    • updateObjectsForces(): void

    Constructors

    constructor

    Constructors

    constructor

    Properties

    networkId

    networkId: null | string = null
    +

    Returns RuntimeScene

    Properties

    networkId

    networkId: null | string = null

    A network ID associated to the scene to be used for multiplayer, to identify the scene across peers. A scene can have its networkId re-generated during the game, meaning that the scene is re-created on every peer.

    -

    pathfindingObstaclesManager

    pathfindingObstaclesManager: PathfindingObstaclesManager

    physics2SharedData

    physics2SharedData: null | Physics2SharedData

    tileMapCollisionMaskManager

    tileMapCollisionMaskManager: TileMapRuntimeManager

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class RuntimeScenePixiRenderer

    The renderer for a gdjs.RuntimeScene using Pixi.js.

    -

    Hierarchy

    • RuntimeScenePixiRenderer

    Implements

    Index

    Constructors

    Methods

    Constructors

    constructor

    Methods

    get3DRendererObject

    • get3DRendererObject(): null

    getPIXIContainer

    • getPIXIContainer(): Container<DisplayObject>

    getPIXIRenderer

    • getPIXIRenderer(): null | Renderer

    getRendererObject

    • getRendererObject(): Container<DisplayObject>

    hideCursor

    • hideCursor(): void

    onGameResolutionResized

    • onGameResolutionResized(): void

    onSceneUnloaded

    • onSceneUnloaded(): void

    render

    • render(): void

    renderForVR

    • renderForVR(): void

    Hierarchy

    • RuntimeScenePixiRenderer

    Implements

    Index

    Constructors

    Methods

    Constructors

    constructor

    Methods

    get3DRendererObject

    • get3DRendererObject(): null

    getPIXIContainer

    • getPIXIContainer(): Container<DisplayObject>

    getPIXIRenderer

    • getPIXIRenderer(): null | Renderer

    getRendererObject

    • getRendererObject(): Container<DisplayObject>

    hideCursor

    • hideCursor(): void

    onGameResolutionResized

    • onGameResolutionResized(): void

    onSceneUnloaded

    • onSceneUnloaded(): void

    render

    • render(): void

    renderForVR

    • renderForVR(): void

    • Unless you know what you are doing, use the VR extension instead of this function directly.

      In VR, only 3D elements can be rendered, 2D cannot. This rendering method skips over all 2D layers and elements, and simply renders the 3D content. @@ -21,9 +21,9 @@

      Note to engine developers: threeRenderer.resetState() may NOT be called in this function, as WebXR modifies the WebGL state in a way that resetting it will cause an improper render that will lead to a black screen being displayed in VR mode.

      -

      Returns void

    setLayerIndex

    setLayerIndex

    showCursor

    • showCursor(): void

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ScalableBehavior

    A behavior that forwards the Scalable interface to its object.

    -

    Hierarchy

    Implements

    Index

    Methods

    Constructors

    Properties

    Methods

    activate

    • activate(enable: boolean): void

    Hierarchy

    Implements

    Index

    Methods

    Constructors

    Properties

    Methods

    activate

    • activate(enable: boolean): void

    activated

    • activated(): boolean

    Returns void

    activated

    • activated(): boolean

    doStepPostEvents

    doStepPostEvents

    doStepPreEvents

    doStepPreEvents

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getName

    • getName(): string

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    getScale

    • getScale(): number

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    getScale

    • getScale(): number

    getScaleX

    • getScaleX(): number

    getScaleX

    • getScaleX(): number

    getScaleY

    • getScaleY(): number

    getScaleY

    • getScaleY(): number

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    onDeActivate

    • onDeActivate(): void

    onDeActivate

    • onDeActivate(): void

    onDestroy

    • onDestroy(): 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

    onObjectHotReloaded

    • onObjectHotReloaded(): void

    setScale

    • setScale(newScale: number): void

    setScale

    • setScale(newScale: number): void

    setScaleX

    • setScaleX(newScale: number): void

    setScaleX

    • setScaleX(newScale: number): void

    setScaleY

    • setScaleY(newScale: number): void

    setScaleY

    • setScaleY(newScale: number): void

    stepPostEvents

    stepPostEvents

    stepPreEvents

    Returns void

    stepPreEvents

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    Returns void

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    Returns void

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    Constructors

    constructor

    Properties

    name

    name: string

    owner

    owner: RuntimeObject

    type

    type: string

    Private object

    object: RuntimeObject & Scalable

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class SceneStack

    Hold the stack of scenes (gdjs.RuntimeScene) being played.

    -

    Hierarchy

    • SceneStack

    Index

    Methods

    Constructors

    Methods

    applyUpdateFromNetworkSyncDataIfAny

    • applyUpdateFromNetworkSyncDataIfAny(): void

    getCurrentScene

    Hierarchy

    • SceneStack

    Index

    Methods

    Constructors

    Methods

    applyUpdateFromNetworkSyncDataIfAny

    • applyUpdateFromNetworkSyncDataIfAny(): void

    getCurrentScene

    getNetworkSyncData

    • getNetworkSyncData(syncOptions: GetNetworkSyncDataOptions): null | SceneStackNetworkSyncData

    onGameResolutionResized

    • onGameResolutionResized(): void

    getNetworkSyncData

    • getNetworkSyncData(syncOptions: GetNetworkSyncDataOptions): null | SceneStackNetworkSyncData

    onGameResolutionResized

    • onGameResolutionResized(): void

    • Called by the RuntimeGame when the game resolution is changed. Useful to notify scene and layers that resolution is changed, as they might be caching it.

      -

      Returns void

    pop

    • pop(popCount?: number): void

    push

    • push(newSceneName: string, externalLayoutName?: string): null | RuntimeScene

    pop

    • pop(popCount?: number): void

    push

    • push(newSceneName: string, externalLayoutName?: string): null | RuntimeScene

    • Pause the scene currently being played and start the new scene that is specified. If externalLayoutName is set, also instantiate the objects from this external layout.

      -

      Parameters

      • newSceneName: string
      • Optional externalLayoutName: string

      Returns null | RuntimeScene

    renderWithoutStep

    • renderWithoutStep(): boolean

    replace

    • replace(newSceneName: string, clear?: boolean): null | RuntimeScene

    renderWithoutStep

    • renderWithoutStep(): boolean

    replace

    • replace(newSceneName: string, clear?: boolean): null | RuntimeScene

    • Start the specified scene, replacing the one currently being played. If clear is set to true, all running scenes are also removed from the stack of scenes.

      -

      Parameters

      • newSceneName: string
      • Optional clear: boolean

      Returns null | RuntimeScene

    step

    • step(elapsedTime: number): boolean

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(sceneStackSyncData: SceneStackNetworkSyncData): void

    wasFirstSceneLoaded

    • wasFirstSceneLoaded(): boolean

    step

    • step(elapsedTime: number): boolean

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(sceneStackSyncData: SceneStackNetworkSyncData): void

    wasFirstSceneLoaded

    • wasFirstSceneLoaded(): boolean

    Constructors

    constructor

    Constructors

    constructor

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class ShapePainterRuntimeObject

    The ShapePainterRuntimeObject allows to draw graphics shapes on screen.

    -

    Hierarchy

    Implements

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    Hierarchy

    Implements

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    addEffect

    • addEffect(effectData: EffectData): boolean

    Returns void

    addEffect

    • addEffect(effectData: EffectData): boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    Returns boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    • Add a force to the object to move it.

      Parameters

      • x: number

        The x coordinates of the force

        @@ -18,7 +18,7 @@

        The y coordinates of the force

      • multiplier: number

        Set the force multiplier

        -

      Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    Returns void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    Returns void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    • Create the behavior described by the given BehaviorData

      Parameters

      • behaviorData: BehaviorData

        The data to be used to construct the behavior.

      Returns boolean

      true if the behavior was properly created, false otherwise.

      -

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    areCoordinatesRelative

    • areCoordinatesRelative(): boolean

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns void

    areCoordinatesRelative

    • areCoordinatesRelative(): boolean

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns boolean

    true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

    -

    beginFillPath

    • beginFillPath(x1: number, y1: number): void

    behaviorActivated

    • behaviorActivated(name: string): boolean

    beginFillPath

    • beginFillPath(x1: number, y1: number): void

    behaviorActivated

    • behaviorActivated(name: string): boolean

    checkAntialiasing

    clear

    • clear(): void

    checkAntialiasing

    clear

    • clear(): void

    clearEffects

    • clearEffects(): boolean

    clearEffects

    • clearEffects(): boolean

    clearForces

    • clearForces(): void

    clearForces

    • clearForces(): void

    closePath

    • closePath(): void

    Static collisionTest

    closePath

    • closePath(): void

    Static collisionTest

    • Return true if the hitboxes of two objects are overlapping

      static

      Parameters

      • obj1: RuntimeObject

        The first runtimeObject

        @@ -80,70 +80,70 @@
      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if obj1 and obj2 are in collision

      -

    cursorOnObject

    cursorOnObject

    deleteFromScene

    deleteFromScene

    Static distanceTest

    Returns void

    Static distanceTest

    drawArc

    • drawArc(centerX: number, centerY: number, radius: number, startAngle: number, endAngle: number, anticlockwise: boolean, closePath: boolean): void

    drawBezierCurve

    • drawBezierCurve(x1: number, y1: number, cpX: number, cpY: number, cpX2: number, cpY2: number, x2: number, y2: number): void

    drawChamferRectangle

    • drawChamferRectangle(startX1: number, startY1: number, endX2: number, endY2: number, chamfer: number): void

    drawCircle

    • drawCircle(x: number, y: number, radius: number): void

    drawEllipse

    • drawEllipse(centerX: number, centerY: number, width: number, height: number): void

    drawFilletRectangle

    • drawFilletRectangle(startX1: number, startY1: number, endX2: number, endY2: number, fillet: number): void

    drawLine

    • drawLine(x1: number, y1: number, x2: number, y2: number, thickness: number): void

    drawLineV2

    • drawLineV2(x1: number, y1: number, x2: number, y2: number, thickness: number): void

    drawPathArc

    • drawPathArc(cx: number, cy: number, radius: number, startAngle: number, endAngle: number, anticlockwise: boolean): void

    drawPathBezierCurveTo

    • drawPathBezierCurveTo(cpX: number, cpY: number, cpX2: number, cpY2: number, toX: number, toY: number): void

    drawPathLineTo

    • drawPathLineTo(x1: number, y1: number): void

    drawPathMoveTo

    • drawPathMoveTo(x1: number, y1: number): void

    drawPathQuadraticCurveTo

    • drawPathQuadraticCurveTo(cpX: number, cpY: number, toX: number, toY: number): void

    drawQuadraticCurve

    • drawQuadraticCurve(x1: number, y1: number, cpX: number, cpY: number, x2: number, y2: number): void

    drawRectangle

    • drawRectangle(x1: number, y1: number, x2: number, y2: number): void

    drawRegularPolygon

    • drawRegularPolygon(centerX: number, centerY: number, sides: number, radius: number, rotation: number): void

    drawRoundedRectangle

    • drawRoundedRectangle(startX1: number, startY1: number, endX2: number, endY2: number, radius: number): void

    drawStar

    • drawStar(centerX: number, centerY: number, points: number, radius: number, innerRadius: number, rotation: number): void

    drawTorus

    • drawTorus(centerX: number, centerY: number, innerRadius: number, outerRadius: number, startArc: number, endArc: number): void

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    drawArc

    • drawArc(centerX: number, centerY: number, radius: number, startAngle: number, endAngle: number, anticlockwise: boolean, closePath: boolean): void

    drawBezierCurve

    • drawBezierCurve(x1: number, y1: number, cpX: number, cpY: number, cpX2: number, cpY2: number, x2: number, y2: number): void

    drawChamferRectangle

    • drawChamferRectangle(startX1: number, startY1: number, endX2: number, endY2: number, chamfer: number): void

    drawCircle

    • drawCircle(x: number, y: number, radius: number): void

    drawEllipse

    • drawEllipse(centerX: number, centerY: number, width: number, height: number): void

    drawFilletRectangle

    • drawFilletRectangle(startX1: number, startY1: number, endX2: number, endY2: number, fillet: number): void

    drawLine

    • drawLine(x1: number, y1: number, x2: number, y2: number, thickness: number): void

    drawLineV2

    • drawLineV2(x1: number, y1: number, x2: number, y2: number, thickness: number): void

    drawPathArc

    • drawPathArc(cx: number, cy: number, radius: number, startAngle: number, endAngle: number, anticlockwise: boolean): void

    drawPathBezierCurveTo

    • drawPathBezierCurveTo(cpX: number, cpY: number, cpX2: number, cpY2: number, toX: number, toY: number): void

    drawPathLineTo

    • drawPathLineTo(x1: number, y1: number): void

    drawPathMoveTo

    • drawPathMoveTo(x1: number, y1: number): void

    drawPathQuadraticCurveTo

    • drawPathQuadraticCurveTo(cpX: number, cpY: number, toX: number, toY: number): void

    drawQuadraticCurve

    • drawQuadraticCurve(x1: number, y1: number, cpX: number, cpY: number, x2: number, y2: number): void

    drawRectangle

    • drawRectangle(x1: number, y1: number, x2: number, y2: number): void

    drawRegularPolygon

    • drawRegularPolygon(centerX: number, centerY: number, sides: number, radius: number, rotation: number): void

    drawRoundedRectangle

    • drawRoundedRectangle(startX1: number, startY1: number, endX2: number, endY2: number, radius: number): void

    drawStar

    • drawStar(centerX: number, centerY: number, points: number, radius: number, innerRadius: number, rotation: number): void

    drawTorus

    • drawTorus(centerX: number, centerY: number, innerRadius: number, outerRadius: number, startArc: number, endArc: number): void

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    endFillPath

    • endFillPath(): void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    Returns void

    endFillPath

    • endFillPath(): void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    flipX

    • flipX(enable: boolean): void

    flipY

    • flipY(enable: boolean): void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    Returns void

    flipX

    • flipX(enable: boolean): void

    flipY

    • flipY(enable: boolean): void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    • Get the AABB (axis aligned bounding box) for the object.

      The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

      You should probably redefine updateAABB instead of this function.

      Returns AABB

      The bounding box

      -

    getAABBBottom

    • getAABBBottom(): number

    getAABBBottom

    • getAABBBottom(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBRight

    • getAABBRight(): number

    getAABBRight

    • getAABBRight(): number

    getAABBTop

    • getAABBTop(): number

    getAABBTop

    • getAABBTop(): number

    getAngle

    • getAngle(): number

    getAngle

    • getAngle(): number

    getAngleToObject

    getAngleToObject

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    Returns number

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    getAntialiasing

    getAverageForce

    Returns number

    getAntialiasing

    getAverageForce

    getBehavior

    getBehavior

    • Get a behavior from its name. If the behavior does not exists, undefined is returned.

      Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -151,60 +151,60 @@

      Parameters

      • name: string

        The behavior name.

      Returns null | RuntimeBehavior

      The behavior with the given name, or undefined.

      -

    getCenterX

    • getCenterX(): number

    getCenterX

    • getCenterX(): number

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterY

    • getCenterY(): number

    getCenterY

    • getCenterY(): number

    getCenterYInScene

    • getCenterYInScene(): number

    getCenterYInScene

    • getCenterYInScene(): number

    getDistanceToObject

    getDistanceToObject

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    getDrawableX

    • getDrawableX(): number

    Returns number

    getDrawableX

    • getDrawableX(): number

    getDrawableY

    • getDrawableY(): number

    getDrawableY

    • getDrawableY(): number

    getElapsedTime

    getElapsedTime

    getFillColorB

    • getFillColorB(): number

    getFillColorG

    • getFillColorG(): number

    getFillColorR

    • getFillColorR(): number

    getFillOpacity

    • getFillOpacity(): number

    getHeight

    • getHeight(): number

    Returns number

    getFillColorB

    • getFillColorB(): number

    getFillColorG

    • getFillColorG(): number

    getFillColorR

    • getFillColorR(): number

    getFillOpacity

    • getFillOpacity(): number

    getHeight

    • getHeight(): number

    getHitBoxes

    getHitBoxes

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    • Return at least all the hit boxes that overlap a given area.

      The hit boxes don't need to actually overlap the area, (i.e: it's correct to return more hit boxes than those in the specified area) @@ -229,181 +229,181 @@

    • bottom: number

      bound of the area in scene coordinates

    Returns Iterable<Polygon>

    at least all the hit boxes that overlap a given area.

    -

    getInstanceContainer

    getInstanceContainer

    getLayer

    • getLayer(): string

    getLayer

    • getLayer(): string

    getName

    • getName(): string

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    • Get the identifier associated to an object name. Some features may want to compare objects name a large number of time. In this case, it may be more efficient to compare objects name identifiers.

      -
      static

      Parameters

      • name: string

      Returns number

    getNetworkSyncData

    • getNetworkSyncData(): ObjectNetworkSyncData

    getNetworkSyncData

    • getNetworkSyncData(): ObjectNetworkSyncData

    getOutlineColorB

    • getOutlineColorB(): number

    getOutlineColorG

    • getOutlineColorG(): number

    getOutlineColorR

    • getOutlineColorR(): number

    getOutlineOpacity

    • getOutlineOpacity(): number

    getOutlineSize

    • getOutlineSize(): number

    getParent

    getOutlineColorB

    • getOutlineColorB(): number

    getOutlineColorG

    • getOutlineColorG(): number

    getOutlineColorR

    • getOutlineColorR(): number

    getOutlineOpacity

    • getOutlineOpacity(): number

    getOutlineSize

    • getOutlineSize(): number

    getParent

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererObject

    • getRendererObject(): Graphics

    getRotationCenterX

    • getRotationCenterX(): number

    getRendererObject

    • getRendererObject(): Graphics

    getRotationCenterX

    • getRotationCenterX(): number

    getRotationCenterY

    • getRotationCenterY(): number

    getRotationCenterY

    • getRotationCenterY(): number

    getRuntimeScene

    getRuntimeScene

    getScale

    • getScale(): number

    getScale

    • getScale(): number

    getScaleX

    • getScaleX(): number

    getScaleX

    • getScaleX(): number

    getScaleY

    • getScaleY(): number

    getScaleY

    • getScaleY(): number

    getSqDistanceToObject

    getSqDistanceToObject

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    Returns number

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    • Get a timer elapsed time.

      This is used by expressions to return 0 when a timer doesn't exist because numeric expressions must always return a number.

      Parameters

      • timerName: string

        The timer name.

      Returns number

      The timer elapsed time in seconds, 0 if the timer doesn't exist.

      -

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getUniqueId

    • getUniqueId(): number

    getUniqueId

    • getUniqueId(): number

    • Get the unique identifier of the object.
      The identifier is set by the runtimeScene owning the object.
      You can also use the id property (this._object.id) for increased efficiency instead of calling this method.

      Returns number

      The object identifier

      -

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableString

    • getVariableString(variable: Variable): string

    Static getVariableString

    • getVariableString(variable: Variable): string

    getVariables

    getVariables

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    • Get the AABB (axis aligned bounding box) to be used to determine if the object is visible on screen. The gdjs.RuntimeScene will hide the renderer object if the object is not visible on screen ("culling").

      The default implementation uses the AABB returned by getAABB.

      If null is returned, the object is assumed to be always visible.

      Returns null | AABB

      The bounding box or null.

      -

    getWidth

    • getWidth(): number

    getWidth

    • getWidth(): number

    getX

    • getX(): number

    getX

    • getX(): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    • Compute the X position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getY

    • getY(): number

    Returns number

    getY

    • getY(): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    • Compute the Y position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getZOrder

    • getZOrder(): number

    Returns number

    getZOrder

    • getZOrder(): number

    hasBehavior

    • hasBehavior(name: string): boolean

    hasBehavior

    • hasBehavior(name: string): boolean

    hasEffect

    • hasEffect(name: string): boolean

    Returns boolean

    hasEffect

    • hasEffect(name: string): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hide

    • hide(enable: boolean): void

    hide

    • hide(enable: boolean): void

    insideObject

    • insideObject(x: number, y: number): boolean

    Returns void

    insideObject

    • insideObject(x: number, y: number): boolean

    • Return true if the specified position is inside object bounding box.

      The position should be in "world" coordinates, i.e use gdjs.Layer.convertCoords if you need to pass the mouse or a touch position that you get from gdjs.InputManager. To check if a point is inside the object collision mask, you can use isCollidingWithPoint instead.

      -

      Parameters

      • x: number
      • y: number

      Returns boolean

    invalidateBounds

    • invalidateBounds(): void

    invalidateHitboxes

    • invalidateHitboxes(): void

    invalidateBounds

    • invalidateBounds(): void

    invalidateHitboxes

    • invalidateHitboxes(): void

    isClearedBetweenFrames

    • isClearedBetweenFrames(): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isClearedBetweenFrames

    • isClearedBetweenFrames(): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isFlippedX

    • isFlippedX(): boolean

    isFlippedY

    • isFlippedY(): boolean

    isHidden

    • isHidden(): boolean

    isFlippedX

    • isFlippedX(): boolean

    isFlippedY

    • isFlippedY(): boolean

    isHidden

    • isHidden(): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    • Return true if the angle of the total force applied on the object is in a given range.

      Parameters

      • angle: number
        @@ -412,43 +412,43 @@

        The maximum distance from the given angle.

      Returns boolean

      true if the difference between the force angle the given angle is less or equals the toleranceInDegrees.

      -

    isVisible

    • isVisible(): boolean

    isVisible

    • isVisible(): boolean

    • Return true if the object is not hidden.

      Note: This is unrelated to the actual visibility of the object on the screen. For this, see getVisibilityAABB to get the bounding boxes of the object as displayed on the scene.

      Returns boolean

      true if the object is not hidden.

      -

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    • To be called by the child classes in their constructor, at the very end. Notify the behaviors that they have been constructed (this must be done when the object is ready, otherwise behaviors can do operations on the object which could be not initialized yet).

      If you redefine this function, make sure to call the original method (RuntimeObject.prototype.onCreated.call(this);).

      -

      Returns void

    onDeletedFromScene

    onDeletedFromScene

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    Returns void

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    onSceneResumed

    Returns void

    onSceneResumed

    pauseTimer

    • pauseTimer(timerName: string): void

    Returns void

    pauseTimer

    • pauseTimer(timerName: string): void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    Returns void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    • Put the object around a position, with a specific distance and angle. The distance and angle are computed between the position and the center of the object.

      Parameters

      • x: number
        @@ -459,7 +459,7 @@

        The distance between the object and the target, in pixels.

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    • Put the object around another object, with a specific distance and angle. The distance and angle are computed between the centers of the objects.

      Parameters

      • obj: null | RuntimeObject
        @@ -468,7 +468,7 @@

        The distance between the object and the target

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    • Called to reset the object to its default state. This is used for objects that are "recycled": they are dismissed (at which point onDestroyFromScene is called) but still stored in a cache to be reused next time an object must be created. At this point, @@ -494,7 +494,7 @@

    • The _runtimeScene, _nameId, name and type are guaranteed to stay the same and do not need to be set again.
    -

    Parameters

    Returns void

    removeBehavior

    removeBehavior

    removeEffect

    removeEffect

    removeTimer

    Returns boolean

    removeTimer

    resetTimer

    Returns void

    resetTimer

    Static returnVariable

    Returns void

    Static returnVariable

    rotate

    rotate

    rotateTowardAngle

    rotateTowardAngle

    rotateTowardPosition

    separateFromObjects

    Returns void

    rotateTowardPosition

    separateFromObjects

    separateFromObjectsList

    separateFromObjectsList

    separateObjectsWithForces

    separateObjectsWithForces

    separateObjectsWithoutForces

    separateObjectsWithoutForces

    setAngle

    Returns void

    setAngle

    setAntialiasing

    setCenterPositionInScene

    setAntialiasing

    setCenterPositionInScene

    setCenterXInScene

    Returns void

    setCenterXInScene

    setCenterYInScene

    Returns void

    setCenterYInScene

    setClearBetweenFrames

    setCoordinatesRelative

    setEffectBooleanParameter

    setClearBetweenFrames

    setCoordinatesRelative

    setEffectBooleanParameter

    setEffectDoubleParameter

    Returns boolean

    setEffectDoubleParameter

    setEffectStringParameter

    Returns boolean

    setEffectStringParameter

    setFillColor

    setFillColor

    setFillOpacity

    setFillOpacity

    setHeight

    Returns void

    setHeight

    setIncludedInParentCollisionMask

    setLayer

    setIncludedInParentCollisionMask

    setLayer

    setOutlineColor

    setOutlineColor

    setOutlineOpacity

    setOutlineOpacity

    setOutlineSize

    setPosition

    Returns void

    setOutlineSize

    setPosition

    setRectangularCollisionMask

    setRotationCenter

    Returns void

    setRectangularCollisionMask

    setRotationCenter

    Returns void

    setScale

    Returns void

    setScale

    setScaleX

    Returns void

    setScaleX

    setScaleY

    Returns void

    setScaleY

    setSize

    Returns void

    setSize

    Static setVariableNumber

    Static setVariableNumber

    Static setVariableString

    Returns void

    Static setVariableString

    setWidth

    Returns void

    setWidth

    setX

    setX

    setY

    setY

    setZOrder

    setZOrder

    stepBehaviorsPostEvents

    Returns void

    stepBehaviorsPostEvents

    stepBehaviorsPreEvents

    stepBehaviorsPreEvents

    timerElapsedTime

    timerElapsedTime

    timerPaused

    timerPaused

    transformToDrawing

    transformToDrawingX

    transformToDrawingY

    transformToScene

    transformToSceneX

    transformToSceneY

    unpauseTimer

    transformToDrawing

    transformToDrawingX

    transformToDrawingY

    transformToScene

    transformToSceneX

    transformToSceneY

    unpauseTimer

    unregisterDestroyCallback

    update

    Returns void

    unregisterDestroyCallback

    update

    updateAABB

    Returns void

    updateAABB

    updateAllEffectParameters

    updateAllEffectParameters

    updateForces

    Returns boolean

    updateForces

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    updateFromObjectData

    updateFromObjectData

    updateHitBoxes

    updateHitBoxes

    updatePreRender

    updatePreRender

    updateTimers

    updateTimers

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []
    +

    Returns void

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []

    Global container for unused forces, avoiding recreating forces each tick.

    -
    static

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number
      • +

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number

      • Get the squared distance, in pixels, between the center of this object and a position.

        Parameters

        • targetX: number

          Target X position

        • targetY: number

          Target Y position

          -

        Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • +

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • Get the number of children from a variable

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The number of children

        -

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

      • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The value of the specified variable

        -

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

      • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns string

        The string of the specified variable

        -

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null
    +

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null

    A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

    -

    persistentUuid

    persistentUuid: null | string = null
    +

    persistentUuid

    persistentUuid: null | string = null

    An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

    -

    pick

    pick: boolean = false
    +

    pick

    pick: boolean = false

    A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

    -

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

      • Return the variable passed as argument without any change. Only for usage by events.

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns Variable

        The specified variable

        -

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void
      • +

      Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void

      • Shortcut to set the value of a variable considered as a number

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: number

          The value to be set

          -

        Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void
      • +

      Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void

      • Shortcut to set the value of a variable considered as a string

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: string

          The value to be set

          -

        Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • +

      Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable
          +

          Parameters

          • array: Variable
          • value: string | number | boolean

          Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable

          The variable to be tested

        • childName: string

          The name of the child

          -

        Returns boolean

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

      • static

        Parameters

        • variable: Variable

          The variable to be cleared

          -

        Returns void

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

        • variable: Variable

          The variable to be changed

        • childName: string

          The name of the child

          -

        Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • +

      Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Constructors

    constructor

    Constructors

    constructor

    • Parameters

      • instanceContainer: RuntimeInstanceContainer

        The container the object belongs to.

      • shapePainterObjectData: ShapePainterObjectData

        The initial properties of the object

        diff --git a/GDJS Runtime Documentation/classes/gdjs.ShopifyClientsManager.html b/GDJS Runtime Documentation/classes/gdjs.ShopifyClientsManager.html index 80520d6b0..8cf4ae8fb 100644 --- a/GDJS Runtime Documentation/classes/gdjs.ShopifyClientsManager.html +++ b/GDJS Runtime Documentation/classes/gdjs.ShopifyClientsManager.html @@ -1,4 +1,4 @@ -ShopifyClientsManager | GDevelop JavaScript game engine
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class ShopifyClientsManager

        Hierarchy

        • ShopifyClientsManager

        Index

        Constructors

        Methods

        Constructors

        constructor

        Methods

        Static get

        Static set

        Legend

        • Constructor
        • Static method

        Settings

        Theme

        Generated using TypeDoc

        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class ShopifyClientsManager

        Hierarchy

        • ShopifyClientsManager

        Index

        Constructors

        Methods

        Constructors

        constructor

        Methods

        Static get

        Static set

        Legend

        • Constructor
        • Static method

        Settings

        Theme

        Generated using TypeDoc

        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class SpineManager

        SpineManager manages pixi spine skeleton data.

        -

        Hierarchy

        • SpineManager

        Implements

        Index

        Constructors

        Methods

        Constructors

        constructor

        Methods

        getResourceKinds

        • getResourceKinds(): ResourceKind[]

        Hierarchy

        • SpineManager

        Implements

        Index

        Constructors

        Methods

        Constructors

        constructor

        Methods

        getResourceKinds

        • getResourceKinds(): ResourceKind[]

        getSpine

        • getSpine(resourceName: string): null | ISkeletonData<IBoneData, ISlotData, ISkin, IAnimation<ITimeline>, IEventData, IIkConstraintData, ITransformConstraintData, IPathConstraintData>

        getSpine

        • getSpine(resourceName: string): null | ISkeletonData<IBoneData, ISlotData, ISkin, IAnimation<ITimeline>, IEventData, IIkConstraintData, ITransformConstraintData, IPathConstraintData>

        • Get the object for the given resource that is already loaded (preloaded or loaded with loadJson). If the resource is not loaded, null will be returned.

          Parameters

          • resourceName: string

            The name of the spine skeleton.

          Returns null | ISkeletonData<IBoneData, ISlotData, ISkin, IAnimation<ITimeline>, IEventData, IIkConstraintData, ITransformConstraintData, IPathConstraintData>

          the spine skeleton if loaded, null otherwise.

          -

        isSpineLoaded

        • isSpineLoaded(resourceName: string): boolean

        isSpineLoaded

        • isSpineLoaded(resourceName: string): boolean

        • Check if the given spine skeleton was loaded.

          Parameters

          • resourceName: string

            The name of the spine skeleton.

          Returns boolean

          true if the content of the spine skeleton is loaded, false otherwise.

          -

        loadResource

        • loadResource(resourceName: string): Promise<void>

        loadResource

        • loadResource(resourceName: string): Promise<void>

        processResource

        • processResource(resourceName: string): Promise<void>

        processResource

        • processResource(resourceName: string): Promise<void>

        addForce

        • addForce(x: number, y: number, multiplier: number): void

        • Add a force to the object to move it.

          Parameters

          • x: number

            The x coordinates of the force

            @@ -16,7 +16,7 @@

            The y coordinates of the force

          • multiplier: number

            Set the force multiplier

            -

          Returns void

        addForceTowardObject

        • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

        Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    Returns void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    Returns void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    • Create the behavior described by the given BehaviorData

      Parameters

      • behaviorData: BehaviorData

        The data to be used to construct the behavior.

      Returns boolean

      true if the behavior was properly created, false otherwise.

      -

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns boolean

    true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

    -

    behaviorActivated

    • behaviorActivated(name: string): boolean

    behaviorActivated

    • behaviorActivated(name: string): boolean

    clearEffects

    • clearEffects(): boolean

    clearEffects

    • clearEffects(): boolean

    clearForces

    • clearForces(): void

    clearForces

    • clearForces(): void

    Static collisionTest

    Static collisionTest

    • Return true if the hitboxes of two objects are overlapping

      static

      Parameters

      • obj1: RuntimeObject

        The first runtimeObject

        @@ -76,78 +76,78 @@
      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if obj1 and obj2 are in collision

      -

    cursorOnObject

    cursorOnObject

    deleteFromScene

    deleteFromScene

    Static distanceTest

    Returns void

    Static distanceTest

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    Returns void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    flipX

    • flipX(enable: boolean): void

    flipY

    • flipY(enable: boolean): void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    flipX

    • flipX(enable: boolean): void

    flipY

    • flipY(enable: boolean): void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    • Get the AABB (axis aligned bounding box) for the object.

      The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

      You should probably redefine updateAABB instead of this function.

      Returns AABB

      The bounding box

      -

    getAABBBottom

    • getAABBBottom(): number

    getAABBBottom

    • getAABBBottom(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBRight

    • getAABBRight(): number

    getAABBRight

    • getAABBRight(): number

    getAABBTop

    • getAABBTop(): number

    getAABBTop

    • getAABBTop(): number

    getAngle

    • getAngle(): number

    getAngle

    • getAngle(): number

    getAngleToObject

    getAngleToObject

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    Returns number

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    getAnimationDuration

    • getAnimationDuration(): number

    getAnimationElapsedTime

    • getAnimationElapsedTime(): number

    getAnimationIndex

    • getAnimationIndex(): number

    Returns number

    getAnimationDuration

    • getAnimationDuration(): number

    getAnimationElapsedTime

    • getAnimationElapsedTime(): number

    getAnimationIndex

    • getAnimationIndex(): number

    getAnimationIndexFor

    • getAnimationIndexFor(animationName: string): number

    getAnimationMixingDuration

    • getAnimationMixingDuration(): number

    getAnimationIndexFor

    • getAnimationIndexFor(animationName: string): number

    getAnimationMixingDuration

    • getAnimationMixingDuration(): number

    getAnimationName

    • getAnimationName(): string

    getAnimationName

    • getAnimationName(): string

    getAnimationSpeedScale

    • getAnimationSpeedScale(): number

    getAverageForce

    getAnimationSpeedScale

    • getAnimationSpeedScale(): number

    getAverageForce

    getBehavior

    getBehavior

    • Get a behavior from its name. If the behavior does not exists, undefined is returned.

      Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -155,59 +155,59 @@

      Parameters

      • name: string

        The behavior name.

      Returns null | RuntimeBehavior

      The behavior with the given name, or undefined.

      -

    getCenterX

    • getCenterX(): number

    getCenterX

    • getCenterX(): number

    • Return the X position of the object center, relative to the object X position (getDrawableX). Use getCenterXInScene to get the position of the center in the scene.

      Returns number

      the X position of the object center, relative to getDrawableX().

      -

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterY

    • getCenterY(): number

    getCenterY

    • getCenterY(): number

    • Return the Y position of the object center, relative to the object position (getDrawableY). Use getCenterYInScene to get the position of the center in the scene.

      Returns number

      the Y position of the object center, relative to getDrawableY().

      -

    getCenterYInScene

    • getCenterYInScene(): number

    getCenterYInScene

    • getCenterYInScene(): number

    getDistanceToObject

    getDistanceToObject

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    getDrawableX

    • getDrawableX(): number

    Returns number

    getDrawableX

    • getDrawableX(): number

    • Get the X position of the rendered object.

      For most objects, this will returns the same value as getX(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableX will differ.

      Returns number

      The X position of the rendered object.

      -

    getDrawableY

    • getDrawableY(): number

    getDrawableY

    • getDrawableY(): number

    • Get the Y position of the rendered object.

      For most objects, this will returns the same value as getY(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableY will differ.

      Returns number

      The Y position of the rendered object.

      -

    getElapsedTime

    getElapsedTime

    getHeight

    • getHeight(): number

    Returns number

    getHeight

    • getHeight(): number

    getHitBoxes

    getHitBoxes

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    • Return at least all the hit boxes that overlap a given area.

      The hit boxes don't need to actually overlap the area, (i.e: it's correct to return more hit boxes than those in the specified area) @@ -232,128 +232,128 @@

    • bottom: number

      bound of the area in scene coordinates

    Returns Iterable<Polygon>

    at least all the hit boxes that overlap a given area.

    -

    getInstanceContainer

    getInstanceContainer

    getLayer

    • getLayer(): string

    getLayer

    • getLayer(): string

    getName

    • getName(): string

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    • Get the identifier associated to an object name. Some features may want to compare objects name a large number of time. In this case, it may be more efficient to compare objects name identifiers.

      -
      static

      Parameters

      • name: string

      Returns number

    getNetworkSyncData

    getNetworkSyncData

    getOpacity

    • getOpacity(): number

    getOpacity

    • getOpacity(): number

    getParent

    getParent

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererObject

    • getRendererObject(): Container<DisplayObject> | Spine

    getRuntimeScene

    getRendererObject

    • getRendererObject(): Container<DisplayObject> | Spine

    getRuntimeScene

    getScale

    • getScale(): number

    getScale

    • getScale(): number

    • Get the scale of the object (or the geometric mean of the X and Y scale in case they are different).

      Returns number

      the scale of the object (or the geometric mean of the X and Y scale in case they are different).

      -

    getScaleX

    • getScaleX(): number

    getScaleX

    • getScaleX(): number

    getScaleY

    • getScaleY(): number

    getScaleY

    • getScaleY(): number

    getSqDistanceToObject

    getSqDistanceToObject

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    Returns number

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    • Get a timer elapsed time.

      This is used by expressions to return 0 when a timer doesn't exist because numeric expressions must always return a number.

      Parameters

      • timerName: string

        The timer name.

      Returns number

      The timer elapsed time in seconds, 0 if the timer doesn't exist.

      -

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getUniqueId

    • getUniqueId(): number

    getUniqueId

    • getUniqueId(): number

    • Get the unique identifier of the object.
      The identifier is set by the runtimeScene owning the object.
      You can also use the id property (this._object.id) for increased efficiency instead of calling this method.

      Returns number

      The object identifier

      -

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableString

    • getVariableString(variable: Variable): string

    Static getVariableString

    • getVariableString(variable: Variable): string

    getVariables

    getVariables

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    • Get the AABB (axis aligned bounding box) to be used to determine if the object is visible on screen. The gdjs.RuntimeScene will hide the renderer object if the object is not visible on screen ("culling").

      The default implementation uses the AABB returned by getAABB.

      If null is returned, the object is assumed to be always visible.

      Returns null | AABB

      The bounding box or null.

      -

    getWidth

    • getWidth(): number

    getWidth

    • getWidth(): number

    getX

    • getX(): number

    getX

    • getX(): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    • Compute the X position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getY

    • getY(): number

    Returns number

    getY

    • getY(): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    • Compute the Y position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getZOrder

    • getZOrder(): number

    Returns number

    getZOrder

    • getZOrder(): number

    hasAnimationEnded

    • hasAnimationEnded(): boolean

    hasAnimationEnded

    • hasAnimationEnded(): boolean

    hasBehavior

    • hasBehavior(name: string): boolean

    hasBehavior

    • hasBehavior(name: string): boolean

    hasEffect

    • hasEffect(name: string): boolean

    Returns boolean

    hasEffect

    • hasEffect(name: string): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hide

    • hide(enable: boolean): void

    hide

    • hide(enable: boolean): void

    insideObject

    • insideObject(x: number, y: number): boolean

    Returns void

    insideObject

    • insideObject(x: number, y: number): boolean

    • Return true if the specified position is inside object bounding box.

      The position should be in "world" coordinates, i.e use gdjs.Layer.convertCoords if you need to pass the mouse or a touch position that you get from gdjs.InputManager. To check if a point is inside the object collision mask, you can use isCollidingWithPoint instead.

      -

      Parameters

      • x: number
      • y: number

      Returns boolean

    invalidateHitboxes

    • invalidateHitboxes(): void

    invalidateHitboxes

    • invalidateHitboxes(): void

    isAnimationIndex

    • isAnimationIndex(animationIndex: number): boolean

    isAnimationPaused

    • isAnimationPaused(): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isAnimationIndex

    • isAnimationIndex(animationIndex: number): boolean

    isAnimationPaused

    • isAnimationPaused(): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isFlippedX

    • isFlippedX(): boolean

    isFlippedY

    • isFlippedY(): boolean

    isHidden

    • isHidden(): boolean

    isFlippedX

    • isFlippedX(): boolean

    isFlippedY

    • isFlippedY(): boolean

    isHidden

    • isHidden(): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    • Return true if the angle of the total force applied on the object is in a given range.

      Parameters

      • angle: number
        @@ -421,43 +421,43 @@

        The maximum distance from the given angle.

      Returns boolean

      true if the difference between the force angle the given angle is less or equals the toleranceInDegrees.

      -

    isVisible

    • isVisible(): boolean

    isVisible

    • isVisible(): boolean

    • Return true if the object is not hidden.

      Note: This is unrelated to the actual visibility of the object on the screen. For this, see getVisibilityAABB to get the bounding boxes of the object as displayed on the scene.

      Returns boolean

      true if the object is not hidden.

      -

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    • To be called by the child classes in their constructor, at the very end. Notify the behaviors that they have been constructed (this must be done when the object is ready, otherwise behaviors can do operations on the object which could be not initialized yet).

      If you redefine this function, make sure to call the original method (RuntimeObject.prototype.onCreated.call(this);).

      -

      Returns void

    onDeletedFromScene

    onDeletedFromScene

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    Returns void

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    onSceneResumed

    Returns void

    onSceneResumed

    pauseAnimation

    • pauseAnimation(): void

    pauseTimer

    • pauseTimer(timerName: string): void

    Returns void

    pauseAnimation

    • pauseAnimation(): void

    pauseTimer

    • pauseTimer(timerName: string): void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    Returns void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    • Put the object around a position, with a specific distance and angle. The distance and angle are computed between the position and the center of the object.

      Parameters

      • x: number
        @@ -468,7 +468,7 @@

        The distance between the object and the target, in pixels.

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    • Put the object around another object, with a specific distance and angle. The distance and angle are computed between the centers of the objects.

      Parameters

      • obj: null | RuntimeObject
        @@ -477,7 +477,7 @@

        The distance between the object and the target

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    • Called to reset the object to its default state. This is used for objects that are "recycled": they are dismissed (at which point onDestroyFromScene is called) but still stored in a cache to be reused next time an object must be created. At this point, @@ -503,7 +503,7 @@

    • The _runtimeScene, _nameId, name and type are guaranteed to stay the same and do not need to be set again.
    -

    Parameters

    • objectData: ObjectData

    Returns void

    removeBehavior

    • removeBehavior(name: string): boolean

    removeBehavior

    • removeBehavior(name: string): boolean

    • Remove the behavior with the given name. Usually only used by hot-reloading, as performance of this operation is not guaranteed (in the future, this could lead to re-organization of arrays @@ -511,77 +511,77 @@

      Parameters

      • name: string

        The name of the behavior to remove.

      Returns boolean

      true if the behavior was properly removed, false otherwise.

      -

    removeEffect

    • removeEffect(effectName: string): boolean

    removeEffect

    • removeEffect(effectName: string): boolean

    removeTimer

    • removeTimer(timerName: string): void

    Returns boolean

    removeTimer

    • removeTimer(timerName: string): void

    resetTimer

    • resetTimer(timerName: string): void

    Returns void

    resetTimer

    • resetTimer(timerName: string): void

    resumeAnimation

    • resumeAnimation(): void

    Static returnVariable

    Returns void

    resumeAnimation

    • resumeAnimation(): void

    Static returnVariable

    rotate

    rotate

    rotateTowardAngle

    rotateTowardAngle

    rotateTowardPosition

    • rotateTowardPosition(x: number, y: number, speed: number, scene: RuntimeScene): void

    separateFromObjects

    • separateFromObjects(objects: RuntimeObject[], ignoreTouchingEdges: boolean): boolean

    Returns void

    rotateTowardPosition

    • rotateTowardPosition(x: number, y: number, speed: number, scene: RuntimeScene): void

    separateFromObjects

    • separateFromObjects(objects: RuntimeObject[], ignoreTouchingEdges: boolean): boolean

    • Separate the object from others objects, using their hitboxes.

      Parameters

      • objects: RuntimeObject[]

        Objects

      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if the object was moved

      -

    separateFromObjectsList

    • separateFromObjectsList(objectsLists: ObjectsLists, ignoreTouchingEdges: boolean): boolean

    separateFromObjectsList

    • separateFromObjectsList(objectsLists: ObjectsLists, ignoreTouchingEdges: boolean): boolean

    • Separate the object from others objects, using their hitboxes.

      Parameters

      • objectsLists: ObjectsLists

        Tables of objects

      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if the object was moved

      -

    separateObjectsWithForces

    • separateObjectsWithForces(objectsLists: ObjectsLists): void

    separateObjectsWithForces

    • separateObjectsWithForces(objectsLists: ObjectsLists): void

    separateObjectsWithoutForces

    • separateObjectsWithoutForces(objectsLists: ObjectsLists): void

    separateObjectsWithoutForces

    • separateObjectsWithoutForces(objectsLists: ObjectsLists): void

    setAngle

    • setAngle(angle: number): void

    Returns void

    setAngle

    • setAngle(angle: number): void

    setAnimationElapsedTime

    • setAnimationElapsedTime(time: number): void

    setAnimationElapsedTime

    • setAnimationElapsedTime(time: number): void

    setAnimationIndex

    • setAnimationIndex(animationIndex: number): void

    setAnimationIndex

    • setAnimationIndex(animationIndex: number): void

    setAnimationIndexWithMixing

    • setAnimationIndexWithMixing(animationIndex: number, mixingDuration: number): void

    setAnimationMixingDuration

    • setAnimationMixingDuration(animationMixingDuration: number): void

    setAnimationIndexWithMixing

    • setAnimationIndexWithMixing(animationIndex: number, mixingDuration: number): void

    setAnimationMixingDuration

    • setAnimationMixingDuration(animationMixingDuration: number): void

    setAnimationName

    • setAnimationName(animationName: string): void

    setAnimationName

    • setAnimationName(animationName: string): void

    setAnimationNameWithMixing

    • setAnimationNameWithMixing(animationName: string, mixingDuration: number): void

    setAnimationSpeedScale

    • setAnimationSpeedScale(ratio: number): void

    setCenterPositionInScene

    • setCenterPositionInScene(x: number, y: number): void

    setAnimationNameWithMixing

    • setAnimationNameWithMixing(animationName: string, mixingDuration: number): void

    setAnimationSpeedScale

    • setAnimationSpeedScale(ratio: number): void

    setCenterPositionInScene

    • setCenterPositionInScene(x: number, y: number): void

    setCenterXInScene

    • setCenterXInScene(x: number): void

    Returns void

    setCenterXInScene

    • setCenterXInScene(x: number): void

    setCenterYInScene

    • setCenterYInScene(y: number): void

    Returns void

    setCenterYInScene

    • setCenterYInScene(y: number): void

    setEffectBooleanParameter

    • setEffectBooleanParameter(name: string, parameterName: string, value: boolean): boolean

    setEffectBooleanParameter

    • setEffectBooleanParameter(name: string, parameterName: string, value: boolean): boolean

    setEffectDoubleParameter

    • setEffectDoubleParameter(name: string, parameterName: string, value: number): boolean

    Returns boolean

    setEffectDoubleParameter

    • setEffectDoubleParameter(name: string, parameterName: string, value: number): boolean

    setEffectStringParameter

    • setEffectStringParameter(name: string, parameterName: string, value: string): boolean

    Returns boolean

    setEffectStringParameter

    • setEffectStringParameter(name: string, parameterName: string, value: string): boolean

    setHeight

    • setHeight(newHeight: number): void

    Returns boolean

    setHeight

    • setHeight(newHeight: number): void

    setIncludedInParentCollisionMask

    • setIncludedInParentCollisionMask(isIncluded: boolean): void

    setLayer

    • setLayer(layer: string): void

    setIncludedInParentCollisionMask

    • setIncludedInParentCollisionMask(isIncluded: boolean): void

    setLayer

    • setLayer(layer: string): void

    setOpacity

    • setOpacity(opacity: number): void

    Returns void

    setOpacity

    • setOpacity(opacity: number): void

    setPosition

    • setPosition(x: number, y: number): void

    setPosition

    • setPosition(x: number, y: number): void

    setScale

    • setScale(newScale: number): void

    Returns void

    setScale

    • setScale(newScale: number): void

    setScaleX

    • setScaleX(newScale: number): void

    setScaleX

    • setScaleX(newScale: number): void

    setScaleY

    • setScaleY(newScale: number): void

    setScaleY

    • setScaleY(newScale: number): void

    setSize

    • setSize(newWidth: number, newHeight: number): void

    setSize

    • setSize(newWidth: number, newHeight: number): void

    Static setVariableNumber

    • setVariableNumber(variable: Variable, newValue: number): void

    Static setVariableNumber

    • setVariableNumber(variable: Variable, newValue: number): void

    Static setVariableString

    • setVariableString(variable: Variable, newValue: string): void

    Returns void

    Static setVariableString

    • setVariableString(variable: Variable, newValue: string): void

    setWidth

    • setWidth(newWidth: number): void

    Returns void

    setWidth

    • setWidth(newWidth: number): void

    setX

    • setX(x: number): void

    setX

    • setX(x: number): void

    setY

    • setY(y: number): void

    setY

    • setY(y: number): void

    setZOrder

    • setZOrder(z: number): void

    setZOrder

    • setZOrder(z: number): void

    stepBehaviorsPostEvents

    Returns void

    stepBehaviorsPostEvents

    stepBehaviorsPreEvents

    stepBehaviorsPreEvents

    timerElapsedTime

    • timerElapsedTime(timerName: string, timeInSeconds: number): boolean

    timerElapsedTime

    • timerElapsedTime(timerName: string, timeInSeconds: number): boolean

    • Compare a timer elapsed time. If the timer does not exist, it is created.

      deprecated

      prefer using getTimerElapsedTimeInSecondsOrNaN.

      Parameters

      • timerName: string
        @@ -661,167 +661,167 @@
      • timeInSeconds: number

        The time value to check in seconds.

      Returns boolean

      True if the timer exists and its value is greater than or equal than the given time, false otherwise.

      -

    timerPaused

    • timerPaused(timerName: string): boolean

    timerPaused

    • timerPaused(timerName: string): boolean

    unpauseTimer

    • unpauseTimer(timerName: string): void

    unpauseTimer

    • unpauseTimer(timerName: string): void

    unregisterDestroyCallback

    • unregisterDestroyCallback(callback: () => void): void

    update

    Returns void

    unregisterDestroyCallback

    • unregisterDestroyCallback(callback: () => void): void

    update

    updateAABB

    • updateAABB(): void

    updateAABB

    • updateAABB(): void

    • Update the AABB (axis aligned bounding box) for the object.

      Default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box.

      You should not call this function by yourself, it is called when necessary by getAABB method. However, you can redefine it if your object can have a faster implementation.

      -

      Returns void

    updateAllEffectParameters

    • updateAllEffectParameters(effectData: EffectData): boolean

    updateAllEffectParameters

    • updateAllEffectParameters(effectData: EffectData): boolean

    updateForces

    • updateForces(elapsedTime: number): void

    Returns boolean

    updateForces

    • updateForces(elapsedTime: number): void

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    updateFromObjectData

    updateFromObjectData

    updateHitBoxes

    • updateHitBoxes(): void

    updateHitBoxes

    • updateHitBoxes(): void

    • Update the hit boxes for the object.

      The default implementation set a basic bounding box based on the size (getWidth and getHeight) and the center point of the object (getCenterX and getCenterY). Result is cached until invalidated (by a position change, angle change...).

      You should not call this function by yourself, it is called when necessary by getHitBoxes method. However, you can redefine it if your object need custom hit boxes.

      -

      Returns void

    updatePreRender

    updatePreRender

    updateTimers

    • updateTimers(elapsedTime: number): void

    Returns void

    updateTimers

    • updateTimers(elapsedTime: number): void

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []
    +

    Returns void

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []

    Global container for unused forces, avoiding recreating forces each tick.

    -
    static

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number
      • +

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number

      • Get the squared distance, in pixels, between the center of this object and a position.

        Parameters

        • targetX: number

          Target X position

        • targetY: number

          Target Y position

          -

        Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • +

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • Get the number of children from a variable

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The number of children

        -

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

      • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The value of the specified variable

        -

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

      • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns string

        The string of the specified variable

        -

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null
    +

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null

    A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

    -

    persistentUuid

    persistentUuid: null | string = null
    +

    persistentUuid

    persistentUuid: null | string = null

    An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

    -

    pick

    pick: boolean = false
    +

    pick

    pick: boolean = false

    A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

    -

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

      • Return the variable passed as argument without any change. Only for usage by events.

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns Variable

        The specified variable

        -

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void
      • +

      Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void

      • Shortcut to set the value of a variable considered as a number

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: number

          The value to be set

          -

        Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void
      • +

      Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void

      • Shortcut to set the value of a variable considered as a string

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: string

          The value to be set

          -

        Returns void

    Readonly spineResourceName

    spineResourceName: string

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • +

      Returns void

    Readonly spineResourceName

    spineResourceName: string

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable
          +

          Parameters

          • array: Variable
          • value: string | number | boolean

          Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable

          The variable to be tested

        • childName: string

          The name of the child

          -

        Returns boolean

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

      • static

        Parameters

        • variable: Variable

          The variable to be cleared

          -

        Returns void

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

        • variable: Variable

          The variable to be changed

        • childName: string

          The name of the child

          -

        Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • +

      Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Constructors

    constructor

    Constructors

    constructor

    • Parameters

      • instanceContainer: RuntimeInstanceContainer

        The container the object belongs to.

      • objectData: SpineObjectData

        The object data used to initialize the object

        diff --git a/GDJS Runtime Documentation/classes/gdjs.SpineRuntimeObjectPixiRenderer.html b/GDJS Runtime Documentation/classes/gdjs.SpineRuntimeObjectPixiRenderer.html index 9c3d10794..92b4fe0a3 100644 --- a/GDJS Runtime Documentation/classes/gdjs.SpineRuntimeObjectPixiRenderer.html +++ b/GDJS Runtime Documentation/classes/gdjs.SpineRuntimeObjectPixiRenderer.html @@ -1,8 +1,8 @@ -SpineRuntimeObjectPixiRenderer | GDevelop JavaScript game engine
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class SpineRuntimeObjectPixiRenderer

        Hierarchy

        • SpineRuntimeObjectPixiRenderer

        Index

        Constructors

        Methods

        Constructors

        constructor

        • Parameters

          • runtimeObject: SpineRuntimeObject
            +SpineRuntimeObjectPixiRenderer | GDevelop JavaScript game engine
            Options
            All
            • Public
            • Public/Protected
            • All
            Menu

            Class SpineRuntimeObjectPixiRenderer

            Hierarchy

            • SpineRuntimeObjectPixiRenderer

            Index

            Constructors

            Methods

            Constructors

            constructor

            Methods

            getAnimationDuration

            • getAnimationDuration(sourceAnimationName: string): number

            getAnimationElapsedTime

            • getAnimationElapsedTime(): number

            getHeight

            • getHeight(): number

            getOriginOffset

            • getOriginOffset(): Point

            getRendererObject

            • getRendererObject(): Container<DisplayObject> | Spine

            getUnscaledHeight

            • getUnscaledHeight(): number

            getUnscaledWidth

            • getUnscaledWidth(): number

            getWidth

            • getWidth(): number

            isAnimationComplete

            • isAnimationComplete(): boolean

            onDestroy

            • onDestroy(): void

            setAnimation

            • setAnimation(animation: string, loop: boolean): void

            setAnimationElapsedTime

            • setAnimationElapsedTime(time: number): void

            setHeight

            • setHeight(height: number): void

            setMixing

            • setMixing(from: string, to: string, duration: number): void

            setWidth

            • setWidth(width: number): void

            updateAngle

            • updateAngle(): void

            updateAnimation

            • updateAnimation(timeDelta: number): void

            updateOpacity

            • updateOpacity(): void

            updatePosition

            • updatePosition(): void

            updateScale

            • updateScale(): void

            Private constructRendererObject

            • constructRendererObject(): Container<DisplayObject> | Spine

            Legend

            • Constructor
            • Method
            • Private method

            Settings

            Theme

            Generated using TypeDoc

            Options
            All
            • Public
            • Public/Protected
            • All
            Menu

            Class SpriteAnimation<T>

            Represents an animation of a SpriteRuntimeObject.

            -

            Type parameters

            • T

            Hierarchy

            • SpriteAnimation

            Index

            Constructors

            Properties

            Methods

            Constructors

            constructor

            Type parameters

            • T

            Hierarchy

            • SpriteAnimation

            Index

            Constructors

            Properties

            Methods

            Constructors

            constructor

            Properties

            directions

            directions: SpriteAnimationDirection<T>[] = []

            hasMultipleDirections

            hasMultipleDirections: boolean

            name

            name: string

            Methods

            reinitialize

            Properties

            directions

            directions: SpriteAnimationDirection<T>[] = []

            hasMultipleDirections

            hasMultipleDirections: boolean

            name

            name: string

            Methods

            reinitialize

            Methods

            getPoint

            • Get a point of the frame.
              If the point does not exist, the origin is returned.

              Parameters

              • name: string

                The point's name

              Returns SpritePoint

              The requested point. If it doesn't exists returns the origin point.

              -

            reinitialize

            reinitialize

            Methods

            getAngle

            • getAngle(angle: number): number

            getAnimationDuration

            • getAnimationDuration(): number

            getAnimationElapsedTime

            • getAnimationElapsedTime(): number

            getAnimationFrameCount

            • getAnimationFrameCount(): number

            getAnimationFrameIndex

            • getAnimationFrameIndex(): number

            • Get the index of the current frame displayed by the animation

              Returns number

              newFrame The index of the frame being displayed

              -

            getAnimationIndex

            • getAnimationIndex(): number

            getAnimationIndex

            • getAnimationIndex(): number

            getAnimationName

            • getAnimationName(): string

            getAnimationName

            • getAnimationName(): string

            getAnimationSpeedScale

            • getAnimationSpeedScale(): number

            getCurrentFrame

            getDirectionOrAngle

            • getDirectionOrAngle(angle: number): number

            getNetworkSyncData

            hasAnimationEnded

            • hasAnimationEnded(): boolean

            getAnimationSpeedScale

            • getAnimationSpeedScale(): number

            getCurrentFrame

            getDirectionOrAngle

            • getDirectionOrAngle(angle: number): number

            getNetworkSyncData

            hasAnimationEnded

            • hasAnimationEnded(): boolean

            hasAnimationEndedLegacy

            • hasAnimationEndedLegacy(): boolean

            Returns boolean

        hasAnimationEndedLegacy

        • hasAnimationEndedLegacy(): boolean

        invalidateFrame

        • invalidateFrame(): void

        isAnimationPaused

        • isAnimationPaused(): boolean

        pauseAnimation

        • pauseAnimation(): void

        reinitialize

        resumeAnimation

        • resumeAnimation(): void

        setAngle

        • setAngle(oldAngle: number, angle: number): null | number

        setAnimationElapsedTime

        • setAnimationElapsedTime(time: number): boolean

        invalidateFrame

        • invalidateFrame(): void

        isAnimationPaused

        • isAnimationPaused(): boolean

        pauseAnimation

        • pauseAnimation(): void

        reinitialize

        resumeAnimation

        • resumeAnimation(): void

        setAngle

        • setAngle(oldAngle: number, angle: number): null | number

        setAnimationElapsedTime

        • setAnimationElapsedTime(time: number): boolean

        setAnimationFrameIndex

        • setAnimationFrameIndex(newFrameIndex: number): boolean

        setAnimationFrameIndex

        • setAnimationFrameIndex(newFrameIndex: number): boolean

        • Change the current frame displayed by the animation

          Parameters

          • newFrameIndex: number

            The index of the frame to be displayed

            -

          Returns boolean

        setAnimationIndex

        • setAnimationIndex(newAnimation: number): boolean

        Returns boolean

    setAnimationIndex

    • setAnimationIndex(newAnimation: number): boolean

    setAnimationName

    • setAnimationName(newAnimationName: string): boolean

    setAnimationName

    • setAnimationName(newAnimationName: string): boolean

    setAnimationSpeedScale

    • setAnimationSpeedScale(ratio: number): void

    setDirectionOrAngle

    • setDirectionOrAngle(oldValue: number, newValue: number): null | number

    setAnimationSpeedScale

    • setAnimationSpeedScale(ratio: number): void

    setDirectionOrAngle

    • setDirectionOrAngle(oldValue: number, newValue: number): null | number

    • Change the angle (or direction index) of the object

      -
      deprecated

      Parameters

      • oldValue: number
      • newValue: number

      Returns null | number

    setOnFrameChangeCallback

    • setOnFrameChangeCallback(callback: () => void): void

    setOnFrameChangeCallback

    • setOnFrameChangeCallback(callback: () => void): void

    • Register a listener to frame changes.

      It's useful for custom objects as they don't drive this class themselves.

      Parameters

      • callback: () => void

        Called each time getCurrentFrame changes.

        -
          • (): void

          • Returns void

      Returns void

    step

    • step(timeDelta: number): boolean

    Returns void

    step

    • step(timeDelta: number): boolean

    • Update the current frame of the object according to the elapsed time on the scene.

      Parameters

      • timeDelta: number

        in seconds

        -

      Returns boolean

    updateFromNetworkSyncData

    updateFromObjectData

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class SpriteRuntimeObject

    The SpriteRuntimeObject represents an object that can display images.

    -

    Hierarchy

    Implements

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    Hierarchy

    Implements

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    addEffect

    • addEffect(effectData: EffectData): boolean

    Returns void

    addEffect

    • addEffect(effectData: EffectData): boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    Returns boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    • Add a force to the object to move it.

      Parameters

      • x: number

        The x coordinates of the force

        @@ -18,7 +18,7 @@

        The y coordinates of the force

      • multiplier: number

        Set the force multiplier

        -

      Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    Returns void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    Returns void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    • Create the behavior described by the given BehaviorData

      Parameters

      • behaviorData: BehaviorData

        The data to be used to construct the behavior.

      Returns boolean

      true if the behavior was properly created, false otherwise.

      -

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    animationPaused

    • animationPaused(): boolean

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns void

    animationPaused

    • animationPaused(): boolean

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns boolean

    true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

    -

    behaviorActivated

    • behaviorActivated(name: string): boolean

    behaviorActivated

    • behaviorActivated(name: string): boolean

    clearEffects

    • clearEffects(): boolean

    clearEffects

    • clearEffects(): boolean

    clearForces

    • clearForces(): void

    clearForces

    • clearForces(): void

    Static collisionTest

    Static collisionTest

    • Return true if the hitboxes of two objects are overlapping

      static

      Parameters

      • obj1: RuntimeObject

        The first runtimeObject

        @@ -79,84 +79,84 @@
      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if obj1 and obj2 are in collision

      -

    cursorOnObject

    cursorOnObject

    deleteFromScene

    deleteFromScene

    Static distanceTest

    Returns void

    Static distanceTest

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    Returns void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    flipX

    • flipX(enable: boolean): void

    flipY

    • flipY(enable: boolean): void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    Returns void

    flipX

    • flipX(enable: boolean): void

    flipY

    • flipY(enable: boolean): void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    • Get the AABB (axis aligned bounding box) for the object.

      The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

      You should probably redefine updateAABB instead of this function.

      Returns AABB

      The bounding box

      -

    getAABBBottom

    • getAABBBottom(): number

    getAABBBottom

    • getAABBBottom(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBRight

    • getAABBRight(): number

    getAABBRight

    • getAABBRight(): number

    getAABBTop

    • getAABBTop(): number

    getAABBTop

    • getAABBTop(): number

    getAngle

    • getAngle(): number

    getAngle

    • getAngle(): number

    getAngleToObject

    getAngleToObject

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    Returns number

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    getAnimation

    • getAnimation(): number

    Returns number

    getAnimation

    • getAnimation(): number

    • Get the index of the animation being played.

      deprecated

      Use getAnimationIndex instead

      Returns number

      The index of the new animation being played

      -

    getAnimationDuration

    • getAnimationDuration(): number

    getAnimationElapsedTime

    • getAnimationElapsedTime(): number

    getAnimationFrame

    • getAnimationFrame(): number

    getAnimationDuration

    • getAnimationDuration(): number

    getAnimationElapsedTime

    • getAnimationElapsedTime(): number

    getAnimationFrame

    • getAnimationFrame(): number

    getAnimationFrameCount

    • getAnimationFrameCount(): number

    getAnimationIndex

    • getAnimationIndex(): number

    getAnimationFrameCount

    • getAnimationFrameCount(): number

    getAnimationIndex

    • getAnimationIndex(): number

    getAnimationName

    • getAnimationName(): string

    getAnimationName

    • getAnimationName(): string

    getAnimationSpeedScale

    • getAnimationSpeedScale(): number

    getAverageForce

    getAnimationSpeedScale

    • getAnimationSpeedScale(): number

    getAverageForce

    getBehavior

    getBehavior

    • Get a behavior from its name. If the behavior does not exists, undefined is returned.

      Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -164,54 +164,54 @@

      Parameters

      • name: string

        The behavior name.

      Returns null | RuntimeBehavior

      The behavior with the given name, or undefined.

      -

    getBlendMode

    • getBlendMode(): number

    getCenterX

    • getCenterX(): number

    getBlendMode

    • getBlendMode(): number

    getCenterX

    • getCenterX(): number

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterY

    • getCenterY(): number

    getCenterY

    • getCenterY(): number

    getCenterYInScene

    • getCenterYInScene(): number

    getCenterYInScene

    • getCenterYInScene(): number

    getColor

    • getColor(): string

    getColor

    • getColor(): string

    getDirectionOrAngle

    • getDirectionOrAngle(): number

    getDistanceToObject

    getDirectionOrAngle

    • getDirectionOrAngle(): number

    getDistanceToObject

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    getDrawableX

    • getDrawableX(): number

    Returns number

    getDrawableX

    • getDrawableX(): number

    getDrawableY

    • getDrawableY(): number

    getDrawableY

    • getDrawableY(): number

    getElapsedTime

    getElapsedTime

    getHeight

    • getHeight(): number

    Returns number

    getHeight

    • getHeight(): number

    getHitBoxes

    getHitBoxes

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    • Return at least all the hit boxes that overlap a given area.

      The hit boxes don't need to actually overlap the area, (i.e: it's correct to return more hit boxes than those in the specified area) @@ -236,147 +236,147 @@

    • bottom: number

      bound of the area in scene coordinates

    Returns Iterable<Polygon>

    at least all the hit boxes that overlap a given area.

    -

    getInstanceContainer

    getInstanceContainer

    getLayer

    • getLayer(): string

    getLayer

    • getLayer(): string

    getName

    • getName(): string

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    • Get the identifier associated to an object name. Some features may want to compare objects name a large number of time. In this case, it may be more efficient to compare objects name identifiers.

      -
      static

      Parameters

      • name: string

      Returns number

    getNetworkSyncData

    getNetworkSyncData

    getOpacity

    • getOpacity(): number

    getOpacity

    • getOpacity(): number

    getParent

    getParent

    getPointPosition

    • getPointPosition(name: string): [x: number, y: number]

    getPointPosition

    • getPointPosition(name: string): [x: number, y: number]

    • Get the positions on X and Y axis on the scene of the given point.

      Parameters

      • name: string

        The point name

      Returns [x: number, y: number]

      An array of the position on X and Y axis on the scene of the given point.

      -

    getPointX

    • getPointX(name: string): number

    getPointX

    • getPointX(name: string): number

    • Get the position on X axis on the scene of the given point.

      Parameters

      • name: string

        The point name

      Returns number

      the position on X axis on the scene of the given point.

      -

    getPointY

    • getPointY(name: string): number

    getPointY

    • getPointY(name: string): number

    • Get the position on Y axis on the scene of the given point.

      Parameters

      • name: string

        The point name

      Returns number

      the position on Y axis on the scene of the given point.

      -

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererObject

    • getRendererObject(): Sprite

    getRuntimeScene

    getRendererObject

    • getRendererObject(): Sprite

    getRuntimeScene

    getScale

    • getScale(): number

    getScale

    • getScale(): number

    • Get the scale of the object (or the geometric mean of the X and Y scale in case they are different).

      Returns number

      the scale of the object (or the geometric mean of the X and Y scale in case they are different).

      -

    getScaleMean

    • getScaleMean(): number

    getScaleMean

    • getScaleMean(): number

    • Get the scale of the object (or the arithmetic mean of the X and Y scale in case they are different).

      deprecated

      Use getScale instead.

      Returns number

      the scale of the object (or the arithmetic mean of the X and Y scale in case they are different).

      -

    getScaleX

    • getScaleX(): number

    getScaleX

    • getScaleX(): number

    getScaleY

    • getScaleY(): number

    getScaleY

    • getScaleY(): number

    getSqDistanceToObject

    getSqDistanceToObject

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    Returns number

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    • Get a timer elapsed time.

      This is used by expressions to return 0 when a timer doesn't exist because numeric expressions must always return a number.

      Parameters

      • timerName: string

        The timer name.

      Returns number

      The timer elapsed time in seconds, 0 if the timer doesn't exist.

      -

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getUniqueId

    • getUniqueId(): number

    getUniqueId

    • getUniqueId(): number

    • Get the unique identifier of the object.
      The identifier is set by the runtimeScene owning the object.
      You can also use the id property (this._object.id) for increased efficiency instead of calling this method.

      Returns number

      The object identifier

      -

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableString

    • getVariableString(variable: Variable): string

    Static getVariableString

    • getVariableString(variable: Variable): string

    getVariables

    getVariables

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    • Get the AABB (axis aligned bounding box) to be used to determine if the object is visible on screen. The gdjs.RuntimeScene will hide the renderer object if the object is not visible on screen ("culling").

      The default implementation uses the AABB returned by getAABB.

      If null is returned, the object is assumed to be always visible.

      Returns null | AABB

      The bounding box or null.

      -

    getWidth

    • getWidth(): number

    getWidth

    • getWidth(): number

    getX

    • getX(): number

    getX

    • getX(): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    • Compute the X position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getY

    • getY(): number

    Returns number

    getY

    • getY(): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    • Compute the Y position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getZOrder

    • getZOrder(): number

    Returns number

    getZOrder

    • getZOrder(): number

    hasAnimationEnded

    • hasAnimationEnded(): boolean

    hasAnimationEnded

    • hasAnimationEnded(): boolean

    hasAnimationEnded2

    • hasAnimationEnded2(): boolean

    hasAnimationEnded2

    • hasAnimationEnded2(): boolean

    • Return true if animation has ended. The animation had ended if:

        @@ -393,61 +393,61 @@
      • the last frame has been displayed long enough.
      deprecated

      Use hasAnimationEnded instead.

      -

      Returns boolean

    hasAnimationEndedLegacy

    • hasAnimationEndedLegacy(): boolean

    hasAnimationEndedLegacy

    • hasAnimationEndedLegacy(): boolean
    • deprecated

      Return true if animation has ended. Prefer using hasAnimationEnded2. This method returns true as soon as the animation enters the last frame, not at the end of the last frame.

      -

      Returns boolean

    hasBehavior

    • hasBehavior(name: string): boolean

    hasBehavior

    • hasBehavior(name: string): boolean

    hasEffect

    • hasEffect(name: string): boolean

    Returns boolean

    hasEffect

    • hasEffect(name: string): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hide

    • hide(enable: boolean): void

    hide

    • hide(enable: boolean): void

    insideObject

    • insideObject(x: number, y: number): boolean

    Returns void

    insideObject

    • insideObject(x: number, y: number): boolean

    • Return true if the specified position is inside object bounding box.

      The position should be in "world" coordinates, i.e use gdjs.Layer.convertCoords if you need to pass the mouse or a touch position that you get from gdjs.InputManager. To check if a point is inside the object collision mask, you can use isCollidingWithPoint instead.

      -

      Parameters

      • x: number
      • y: number

      Returns boolean

    invalidateHitboxes

    • invalidateHitboxes(): void

    invalidateHitboxes

    • invalidateHitboxes(): void

    isAnimationPaused

    • isAnimationPaused(): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isAnimationPaused

    • isAnimationPaused(): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isCurrentAnimationName

    • isCurrentAnimationName(name: string): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isCurrentAnimationName

    • isCurrentAnimationName(name: string): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isFlippedX

    • isFlippedX(): boolean

    isFlippedY

    • isFlippedY(): boolean

    isHidden

    • isHidden(): boolean

    isFlippedX

    • isFlippedX(): boolean

    isFlippedY

    • isFlippedY(): boolean

    isHidden

    • isHidden(): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    • Return true if the angle of the total force applied on the object is in a given range.

      Parameters

      • angle: number
        @@ -456,44 +456,44 @@

        The maximum distance from the given angle.

      Returns boolean

      true if the difference between the force angle the given angle is less or equals the toleranceInDegrees.

      -

    isVisible

    • isVisible(): boolean

    isVisible

    • isVisible(): boolean

    • Return true if the object is not hidden.

      Note: This is unrelated to the actual visibility of the object on the screen. For this, see getVisibilityAABB to get the bounding boxes of the object as displayed on the scene.

      Returns boolean

      true if the object is not hidden.

      -

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    • To be called by the child classes in their constructor, at the very end. Notify the behaviors that they have been constructed (this must be done when the object is ready, otherwise behaviors can do operations on the object which could be not initialized yet).

      If you redefine this function, make sure to call the original method (RuntimeObject.prototype.onCreated.call(this);).

      -

      Returns void

    onDeletedFromScene

    onDeletedFromScene

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    Returns void

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    onSceneResumed

    Returns void

    onSceneResumed

    pauseAnimation

    • pauseAnimation(): void

    pauseTimer

    • pauseTimer(timerName: string): void

    Returns void

    pauseAnimation

    • pauseAnimation(): void

    pauseTimer

    • pauseTimer(timerName: string): void

    playAnimation

    • playAnimation(): void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    Returns void

    playAnimation

    • playAnimation(): void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    • Put the object around a position, with a specific distance and angle. The distance and angle are computed between the position and the center of the object.

      Parameters

      • x: number
        @@ -504,7 +504,7 @@

        The distance between the object and the target, in pixels.

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    • Put the object around another object, with a specific distance and angle. The distance and angle are computed between the centers of the objects.

      Parameters

      • obj: null | RuntimeObject
        @@ -513,7 +513,7 @@

        The distance between the object and the target

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • Called to reset the object to its default state. This is used for objects that are "recycled": they are dismissed (at which point onDestroyFromScene is called) but still stored in a cache to be reused next time an object must be created. At this point, @@ -539,7 +539,7 @@

    • The _runtimeScene, _nameId, name and type are guaranteed to stay the same and do not need to be set again.
    -

    Parameters

    Returns void

    removeBehavior

    removeBehavior

    removeEffect

    removeEffect

    removeTimer

    Returns boolean

    removeTimer

    resetTimer

    Returns void

    resetTimer

    resumeAnimation

    Static returnVariable

    Returns void

    resumeAnimation

    Static returnVariable

    rotate

    rotate

    rotateTowardAngle

    rotateTowardAngle

    rotateTowardPosition

    separateFromObjects

    Returns void

    rotateTowardPosition

    separateFromObjects

    separateFromObjectsList

    separateFromObjectsList

    separateObjectsWithForces

    separateObjectsWithForces

    separateObjectsWithoutForces

    separateObjectsWithoutForces

    setAngle

    Returns void

    setAngle

    setAnimation

    Returns void

    setAnimation

    setAnimationElapsedTime

    Returns void

    setAnimationElapsedTime

    setAnimationFrame

    setAnimationFrame

    setAnimationIndex

    Returns void

    setAnimationIndex

    setAnimationName

    setAnimationName

    setAnimationSpeedScale

    setBlendMode

    setCenterPositionInScene

    setAnimationSpeedScale

    setBlendMode

    setCenterPositionInScene

    setCenterXInScene

    Returns void

    setCenterXInScene

    setCenterYInScene

    Returns void

    setCenterYInScene

    setColor

    setColor

    setDirectionOrAngle

    Returns void

    setDirectionOrAngle

    setEffectBooleanParameter

    setEffectBooleanParameter

    setEffectDoubleParameter

    Returns boolean

    setEffectDoubleParameter

    setEffectStringParameter

    Returns boolean

    setEffectStringParameter

    setHeight

    Returns boolean

    setHeight

    setIncludedInParentCollisionMask

    setLayer

    setIncludedInParentCollisionMask

    setLayer

    setOpacity

    Returns void

    setOpacity

    setPosition

    setPosition

    setScale

    Returns void

    setScale

    setScaleX

    Returns void

    setScaleX

    setScaleY

    Returns void

    setScaleY

    setSize

    Returns void

    setSize

    Static setVariableNumber

    Static setVariableNumber

    Static setVariableString

    Returns void

    Static setVariableString

    setWidth

    Returns void

    setWidth

    setX

    setX

    setY

    Returns void

    setY

    setZOrder

    Returns void

    setZOrder

    stepBehaviorsPostEvents

    Returns void

    stepBehaviorsPostEvents

    stepBehaviorsPreEvents

    stepBehaviorsPreEvents

    timerElapsedTime

    timerElapsedTime

    timerPaused

    timerPaused

    turnTowardObject

    turnTowardObject

    unpauseTimer

    Returns void

    unpauseTimer

    unregisterDestroyCallback

    update

    Returns void

    unregisterDestroyCallback

    update

    updateAABB

    updateAABB

    updateAllEffectParameters

    updateAllEffectParameters

    updateForces

    Returns boolean

    updateForces

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    updateFromObjectData

    updateFromObjectData

    updateHitBoxes

    updateHitBoxes

    updatePreRender

    updatePreRender

    updateTimers

    updateTimers

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []
    +

    Returns void

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []

    Global container for unused forces, avoiding recreating forces each tick.

    -
    static

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number
      • +

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number

      • Get the squared distance, in pixels, between the center of this object and a position.

        Parameters

        • targetX: number

          Target X position

        • targetY: number

          Target Y position

          -

        Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • +

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • Get the number of children from a variable

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The number of children

        -

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

      • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The value of the specified variable

        -

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

      • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns string

        The string of the specified variable

        -

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null
    +

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null

    A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

    -

    opacity

    opacity: number = 255

    persistentUuid

    persistentUuid: null | string = null
    +

    opacity

    opacity: number = 255

    persistentUuid

    persistentUuid: null | string = null

    An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

    -

    pick

    pick: boolean = false
    +

    pick

    pick: boolean = false

    A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

    -

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

      • Return the variable passed as argument without any change. Only for usage by events.

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns Variable

        The specified variable

        -

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void
      • +

      Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void

      • Shortcut to set the value of a variable considered as a number

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: number

          The value to be set

          -

        Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void
      • +

      Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void

      • Shortcut to set the value of a variable considered as a string

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: string

          The value to be set

          -

        Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • +

      Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable
          +

          Parameters

          • array: Variable
          • value: string | number | boolean

          Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable

          The variable to be tested

        • childName: string

          The name of the child

          -

        Returns boolean

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

      • static

        Parameters

        • variable: Variable

          The variable to be cleared

          -

        Returns void

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

        • variable: Variable

          The variable to be changed

        • childName: string

          The name of the child

          -

        Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • +

      Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Constructors

    constructor

    Constructors

    constructor

    Methods

    ensureUpToDate

    • ensureUpToDate(): void

    Static getAnimationFrameTextureManager

    • getAnimationFrameTextureManager(imageManager: PixiImageManager): PixiAnimationFrameTextureManager

    getColor

    • getColor(): string

    getHeight

    • getHeight(): number

    getRendererObject

    • getRendererObject(): Sprite

    getUnscaledHeight

    • getUnscaledHeight(): number

    getUnscaledWidth

    • getUnscaledWidth(): number

    getWidth

    • getWidth(): number

    reinitialize

    setColor

    • setColor(rgbColor: any): void

    update

    • update(): void

    updateAngle

    • updateAngle(): void

    updateFrame

    Static getAnimationFrameTextureManager

    • getAnimationFrameTextureManager(imageManager: PixiImageManager): PixiAnimationFrameTextureManager

    getColor

    • getColor(): string

    getHeight

    • getHeight(): number

    getRendererObject

    • getRendererObject(): Sprite

    getUnscaledHeight

    • getUnscaledHeight(): number

    getUnscaledWidth

    • getUnscaledWidth(): number

    getWidth

    • getWidth(): number

    reinitialize

    setColor

    • setColor(rgbColor: any): void

    update

    • update(): void

    updateAngle

    • updateAngle(): void

    updateFrame

    updateOpacity

    • updateOpacity(): void

    updateVisibility

    • updateVisibility(): void

    updateX

    • updateX(): void

    updateY

    • updateY(): void

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class TaskGroup

    Hierarchy

    Index

    Methods

    Constructors

    Properties

    Methods

    addTask

    update

    • +TaskGroup | GDevelop JavaScript game engine
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class TaskGroup

      Hierarchy

      Index

      Methods

      Constructors

      Properties

      Methods

      addTask

      update

      Constructors

      constructor

      Properties

      Private tasks

      tasks: AsyncTask[] = ...

      Legend

      • Method
      • Inherited constructor
      • Private property

      Settings

      Theme

      Generated using TypeDoc

      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class TextContainerBehavior

      A behavior that forwards the TextContainer interface to its object.

      -

      Hierarchy

      Implements

      Index

      Methods

      Constructors

      Properties

      Methods

      activate

      • activate(enable: boolean): void

      Hierarchy

      Implements

      Index

      Methods

      Constructors

      Properties

      Methods

      activate

      • activate(enable: boolean): void

      activated

      • activated(): boolean

      Returns void

    activated

    • activated(): boolean

    doStepPostEvents

    doStepPostEvents

    doStepPreEvents

    doStepPreEvents

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getName

    • getName(): string

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    getText

    • getText(): string

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    getText

    • getText(): string

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    onDeActivate

    • onDeActivate(): void

    onDeActivate

    • onDeActivate(): void

    onDestroy

    • onDestroy(): void

    onDestroy

    • onDestroy(): void

    onObjectHotReloaded

    • onObjectHotReloaded(): void

    onObjectHotReloaded

    • onObjectHotReloaded(): void

    setText

    • setText(text: string): void

    setText

    • setText(text: string): void

    stepPostEvents

    stepPostEvents

    stepPreEvents

    Returns void

    stepPreEvents

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    Returns void

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    Returns void

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    Constructors

    constructor

    Properties

    name

    name: string

    owner

    owner: RuntimeObject

    type

    type: string

    Private object

    object: RuntimeObject & TextContainer

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class TextEntryRuntimeObject

    The TextEntryRuntimeObject allows to capture text typed on the keyboard.

    -

    Hierarchy

    Index

    Methods

    Properties

    Constructors

    Methods

    activate

    • activate(enable: boolean): void

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    Hierarchy

    Index

    Methods

    Properties

    Constructors

    Methods

    activate

    • activate(enable: boolean): void

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    addEffect

    • addEffect(effectData: EffectData): boolean

    Returns void

    addEffect

    • addEffect(effectData: EffectData): boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    Returns boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    • Add a force to the object to move it.

      Parameters

      • x: number

        The x coordinates of the force

        @@ -18,7 +18,7 @@

        The y coordinates of the force

      • multiplier: number

        Set the force multiplier

        -

      Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    Returns void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    Returns void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    • Create the behavior described by the given BehaviorData

      Parameters

      • behaviorData: BehaviorData

        The data to be used to construct the behavior.

      Returns boolean

      true if the behavior was properly created, false otherwise.

      -

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns boolean

    true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

    -

    behaviorActivated

    • behaviorActivated(name: string): boolean

    behaviorActivated

    • behaviorActivated(name: string): boolean

    clearEffects

    • clearEffects(): boolean

    clearEffects

    • clearEffects(): boolean

    clearForces

    • clearForces(): void

    clearForces

    • clearForces(): void

    Static collisionTest

    Static collisionTest

    • Return true if the hitboxes of two objects are overlapping

      static

      Parameters

      • obj1: RuntimeObject

        The first runtimeObject

        @@ -78,70 +78,70 @@
      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if obj1 and obj2 are in collision

      -

    cursorOnObject

    cursorOnObject

    deleteFromScene

    deleteFromScene

    Static distanceTest

    Returns void

    Static distanceTest

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    Returns void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    Returns void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    • Get the AABB (axis aligned bounding box) for the object.

      The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

      You should probably redefine updateAABB instead of this function.

      Returns AABB

      The bounding box

      -

    getAABBBottom

    • getAABBBottom(): number

    getAABBBottom

    • getAABBBottom(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBRight

    • getAABBRight(): number

    getAABBRight

    • getAABBRight(): number

    getAABBTop

    • getAABBTop(): number

    getAABBTop

    • getAABBTop(): number

    getAngle

    • getAngle(): number

    getAngle

    • getAngle(): number

    getAngleToObject

    getAngleToObject

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    Returns number

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    getAverageForce

    Returns number

    getAverageForce

    getBehavior

    getBehavior

    • Get a behavior from its name. If the behavior does not exists, undefined is returned.

      Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -149,59 +149,59 @@

      Parameters

      • name: string

        The behavior name.

      Returns null | RuntimeBehavior

      The behavior with the given name, or undefined.

      -

    getCenterX

    • getCenterX(): number

    getCenterX

    • getCenterX(): number

    • Return the X position of the object center, relative to the object X position (getDrawableX). Use getCenterXInScene to get the position of the center in the scene.

      Returns number

      the X position of the object center, relative to getDrawableX().

      -

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterY

    • getCenterY(): number

    getCenterY

    • getCenterY(): number

    • Return the Y position of the object center, relative to the object position (getDrawableY). Use getCenterYInScene to get the position of the center in the scene.

      Returns number

      the Y position of the object center, relative to getDrawableY().

      -

    getCenterYInScene

    • getCenterYInScene(): number

    getCenterYInScene

    • getCenterYInScene(): number

    getDistanceToObject

    getDistanceToObject

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    getDrawableX

    • getDrawableX(): number

    Returns number

    getDrawableX

    • getDrawableX(): number

    • Get the X position of the rendered object.

      For most objects, this will returns the same value as getX(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableX will differ.

      Returns number

      The X position of the rendered object.

      -

    getDrawableY

    • getDrawableY(): number

    getDrawableY

    • getDrawableY(): number

    • Get the Y position of the rendered object.

      For most objects, this will returns the same value as getY(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableY will differ.

      Returns number

      The Y position of the rendered object.

      -

    getElapsedTime

    getElapsedTime

    getHeight

    • getHeight(): number

    Returns number

    getHeight

    • getHeight(): number

    getHitBoxes

    getHitBoxes

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    • Return at least all the hit boxes that overlap a given area.

      The hit boxes don't need to actually overlap the area, (i.e: it's correct to return more hit boxes than those in the specified area) @@ -226,167 +226,167 @@

    • bottom: number

      bound of the area in scene coordinates

    Returns Iterable<Polygon>

    at least all the hit boxes that overlap a given area.

    -

    getInstanceContainer

    getInstanceContainer

    getLayer

    • getLayer(): string

    getLayer

    • getLayer(): string

    getName

    • getName(): string

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    • Get the identifier associated to an object name. Some features may want to compare objects name a large number of time. In this case, it may be more efficient to compare objects name identifiers.

      -
      static

      Parameters

      • name: string

      Returns number

    getNetworkSyncData

    • getNetworkSyncData(): ObjectNetworkSyncData

    getNetworkSyncData

    • getNetworkSyncData(): ObjectNetworkSyncData

    getParent

    getParent

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererObject

    getRuntimeScene

    getRendererObject

    getRuntimeScene

    getSqDistanceToObject

    getSqDistanceToObject

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    getString

    • getString(): string

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    Returns number

    getString

    • getString(): string

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    • Get a timer elapsed time.

      This is used by expressions to return 0 when a timer doesn't exist because numeric expressions must always return a number.

      Parameters

      • timerName: string

        The timer name.

      Returns number

      The timer elapsed time in seconds, 0 if the timer doesn't exist.

      -

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getUniqueId

    • getUniqueId(): number

    getUniqueId

    • getUniqueId(): number

    • Get the unique identifier of the object.
      The identifier is set by the runtimeScene owning the object.
      You can also use the id property (this._object.id) for increased efficiency instead of calling this method.

      Returns number

      The object identifier

      -

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableString

    • getVariableString(variable: Variable): string

    Static getVariableString

    • getVariableString(variable: Variable): string

    getVariables

    getVariables

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    • Get the AABB (axis aligned bounding box) to be used to determine if the object is visible on screen. The gdjs.RuntimeScene will hide the renderer object if the object is not visible on screen ("culling").

      The default implementation uses the AABB returned by getAABB.

      If null is returned, the object is assumed to be always visible.

      Returns null | AABB

      The bounding box or null.

      -

    getWidth

    • getWidth(): number

    getWidth

    • getWidth(): number

    getX

    • getX(): number

    getX

    • getX(): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    • Compute the X position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getY

    • getY(): number

    Returns number

    getY

    • getY(): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    • Compute the Y position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getZOrder

    • getZOrder(): number

    Returns number

    getZOrder

    • getZOrder(): number

    hasBehavior

    • hasBehavior(name: string): boolean

    hasBehavior

    • hasBehavior(name: string): boolean

    hasEffect

    • hasEffect(name: string): boolean

    Returns boolean

    hasEffect

    • hasEffect(name: string): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hide

    • hide(enable: boolean): void

    hide

    • hide(enable: boolean): void

    insideObject

    • insideObject(x: number, y: number): boolean

    Returns void

    insideObject

    • insideObject(x: number, y: number): boolean

    • Return true if the specified position is inside object bounding box.

      The position should be in "world" coordinates, i.e use gdjs.Layer.convertCoords if you need to pass the mouse or a touch position that you get from gdjs.InputManager. To check if a point is inside the object collision mask, you can use isCollidingWithPoint instead.

      -

      Parameters

      • x: number
      • y: number

      Returns boolean

    invalidateHitboxes

    • invalidateHitboxes(): void

    invalidateHitboxes

    • invalidateHitboxes(): void

    isActivated

    • isActivated(): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isActivated

    • isActivated(): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isHidden

    • isHidden(): boolean

    isHidden

    • isHidden(): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    • Return true if the angle of the total force applied on the object is in a given range.

      Parameters

      • angle: number
        @@ -395,43 +395,43 @@

        The maximum distance from the given angle.

      Returns boolean

      true if the difference between the force angle the given angle is less or equals the toleranceInDegrees.

      -

    isVisible

    • isVisible(): boolean

    isVisible

    • isVisible(): boolean

    • Return true if the object is not hidden.

      Note: This is unrelated to the actual visibility of the object on the screen. For this, see getVisibilityAABB to get the bounding boxes of the object as displayed on the scene.

      Returns boolean

      true if the object is not hidden.

      -

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    • To be called by the child classes in their constructor, at the very end. Notify the behaviors that they have been constructed (this must be done when the object is ready, otherwise behaviors can do operations on the object which could be not initialized yet).

      If you redefine this function, make sure to call the original method (RuntimeObject.prototype.onCreated.call(this);).

      -

      Returns void

    onDeletedFromScene

    onDeletedFromScene

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    Returns void

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    onSceneResumed

    Returns void

    onSceneResumed

    pauseTimer

    • pauseTimer(timerName: string): void

    Returns void

    pauseTimer

    • pauseTimer(timerName: string): void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    Returns void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    • Put the object around a position, with a specific distance and angle. The distance and angle are computed between the position and the center of the object.

      Parameters

      • x: number
        @@ -442,7 +442,7 @@

        The distance between the object and the target, in pixels.

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    • Put the object around another object, with a specific distance and angle. The distance and angle are computed between the centers of the objects.

      Parameters

      • obj: null | RuntimeObject
        @@ -451,7 +451,7 @@

        The distance between the object and the target

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    • Called to reset the object to its default state. This is used for objects that are "recycled": they are dismissed (at which point onDestroyFromScene is called) but still stored in a cache to be reused next time an object must be created. At this point, @@ -477,7 +477,7 @@

    • The _runtimeScene, _nameId, name and type are guaranteed to stay the same and do not need to be set again.
    -

    Parameters

    Returns void

    removeBehavior

    removeBehavior

    removeEffect

    removeEffect

    removeTimer

    Returns boolean

    removeTimer

    resetTimer

    Returns void

    resetTimer

    Static returnVariable

    Returns void

    Static returnVariable

    rotate

    rotate

    rotateTowardAngle

    rotateTowardAngle

    rotateTowardPosition

    separateFromObjects

    Returns void

    rotateTowardPosition

    separateFromObjects

    separateFromObjectsList

    separateFromObjectsList

    separateObjectsWithForces

    separateObjectsWithForces

    separateObjectsWithoutForces

    separateObjectsWithoutForces

    setAngle

    Returns void

    setAngle

    setCenterPositionInScene

    Returns void

    setCenterPositionInScene

    setCenterXInScene

    Returns void

    setCenterXInScene

    setCenterYInScene

    Returns void

    setCenterYInScene

    setEffectBooleanParameter

    setEffectBooleanParameter

    setEffectDoubleParameter

    Returns boolean

    setEffectDoubleParameter

    setEffectStringParameter

    Returns boolean

    setEffectStringParameter

    setHeight

    Returns boolean

    setHeight

    setIncludedInParentCollisionMask

    setLayer

    Returns void

    setIncludedInParentCollisionMask

    setLayer

    setPosition

    Returns void

    setPosition

    setString

    Static setVariableNumber

    Returns void

    setString

    Static setVariableNumber

    Static setVariableString

    Returns void

    Static setVariableString

    setWidth

    Returns void

    setWidth

    setX

    Returns void

    setX

    setY

    Returns void

    setY

    setZOrder

    Returns void

    setZOrder

    stepBehaviorsPostEvents

    Returns void

    stepBehaviorsPostEvents

    stepBehaviorsPreEvents

    stepBehaviorsPreEvents

    timerElapsedTime

    timerElapsedTime

    timerPaused

    timerPaused

    unpauseTimer

    unpauseTimer

    unregisterDestroyCallback

    update

    Returns void

    unregisterDestroyCallback

    update

    updateAABB

    updateAABB

    updateAllEffectParameters

    updateAllEffectParameters

    updateForces

    Returns boolean

    updateForces

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    updateFromObjectData

    updateFromObjectData

    updateHitBoxes

    updateHitBoxes

    updatePreRender

    updatePreRender

    updateTimers

    Returns void

    updateTimers

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []
    +

    Returns void

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []

    Global container for unused forces, avoiding recreating forces each tick.

    -
    static

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number
      • +

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number

      • Get the squared distance, in pixels, between the center of this object and a position.

        Parameters

        • targetX: number

          Target X position

        • targetY: number

          Target Y position

          -

        Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • +

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • Get the number of children from a variable

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The number of children

        -

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

      • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The value of the specified variable

        -

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

      • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns string

        The string of the specified variable

        -

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null
    +

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null

    A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

    -

    persistentUuid

    persistentUuid: null | string = null
    +

    persistentUuid

    persistentUuid: null | string = null

    An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

    -

    pick

    pick: boolean = false
    +

    pick

    pick: boolean = false

    A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

    -

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

      • Return the variable passed as argument without any change. Only for usage by events.

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns Variable

        The specified variable

        -

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void
      • +

      Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void

      • Shortcut to set the value of a variable considered as a number

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: number

          The value to be set

          -

        Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void
      • +

      Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void

      • Shortcut to set the value of a variable considered as a string

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: string

          The value to be set

          -

        Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • +

      Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable
          +

          Parameters

          • array: Variable
          • value: string | number | boolean

          Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable

          The variable to be tested

        • childName: string

          The name of the child

          -

        Returns boolean

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

      • static

        Parameters

        • variable: Variable

          The variable to be cleared

          -

        Returns void

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

        • variable: Variable

          The variable to be changed

        • childName: string

          The name of the child

          -

        Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • +

      Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Constructors

    constructor

    Constructors

    constructor

    addEffect

    • addEffect(effectData: EffectData): boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    Returns boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    • Add a force to the object to move it.

      Parameters

      • x: number

        The x coordinates of the force

        @@ -18,7 +18,7 @@

        The y coordinates of the force

      • multiplier: number

        Set the force multiplier

        -

      Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    Returns void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    Returns void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    • Create the behavior described by the given BehaviorData

      Parameters

      • behaviorData: BehaviorData

        The data to be used to construct the behavior.

      Returns boolean

      true if the behavior was properly created, false otherwise.

      -

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns boolean

    true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

    -

    behaviorActivated

    • behaviorActivated(name: string): boolean

    behaviorActivated

    • behaviorActivated(name: string): boolean

    clearEffects

    • clearEffects(): boolean

    clearEffects

    • clearEffects(): boolean

    clearForces

    • clearForces(): void

    clearForces

    • clearForces(): void

    Static collisionTest

    Static collisionTest

    • Return true if the hitboxes of two objects are overlapping

      static

      Parameters

      • obj1: RuntimeObject

        The first runtimeObject

        @@ -78,67 +78,67 @@
      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if obj1 and obj2 are in collision

      -

    cursorOnObject

    cursorOnObject

    deleteFromScene

    deleteFromScene

    Static distanceTest

    Returns void

    Static distanceTest

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    Returns void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    focus

    • focus(): void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    focus

    • focus(): void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    • Get the AABB (axis aligned bounding box) for the object.

      The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

      You should probably redefine updateAABB instead of this function.

      Returns AABB

      The bounding box

      -

    getAABBBottom

    • getAABBBottom(): number

    getAABBBottom

    • getAABBBottom(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBRight

    • getAABBRight(): number

    getAABBRight

    • getAABBRight(): number

    getAABBTop

    • getAABBTop(): number

    getAABBTop

    • getAABBTop(): number

    getAngle

    • getAngle(): number

    getAngle

    • getAngle(): number

    getAngleToObject

    getAngleToObject

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    Returns number

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    getAverageForce

    Returns number

    getAverageForce

    getBehavior

    getBehavior

    • Get a behavior from its name. If the behavior does not exists, undefined is returned.

      Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -146,59 +146,59 @@

      Parameters

      • name: string

        The behavior name.

      Returns null | RuntimeBehavior

      The behavior with the given name, or undefined.

      -

    getBorderColor

    • getBorderColor(): string

    getBorderOpacity

    • getBorderOpacity(): number

    getBorderWidth

    • getBorderWidth(): number

    getCenterX

    • getCenterX(): number

    getBorderColor

    • getBorderColor(): string

    getBorderOpacity

    • getBorderOpacity(): number

    getBorderWidth

    • getBorderWidth(): number

    getCenterX

    • getCenterX(): number

    • Return the X position of the object center, relative to the object X position (getDrawableX). Use getCenterXInScene to get the position of the center in the scene.

      Returns number

      the X position of the object center, relative to getDrawableX().

      -

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterY

    • getCenterY(): number

    getCenterY

    • getCenterY(): number

    • Return the Y position of the object center, relative to the object position (getDrawableY). Use getCenterYInScene to get the position of the center in the scene.

      Returns number

      the Y position of the object center, relative to getDrawableY().

      -

    getCenterYInScene

    • getCenterYInScene(): number

    getCenterYInScene

    • getCenterYInScene(): number

    getDistanceToObject

    getDistanceToObject

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    getDrawableX

    • getDrawableX(): number

    Returns number

    getDrawableX

    • getDrawableX(): number

    • Get the X position of the rendered object.

      For most objects, this will returns the same value as getX(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableX will differ.

      Returns number

      The X position of the rendered object.

      -

    getDrawableY

    • getDrawableY(): number

    getDrawableY

    • getDrawableY(): number

    • Get the Y position of the rendered object.

      For most objects, this will returns the same value as getY(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableY will differ.

      Returns number

      The Y position of the rendered object.

      -

    getElapsedTime

    getElapsedTime

    getFillColor

    • getFillColor(): string

    getFillOpacity

    • getFillOpacity(): number

    getFontResourceName

    • getFontResourceName(): string

    getFontSize

    • getFontSize(): number

    getHeight

    • getHeight(): number

    Returns number

    getFillColor

    • getFillColor(): string

    getFillOpacity

    • getFillOpacity(): number

    getFontResourceName

    • getFontResourceName(): string

    getFontSize

    • getFontSize(): number

    getHeight

    • getHeight(): number

    getHitBoxes

    getHitBoxes

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    • Return at least all the hit boxes that overlap a given area.

      The hit boxes don't need to actually overlap the area, (i.e: it's correct to return more hit boxes than those in the specified area) @@ -223,179 +223,179 @@

    • bottom: number

      bound of the area in scene coordinates

    Returns Iterable<Polygon>

    at least all the hit boxes that overlap a given area.

    -

    getInputType

    • getInputType(): "number" | "text" | "email" | "password" | "telephone number" | "url" | "search" | "text area"

    getInputType

    • getInputType(): "number" | "text" | "email" | "password" | "telephone number" | "url" | "search" | "text area"

    getInstanceContainer

    getInstanceContainer

    getLayer

    • getLayer(): string

    getLayer

    • getLayer(): string

    getName

    • getName(): string

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    • Get the identifier associated to an object name. Some features may want to compare objects name a large number of time. In this case, it may be more efficient to compare objects name identifiers.

      -
      static

      Parameters

      • name: string

      Returns number

    getNetworkSyncData

    getNetworkSyncData

    getOpacity

    • getOpacity(): number

    getOpacity

    • getOpacity(): number

    getParent

    getParent

    getPlaceholder

    • getPlaceholder(): string

    getPlaceholder

    • getPlaceholder(): string

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererObject

    • getRendererObject(): null

    getRuntimeScene

    getRendererObject

    • getRendererObject(): null

    getRuntimeScene

    getSqDistanceToObject

    getSqDistanceToObject

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    getString

    • getString(): string

    Returns number

    getString

    • getString(): string

    getText

    • getText(): string

    getText

    • getText(): string

    getTextColor

    • getTextColor(): string

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    getTextColor

    • getTextColor(): string

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    • Get a timer elapsed time.

      This is used by expressions to return 0 when a timer doesn't exist because numeric expressions must always return a number.

      Parameters

      • timerName: string

        The timer name.

      Returns number

      The timer elapsed time in seconds, 0 if the timer doesn't exist.

      -

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getUniqueId

    • getUniqueId(): number

    getUniqueId

    • getUniqueId(): number

    • Get the unique identifier of the object.
      The identifier is set by the runtimeScene owning the object.
      You can also use the id property (this._object.id) for increased efficiency instead of calling this method.

      Returns number

      The object identifier

      -

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableString

    • getVariableString(variable: Variable): string

    Static getVariableString

    • getVariableString(variable: Variable): string

    getVariables

    getVariables

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    • Get the AABB (axis aligned bounding box) to be used to determine if the object is visible on screen. The gdjs.RuntimeScene will hide the renderer object if the object is not visible on screen ("culling").

      The default implementation uses the AABB returned by getAABB.

      If null is returned, the object is assumed to be always visible.

      Returns null | AABB

      The bounding box or null.

      -

    getWidth

    • getWidth(): number

    getWidth

    • getWidth(): number

    getX

    • getX(): number

    getX

    • getX(): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    • Compute the X position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getY

    • getY(): number

    Returns number

    getY

    • getY(): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    • Compute the Y position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getZOrder

    • getZOrder(): number

    Returns number

    getZOrder

    • getZOrder(): number

    hasBehavior

    • hasBehavior(name: string): boolean

    hasBehavior

    • hasBehavior(name: string): boolean

    hasEffect

    • hasEffect(name: string): boolean

    Returns boolean

    hasEffect

    • hasEffect(name: string): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hide

    • hide(enable: boolean): void

    hide

    • hide(enable: boolean): void

    insideObject

    • insideObject(x: number, y: number): boolean

    Returns void

    insideObject

    • insideObject(x: number, y: number): boolean

    • Return true if the specified position is inside object bounding box.

      The position should be in "world" coordinates, i.e use gdjs.Layer.convertCoords if you need to pass the mouse or a touch position that you get from gdjs.InputManager. To check if a point is inside the object collision mask, you can use isCollidingWithPoint instead.

      -

      Parameters

      • x: number
      • y: number

      Returns boolean

    invalidateHitboxes

    • invalidateHitboxes(): void

    invalidateHitboxes

    • invalidateHitboxes(): void

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isDisabled

    • isDisabled(): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isDisabled

    • isDisabled(): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isFocused

    • isFocused(): boolean

    isHidden

    • isHidden(): boolean

    isFocused

    • isFocused(): boolean

    isHidden

    • isHidden(): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isReadOnly

    • isReadOnly(): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    isReadOnly

    • isReadOnly(): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    • Return true if the angle of the total force applied on the object is in a given range.

      Parameters

      • angle: number
        @@ -404,45 +404,45 @@

        The maximum distance from the given angle.

      Returns boolean

      true if the difference between the force angle the given angle is less or equals the toleranceInDegrees.

      -

    isVisible

    • isVisible(): boolean

    isVisible

    • isVisible(): boolean

    • Return true if the object is not hidden.

      Note: This is unrelated to the actual visibility of the object on the screen. For this, see getVisibilityAABB to get the bounding boxes of the object as displayed on the scene.

      Returns boolean

      true if the object is not hidden.

      -

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    • To be called by the child classes in their constructor, at the very end. Notify the behaviors that they have been constructed (this must be done when the object is ready, otherwise behaviors can do operations on the object which could be not initialized yet).

      If you redefine this function, make sure to call the original method (RuntimeObject.prototype.onCreated.call(this);).

      -

      Returns void

    onDeletedFromScene

    onDeletedFromScene

    onDestroyed

    • onDestroyed(): void

    onRendererInputValueChanged

    • onRendererInputValueChanged(inputValue: string): void

    Returns void

    onDestroyed

    • onDestroyed(): void

    onRendererInputValueChanged

    • onRendererInputValueChanged(inputValue: string): void

    • Called by the renderer when the value of the input shown on the screen was changed (because the user typed something). This does not propagate back the value to the renderer, which would result in the cursor being sent back to the end of the text.

      Do not use this if you are not inside the renderer - use setString instead.

      -

      Parameters

      • inputValue: string

      Returns void

    onScenePaused

    onScenePaused

    onSceneResumed

    onSceneResumed

    pauseTimer

    • pauseTimer(timerName: string): void

    pauseTimer

    • pauseTimer(timerName: string): void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    Returns void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    • Put the object around a position, with a specific distance and angle. The distance and angle are computed between the position and the center of the object.

      Parameters

      • x: number
        @@ -453,7 +453,7 @@

        The distance between the object and the target, in pixels.

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    • Put the object around another object, with a specific distance and angle. The distance and angle are computed between the centers of the objects.

      Parameters

      • obj: null | RuntimeObject
        @@ -462,7 +462,7 @@

        The distance between the object and the target

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    • Called to reset the object to its default state. This is used for objects that are "recycled": they are dismissed (at which point onDestroyFromScene is called) but still stored in a cache to be reused next time an object must be created. At this point, @@ -488,7 +488,7 @@

    • The _runtimeScene, _nameId, name and type are guaranteed to stay the same and do not need to be set again.
    -

    Parameters

    • objectData: ObjectData

    Returns void

    removeBehavior

    • removeBehavior(name: string): boolean

    removeBehavior

    • removeBehavior(name: string): boolean

    • Remove the behavior with the given name. Usually only used by hot-reloading, as performance of this operation is not guaranteed (in the future, this could lead to re-organization of arrays @@ -496,71 +496,71 @@

      Parameters

      • name: string

        The name of the behavior to remove.

      Returns boolean

      true if the behavior was properly removed, false otherwise.

      -

    removeEffect

    • removeEffect(effectName: string): boolean

    removeEffect

    • removeEffect(effectName: string): boolean

    removeTimer

    • removeTimer(timerName: string): void

    Returns boolean

    removeTimer

    • removeTimer(timerName: string): void

    resetTimer

    • resetTimer(timerName: string): void

    Returns void

    resetTimer

    • resetTimer(timerName: string): void

    Static returnVariable

    Returns void

    Static returnVariable

    rotate

    rotate

    rotateTowardAngle

    rotateTowardAngle

    rotateTowardPosition

    • rotateTowardPosition(x: number, y: number, speed: number, scene: RuntimeScene): void

    separateFromObjects

    • separateFromObjects(objects: RuntimeObject[], ignoreTouchingEdges: boolean): boolean

    Returns void

    rotateTowardPosition

    • rotateTowardPosition(x: number, y: number, speed: number, scene: RuntimeScene): void

    separateFromObjects

    • separateFromObjects(objects: RuntimeObject[], ignoreTouchingEdges: boolean): boolean

    • Separate the object from others objects, using their hitboxes.

      Parameters

      • objects: RuntimeObject[]

        Objects

      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if the object was moved

      -

    separateFromObjectsList

    • separateFromObjectsList(objectsLists: ObjectsLists, ignoreTouchingEdges: boolean): boolean

    separateFromObjectsList

    • separateFromObjectsList(objectsLists: ObjectsLists, ignoreTouchingEdges: boolean): boolean

    • Separate the object from others objects, using their hitboxes.

      Parameters

      • objectsLists: ObjectsLists

        Tables of objects

      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if the object was moved

      -

    separateObjectsWithForces

    • separateObjectsWithForces(objectsLists: ObjectsLists): void

    separateObjectsWithForces

    • separateObjectsWithForces(objectsLists: ObjectsLists): void

    separateObjectsWithoutForces

    • separateObjectsWithoutForces(objectsLists: ObjectsLists): void

    separateObjectsWithoutForces

    • separateObjectsWithoutForces(objectsLists: ObjectsLists): void

    setAngle

    • setAngle(angle: number): void

    Returns void

    setAngle

    • setAngle(angle: number): void

    setBorderColor

    • setBorderColor(newColor: string): void

    setBorderOpacity

    • setBorderOpacity(newOpacity: number): void

    setBorderWidth

    • setBorderWidth(width: number): void

    setCenterPositionInScene

    • setCenterPositionInScene(x: number, y: number): void

    Returns void

    setBorderColor

    • setBorderColor(newColor: string): void

    setBorderOpacity

    • setBorderOpacity(newOpacity: number): void

    setBorderWidth

    • setBorderWidth(width: number): void

    setCenterPositionInScene

    • setCenterPositionInScene(x: number, y: number): void

    setCenterXInScene

    • setCenterXInScene(x: number): void

    Returns void

    setCenterXInScene

    • setCenterXInScene(x: number): void

    setCenterYInScene

    • setCenterYInScene(y: number): void

    Returns void

    setCenterYInScene

    • setCenterYInScene(y: number): void

    setDisabled

    • setDisabled(value: boolean): void

    setEffectBooleanParameter

    • setEffectBooleanParameter(name: string, parameterName: string, value: boolean): boolean

    setDisabled

    • setDisabled(value: boolean): void

    setEffectBooleanParameter

    • setEffectBooleanParameter(name: string, parameterName: string, value: boolean): boolean

    setEffectDoubleParameter

    • setEffectDoubleParameter(name: string, parameterName: string, value: number): boolean

    Returns boolean

    setEffectDoubleParameter

    • setEffectDoubleParameter(name: string, parameterName: string, value: number): boolean

    setEffectStringParameter

    • setEffectStringParameter(name: string, parameterName: string, value: string): boolean

    Returns boolean

    setEffectStringParameter

    • setEffectStringParameter(name: string, parameterName: string, value: string): boolean

    setFillColor

    • setFillColor(newColor: string): void

    setFillOpacity

    • setFillOpacity(newOpacity: number): void

    setFontResourceName

    • setFontResourceName(resourceName: string): void

    setFontSize

    • setFontSize(newSize: number): void

    setHeight

    • setHeight(height: number): void

    Returns boolean

    setFillColor

    • setFillColor(newColor: string): void

    setFillOpacity

    • setFillOpacity(newOpacity: number): void

    setFontResourceName

    • setFontResourceName(resourceName: string): void

    setFontSize

    • setFontSize(newSize: number): void

    setHeight

    • setHeight(height: number): void

    setIncludedInParentCollisionMask

    • setIncludedInParentCollisionMask(isIncluded: boolean): void

    setInputType

    • setInputType(newInputType: string): void

    setIncludedInParentCollisionMask

    • setIncludedInParentCollisionMask(isIncluded: boolean): void

    setInputType

    • setInputType(newInputType: string): void

    setLayer

    • setLayer(layer: string): void

    setLayer

    • setLayer(layer: string): void

    setOpacity

    • setOpacity(opacity: number): void

    Returns void

    setOpacity

    • setOpacity(opacity: number): void

    setPlaceholder

    • setPlaceholder(newPlaceholder: string): void

    setPlaceholder

    • setPlaceholder(newPlaceholder: string): void

    setPosition

    • setPosition(x: number, y: number): void

    setPosition

    • setPosition(x: number, y: number): void

    setReadOnly

    • setReadOnly(value: boolean): void

    setSize

    • setSize(width: number, height: number): void

    Returns void

    setReadOnly

    • setReadOnly(value: boolean): void

    setSize

    • setSize(width: number, height: number): void

    setString

    • setString(text: string): void

    setString

    • setString(text: string): void

    setText

    • setText(newString: string): void

    setText

    • setText(newString: string): void

    setTextColor

    • setTextColor(newColor: string): void

    Static setVariableNumber

    • setVariableNumber(variable: Variable, newValue: number): void

    setTextColor

    • setTextColor(newColor: string): void

    Static setVariableNumber

    • setVariableNumber(variable: Variable, newValue: number): void

    Static setVariableString

    • setVariableString(variable: Variable, newValue: string): void

    Returns void

    Static setVariableString

    • setVariableString(variable: Variable, newValue: string): void

    setWidth

    • setWidth(width: number): void

    Returns void

    setWidth

    • setWidth(width: number): void

    setX

    • setX(x: number): void

    setX

    • setX(x: number): void

    setY

    • setY(y: number): void

    Returns void

    setY

    • setY(y: number): void

    setZOrder

    • setZOrder(z: number): void

    Returns void

    setZOrder

    • setZOrder(z: number): void

    stepBehaviorsPostEvents

    Returns void

    stepBehaviorsPostEvents

    stepBehaviorsPreEvents

    stepBehaviorsPreEvents

    timerElapsedTime

    • timerElapsedTime(timerName: string, timeInSeconds: number): boolean

    timerElapsedTime

    • timerElapsedTime(timerName: string, timeInSeconds: number): boolean

    • Compare a timer elapsed time. If the timer does not exist, it is created.

      deprecated

      prefer using getTimerElapsedTimeInSecondsOrNaN.

      Parameters

      • timerName: string
        @@ -647,167 +647,167 @@
      • timeInSeconds: number

        The time value to check in seconds.

      Returns boolean

      True if the timer exists and its value is greater than or equal than the given time, false otherwise.

      -

    timerPaused

    • timerPaused(timerName: string): boolean

    timerPaused

    • timerPaused(timerName: string): boolean

    unpauseTimer

    • unpauseTimer(timerName: string): void

    unpauseTimer

    • unpauseTimer(timerName: string): void

    unregisterDestroyCallback

    • unregisterDestroyCallback(callback: () => void): void

    update

    Returns void

    unregisterDestroyCallback

    • unregisterDestroyCallback(callback: () => void): void

    update

    updateAABB

    • updateAABB(): void

    Returns void

    updateAABB

    • updateAABB(): void

    • Update the AABB (axis aligned bounding box) for the object.

      Default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box.

      You should not call this function by yourself, it is called when necessary by getAABB method. However, you can redefine it if your object can have a faster implementation.

      -

      Returns void

    updateAllEffectParameters

    • updateAllEffectParameters(effectData: EffectData): boolean

    updateAllEffectParameters

    • updateAllEffectParameters(effectData: EffectData): boolean

    updateForces

    • updateForces(elapsedTime: number): void

    Returns boolean

    updateForces

    • updateForces(elapsedTime: number): void

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    updateFromObjectData

    updateFromObjectData

    updateHitBoxes

    • updateHitBoxes(): void

    updateHitBoxes

    • updateHitBoxes(): void

    • Update the hit boxes for the object.

      The default implementation set a basic bounding box based on the size (getWidth and getHeight) and the center point of the object (getCenterX and getCenterY). Result is cached until invalidated (by a position change, angle change...).

      You should not call this function by yourself, it is called when necessary by getHitBoxes method. However, you can redefine it if your object need custom hit boxes.

      -

      Returns void

    updatePreRender

    updatePreRender

    updateTimers

    • updateTimers(elapsedTime: number): void

    updateTimers

    • updateTimers(elapsedTime: number): void

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []
    +

    Returns void

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []

    Global container for unused forces, avoiding recreating forces each tick.

    -
    static

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number
      • +

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number

      • Get the squared distance, in pixels, between the center of this object and a position.

        Parameters

        • targetX: number

          Target X position

        • targetY: number

          Target Y position

          -

        Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • +

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • Get the number of children from a variable

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The number of children

        -

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

      • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The value of the specified variable

        -

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

      • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns string

        The string of the specified variable

        -

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null
    +

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null

    A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

    -

    persistentUuid

    persistentUuid: null | string = null
    +

    persistentUuid

    persistentUuid: null | string = null

    An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

    -

    pick

    pick: boolean = false
    +

    pick

    pick: boolean = false

    A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

    -

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

      • Return the variable passed as argument without any change. Only for usage by events.

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns Variable

        The specified variable

        -

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void
      • +

      Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void

      • Shortcut to set the value of a variable considered as a number

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: number

          The value to be set

          -

        Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void
      • +

      Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void

      • Shortcut to set the value of a variable considered as a string

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: string

          The value to be set

          -

        Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • +

      Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable
          +

          Parameters

          • array: Variable
          • value: string | number | boolean

          Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable

          The variable to be tested

        • childName: string

          The name of the child

          -

        Returns boolean

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

      • static

        Parameters

        • variable: Variable

          The variable to be cleared

          -

        Returns void

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

        • variable: Variable

          The variable to be changed

        • childName: string

          The name of the child

          -

        Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    Private opacity

    opacity: number = 255

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

        Parameters

        Returns boolean

    Private opacity

    opacity: number = 255

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • +

      Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Constructors

    constructor

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class TextRuntimeObject

    Displays a text.

    -

    Hierarchy

    Implements

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    Hierarchy

    Implements

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    addEffect

    • addEffect(effectData: EffectData): boolean

    Returns void

    addEffect

    • addEffect(effectData: EffectData): boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    Returns boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    • Add a force to the object to move it.

      Parameters

      • x: number

        The x coordinates of the force

        @@ -18,7 +18,7 @@

        The y coordinates of the force

      • multiplier: number

        Set the force multiplier

        -

      Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    Returns void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    Returns void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    • Create the behavior described by the given BehaviorData

      Parameters

      • behaviorData: BehaviorData

        The data to be used to construct the behavior.

      Returns boolean

      true if the behavior was properly created, false otherwise.

      -

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns boolean

    true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

    -

    behaviorActivated

    • behaviorActivated(name: string): boolean

    behaviorActivated

    • behaviorActivated(name: string): boolean

    clearEffects

    • clearEffects(): boolean

    clearEffects

    • clearEffects(): boolean

    clearForces

    • clearForces(): void

    clearForces

    • clearForces(): void

    Static collisionTest

    Static collisionTest

    • Return true if the hitboxes of two objects are overlapping

      static

      Parameters

      • obj1: RuntimeObject

        The first runtimeObject

        @@ -78,67 +78,67 @@
      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if obj1 and obj2 are in collision

      -

    cursorOnObject

    cursorOnObject

    deleteFromScene

    deleteFromScene

    Static distanceTest

    Returns void

    Static distanceTest

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    Returns void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    • Get the AABB (axis aligned bounding box) for the object.

      The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

      You should probably redefine updateAABB instead of this function.

      Returns AABB

      The bounding box

      -

    getAABBBottom

    • getAABBBottom(): number

    getAABBBottom

    • getAABBBottom(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBRight

    • getAABBRight(): number

    getAABBRight

    • getAABBRight(): number

    getAABBTop

    • getAABBTop(): number

    getAABBTop

    • getAABBTop(): number

    getAngle

    • getAngle(): number

    getAngle

    • getAngle(): number

    getAngleToObject

    getAngleToObject

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    Returns number

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    getAverageForce

    Returns number

    getAverageForce

    getBehavior

    getBehavior

    • Get a behavior from its name. If the behavior does not exists, undefined is returned.

      Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -146,63 +146,63 @@

      Parameters

      • name: string

        The behavior name.

      Returns null | RuntimeBehavior

      The behavior with the given name, or undefined.

      -

    getCenterX

    • getCenterX(): number

    getCenterX

    • getCenterX(): number

    • Return the X position of the object center, relative to the object X position (getDrawableX). Use getCenterXInScene to get the position of the center in the scene.

      Returns number

      the X position of the object center, relative to getDrawableX().

      -

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterY

    • getCenterY(): number

    getCenterY

    • getCenterY(): number

    • Return the Y position of the object center, relative to the object position (getDrawableY). Use getCenterYInScene to get the position of the center in the scene.

      Returns number

      the Y position of the object center, relative to getDrawableY().

      -

    getCenterYInScene

    • getCenterYInScene(): number

    getCenterYInScene

    • getCenterYInScene(): number

    getCharacterSize

    • getCharacterSize(): number

    getCharacterSize

    • getCharacterSize(): number

    getColor

    • getColor(): string

    getColor

    • getColor(): string

    getDistanceToObject

    getDistanceToObject

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    getDrawableX

    • getDrawableX(): number

    Returns number

    getDrawableX

    • getDrawableX(): number

    • Get the X position of the rendered object.

      For most objects, this will returns the same value as getX(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableX will differ.

      Returns number

      The X position of the rendered object.

      -

    getDrawableY

    • getDrawableY(): number

    getDrawableY

    • getDrawableY(): number

    • Get the Y position of the rendered object.

      For most objects, this will returns the same value as getY(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableY will differ.

      Returns number

      The Y position of the rendered object.

      -

    getElapsedTime

    getElapsedTime

    getHeight

    • getHeight(): number

    Returns number

    getHeight

    • getHeight(): number

    getHitBoxes

    getHitBoxes

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    • Return at least all the hit boxes that overlap a given area.

      The hit boxes don't need to actually overlap the area, (i.e: it's correct to return more hit boxes than those in the specified area) @@ -227,211 +227,211 @@

    • bottom: number

      bound of the area in scene coordinates

    Returns Iterable<Polygon>

    at least all the hit boxes that overlap a given area.

    -

    getInstanceContainer

    getInstanceContainer

    getLayer

    • getLayer(): string

    getLayer

    • getLayer(): string

    getName

    • getName(): string

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    • Get the identifier associated to an object name. Some features may want to compare objects name a large number of time. In this case, it may be more efficient to compare objects name identifiers.

      -
      static

      Parameters

      • name: string

      Returns number

    getNetworkSyncData

    getNetworkSyncData

    getOpacity

    • getOpacity(): number

    getOpacity

    • getOpacity(): number

    getOutlineThickness

    • getOutlineThickness(): number

    getOutlineThickness

    • getOutlineThickness(): number

    getPadding

    • getPadding(): number

    getPadding

    • getPadding(): number

    getParent

    getParent

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererObject

    • getRendererObject(): Text

    getRuntimeScene

    getRendererObject

    • getRendererObject(): Text

    getRuntimeScene

    getScale

    • getScale(): number

    getScale

    • getScale(): number

    • Get the scale of the object (or the geometric mean of the X and Y scale in case they are different).

      Returns number

      the scale of the object (or the geometric mean of the X and Y scale in case they are different).

      -

    getScaleMean

    • getScaleMean(): number

    getScaleMean

    • getScaleMean(): number

    • Get the scale of the object (or the arithmetic mean of the X and Y scale in case they are different).

      deprecated

      Use getScale instead.

      Returns number

      the scale of the object (or the arithmetic mean of the X and Y scale in case they are different).

      -

    getScaleX

    • getScaleX(): number

    getScaleX

    • getScaleX(): number

    getScaleY

    • getScaleY(): number

    getScaleY

    • getScaleY(): number

    getShadowAngle

    • getShadowAngle(): number

    getShadowAngle

    • getShadowAngle(): number

    getShadowBlurRadius

    • getShadowBlurRadius(): number

    getShadowBlurRadius

    • getShadowBlurRadius(): number

    getShadowDistance

    • getShadowDistance(): number

    getShadowDistance

    • getShadowDistance(): number

    getShadowOpacity

    • getShadowOpacity(): number

    getShadowOpacity

    • getShadowOpacity(): number

    getSqDistanceToObject

    getSqDistanceToObject

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    getString

    • getString(): string

    Returns number

    getString

    • getString(): string

    getText

    • getText(): string

    getText

    • getText(): string

    getTextAlignment

    • getTextAlignment(): string

    getTextAlignment

    • getTextAlignment(): string

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    • Get a timer elapsed time.

      This is used by expressions to return 0 when a timer doesn't exist because numeric expressions must always return a number.

      Parameters

      • timerName: string

        The timer name.

      Returns number

      The timer elapsed time in seconds, 0 if the timer doesn't exist.

      -

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getUniqueId

    • getUniqueId(): number

    getUniqueId

    • getUniqueId(): number

    • Get the unique identifier of the object.
      The identifier is set by the runtimeScene owning the object.
      You can also use the id property (this._object.id) for increased efficiency instead of calling this method.

      Returns number

      The object identifier

      -

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableString

    • getVariableString(variable: Variable): string

    Static getVariableString

    • getVariableString(variable: Variable): string

    getVariables

    getVariables

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    • Get the AABB (axis aligned bounding box) to be used to determine if the object is visible on screen. The gdjs.RuntimeScene will hide the renderer object if the object is not visible on screen ("culling").

      The default implementation uses the AABB returned by getAABB.

      If null is returned, the object is assumed to be always visible.

      Returns null | AABB

      The bounding box or null.

      -

    getWidth

    • getWidth(): number

    getWidth

    • getWidth(): number

    getWrappingWidth

    • getWrappingWidth(): number

    getWrappingWidth

    • getWrappingWidth(): number

    getX

    • getX(): number

    getX

    • getX(): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    • Compute the X position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getY

    • getY(): number

    Returns number

    getY

    • getY(): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    • Compute the Y position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getZOrder

    • getZOrder(): number

    Returns number

    getZOrder

    • getZOrder(): number

    hasBehavior

    • hasBehavior(name: string): boolean

    hasBehavior

    • hasBehavior(name: string): boolean

    hasEffect

    • hasEffect(name: string): boolean

    Returns boolean

    hasEffect

    • hasEffect(name: string): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hide

    • hide(enable: boolean): void

    hide

    • hide(enable: boolean): void

    insideObject

    • insideObject(x: number, y: number): boolean

    Returns void

    insideObject

    • insideObject(x: number, y: number): boolean

    • Return true if the specified position is inside object bounding box.

      The position should be in "world" coordinates, i.e use gdjs.Layer.convertCoords if you need to pass the mouse or a touch position that you get from gdjs.InputManager. To check if a point is inside the object collision mask, you can use isCollidingWithPoint instead.

      -

      Parameters

      • x: number
      • y: number

      Returns boolean

    invalidateHitboxes

    • invalidateHitboxes(): void

    invalidateHitboxes

    • invalidateHitboxes(): void

    isBold

    • isBold(): boolean

    isBold

    • isBold(): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isHidden

    • isHidden(): boolean

    isHidden

    • isHidden(): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isItalic

    • isItalic(): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isItalic

    • isItalic(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isOutlineEnabled

    • isOutlineEnabled(): boolean

    isShadowEnabled

    • isShadowEnabled(): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    isOutlineEnabled

    • isOutlineEnabled(): boolean

    isShadowEnabled

    • isShadowEnabled(): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    • Return true if the angle of the total force applied on the object is in a given range.

      Parameters

      • angle: number
        @@ -440,45 +440,45 @@

        The maximum distance from the given angle.

      Returns boolean

      true if the difference between the force angle the given angle is less or equals the toleranceInDegrees.

      -

    isVisible

    • isVisible(): boolean

    isVisible

    • isVisible(): boolean

    • Return true if the object is not hidden.

      Note: This is unrelated to the actual visibility of the object on the screen. For this, see getVisibilityAABB to get the bounding boxes of the object as displayed on the scene.

      Returns boolean

      true if the object is not hidden.

      -

    isWrapping

    • isWrapping(): boolean

    isWrapping

    • isWrapping(): boolean

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    • To be called by the child classes in their constructor, at the very end. Notify the behaviors that they have been constructed (this must be done when the object is ready, otherwise behaviors can do operations on the object which could be not initialized yet).

      If you redefine this function, make sure to call the original method (RuntimeObject.prototype.onCreated.call(this);).

      -

      Returns void

    onDeletedFromScene

    onDeletedFromScene

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    Returns void

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    onSceneResumed

    Returns void

    onSceneResumed

    pauseTimer

    • pauseTimer(timerName: string): void

    Returns void

    pauseTimer

    • pauseTimer(timerName: string): void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    Returns void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    • Put the object around a position, with a specific distance and angle. The distance and angle are computed between the position and the center of the object.

      Parameters

      • x: number
        @@ -489,7 +489,7 @@

        The distance between the object and the target, in pixels.

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    • Put the object around another object, with a specific distance and angle. The distance and angle are computed between the centers of the objects.

      Parameters

      • obj: null | RuntimeObject
        @@ -498,7 +498,7 @@

        The distance between the object and the target

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    • Called to reset the object to its default state. This is used for objects that are "recycled": they are dismissed (at which point onDestroyFromScene is called) but still stored in a cache to be reused next time an object must be created. At this point, @@ -524,7 +524,7 @@

    • The _runtimeScene, _nameId, name and type are guaranteed to stay the same and do not need to be set again.
    -

    Parameters

    Returns void

    removeBehavior

    removeBehavior

    removeEffect

    removeEffect

    removeTimer

    Returns boolean

    removeTimer

    resetTimer

    Returns void

    resetTimer

    Static returnVariable

    Returns void

    Static returnVariable

    rotate

    rotate

    rotateTowardAngle

    rotateTowardAngle

    rotateTowardPosition

    separateFromObjects

    Returns void

    rotateTowardPosition

    separateFromObjects

    separateFromObjectsList

    separateFromObjectsList

    separateObjectsWithForces

    separateObjectsWithForces

    separateObjectsWithoutForces

    separateObjectsWithoutForces

    setAngle

    Returns void

    setAngle

    setBold

    Returns void

    setBold

    setCenterPositionInScene

    Returns void

    setCenterPositionInScene

    setCenterXInScene

    Returns void

    setCenterXInScene

    setCenterYInScene

    Returns void

    setCenterYInScene

    setCharacterSize

    setCharacterSize

    setColor

    Returns void

    setColor

    setEffectBooleanParameter

    setEffectBooleanParameter

    setEffectDoubleParameter

    Returns boolean

    setEffectDoubleParameter

    setEffectStringParameter

    Returns boolean

    setEffectStringParameter

    setFontName

    Returns boolean

    setFontName

    setGradient

    Returns void

    setGradient

    setHeight

    Returns void

    setHeight

    setIncludedInParentCollisionMask

    setItalic

    Returns void

    setIncludedInParentCollisionMask

    setItalic

    setLayer

    Returns void

    setLayer

    setOpacity

    Returns void

    setOpacity

    setOutline

    setOutline

    setOutlineColor

    Returns void

    setOutlineColor

    setOutlineEnabled

    setOutlineThickness

    Returns void

    setOutlineEnabled

    setOutlineThickness

    setPadding

    Returns void

    setPadding

    setPosition

    Returns void

    setPosition

    setScale

    Returns void

    setScale

    setScaleX

    Returns void

    setScaleX

    setScaleY

    Returns void

    setScaleY

    setShadow

    Returns void

    setShadow

    setShadowAngle

    Returns void

    setShadowAngle

    setShadowBlurRadius

    Returns void

    setShadowBlurRadius

    setShadowColor

    Returns void

    setShadowColor

    setShadowDistance

    Returns void

    setShadowDistance

    setShadowOpacity

    Returns void

    setShadowOpacity

    setString

    Returns void

    setString

    setText

    Returns void

    setText

    setTextAlignment

    Returns void

    setTextAlignment

    Static setVariableNumber

    Returns void

    Static setVariableNumber

    Static setVariableString

    Returns void

    Static setVariableString

    setWidth

    Returns void

    setWidth

    setWrapping

    Returns void

    setWrapping

    setWrappingWidth

    Returns void

    setWrappingWidth

    setX

    Returns void

    setX

    setY

    setY

    setZOrder

    setZOrder

    showShadow

    Returns void

    showShadow

    stepBehaviorsPostEvents

    Returns void

    stepBehaviorsPostEvents

    stepBehaviorsPreEvents

    stepBehaviorsPreEvents

    timerElapsedTime

    timerElapsedTime

    timerPaused

    timerPaused

    unpauseTimer

    unpauseTimer

    unregisterDestroyCallback

    update

    Returns void

    unregisterDestroyCallback

    update

    updateAABB

    updateAABB

    updateAllEffectParameters

    updateAllEffectParameters

    updateForces

    Returns boolean

    updateForces

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    updateFromObjectData

    updateFromObjectData

    updateHitBoxes

    updateHitBoxes

    updatePreRender

    updatePreRender

    updateTimers

    Returns void

    updateTimers

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []
    +

    Returns void

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []

    Global container for unused forces, avoiding recreating forces each tick.

    -
    static

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number
      • +

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number

      • Get the squared distance, in pixels, between the center of this object and a position.

        Parameters

        • targetX: number

          Target X position

        • targetY: number

          Target Y position

          -

        Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • +

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • Get the number of children from a variable

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The number of children

        -

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

      • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The value of the specified variable

        -

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

      • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns string

        The string of the specified variable

        -

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null
    +

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null

    A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

    -

    opacity

    opacity: number = 255

    persistentUuid

    persistentUuid: null | string = null
    +

    opacity

    opacity: number = 255

    persistentUuid

    persistentUuid: null | string = null

    An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

    -

    pick

    pick: boolean = false
    +

    pick

    pick: boolean = false

    A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

    -

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

      • Return the variable passed as argument without any change. Only for usage by events.

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns Variable

        The specified variable

        -

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void
      • +

      Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void

      • Shortcut to set the value of a variable considered as a number

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: number

          The value to be set

          -

        Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void
      • +

      Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void

      • Shortcut to set the value of a variable considered as a string

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: string

          The value to be set

          -

        Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • +

      Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable
          +

          Parameters

          • array: Variable
          • value: string | number | boolean

          Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable

          The variable to be tested

        • childName: string

          The name of the child

          -

        Returns boolean

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

      • static

        Parameters

        • variable: Variable

          The variable to be cleared

          -

        Returns void

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

        • variable: Variable

          The variable to be changed

        • childName: string

          The name of the child

          -

        Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • +

      Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Constructors

    constructor

    Constructors

    constructor

    • Parameters

      • instanceContainer: RuntimeInstanceContainer

        The container the object belongs to.

      • textObjectData: TextObjectData

        The initial properties of the object

        diff --git a/GDJS Runtime Documentation/classes/gdjs.TileMap.TileMapCollisionMaskRenderer.html b/GDJS Runtime Documentation/classes/gdjs.TileMap.TileMapCollisionMaskRenderer.html index 5519f035e..514204c29 100644 --- a/GDJS Runtime Documentation/classes/gdjs.TileMap.TileMapCollisionMaskRenderer.html +++ b/GDJS Runtime Documentation/classes/gdjs.TileMap.TileMapCollisionMaskRenderer.html @@ -1,7 +1,7 @@ TileMapCollisionMaskRenderer | GDevelop JavaScript game engine
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class TileMapCollisionMaskRenderer

        This render is only useful for debugging purposes.

        see

        {@link PixiTileMapHelper.updatePixiCollisionMask}, the render used by the GUI.

        -

        Hierarchy

        • TileMapCollisionMaskRenderer

        Index

        Constructors

        Methods

        Constructors

        constructor

        Methods

        getRendererObject

        • getRendererObject(): Graphics

        redrawCollisionMask

        • redrawCollisionMask(): void

        Legend

        • Constructor
        • Method

        Settings

        Theme

        Generated using TypeDoc

        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Class TransformedCollisionTileMap

        A tile map transformed with an affine transformation.

        see

        getHitboxesAround It gives a fast access to hitboxes for collision handling.

        -

        Hierarchy

        • TransformedCollisionTileMap

        Index

        Constructors

        Methods

        Properties

        Constructors

        constructor

        Hierarchy

        • TransformedCollisionTileMap

        Index

        Constructors

        Methods

        Properties

        Constructors

        constructor

        Methods

        getAllHitboxes

        • getAllHitboxes(tag: string): Iterable<Polygon>

        Methods

        getAllHitboxes

        • getAllHitboxes(tag: string): Iterable<Polygon>

        getDimensionX

        • getDimensionX(): number

        getDimensionY

        • getDimensionY(): number

        getHeight

        • getHeight(): number

        getHitboxes

        • getHitboxes(tag: string, xMin: number, yMin: number, xMax: number, yMax: number): Iterable<Polygon>

        getDimensionX

        • getDimensionX(): number

        getDimensionY

        • getDimensionY(): number

        getHeight

        • getHeight(): number

        getHitboxes

        • getHitboxes(tag: string, xMin: number, yMin: number, xMax: number, yMax: number): Iterable<Polygon>

        getHitboxesAround

        • getHitboxesAround(tag: string, left: number, top: number, right: number, bottom: number): Iterable<Polygon>

        getHitboxesAround

        • getHitboxesAround(tag: string, left: number, top: number, right: number, bottom: number): Iterable<Polygon>
        • see

          {@link gdjs.RuntimeObject.getHitboxesAround}

          Parameters

          • tag: string

            The tile tag.

          • left: number
            @@ -34,19 +34,19 @@

            The left border of the area in the scene.

          Returns Iterable<Polygon>

          At least all the hitboxes from the given area where tiles have the right tag.

          -

        getLayer

        getLayer

        getLayers

        getTileDefinition

        • getTileDefinition(tileId: number): undefined | TileDefinition

        getLayers

        getTileDefinition

        • getTileDefinition(tileId: number): undefined | TileDefinition

        getTileHeight

        • getTileHeight(): number

        getTileWidth

        • getTileWidth(): number

        getTransformation

        getTileHeight

        • getTileHeight(): number

        getTileWidth

        • getTileWidth(): number

        getTransformation

        getWidth

        • getWidth(): number

        pointIsInsideTile

        • pointIsInsideTile(x: number, y: number, tag: string): boolean

        getWidth

        • getWidth(): number

        pointIsInsideTile

        • pointIsInsideTile(x: number, y: number, tag: string): boolean

        Returns boolean

        true when the point is inside a tile with a given tag.

        -

    setTransformation

    setTransformation

    Properties

    tag

    tag: string

    Static Private Readonly workingPoint

    workingPoint: FloatPoint = ...
    +

    Returns void

    Properties

    tag

    tag: string

    Static Private Readonly workingPoint

    workingPoint: FloatPoint = ...

    An reusable Point to avoid allocations.

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class TransformedCollisionTileMapLayer

    A tile map layer transformed with an affine transformation.

    -

    Hierarchy

    • TransformedCollisionTileMapLayer

    Index

    Constructors

    Methods

    Properties

    Constructors

    constructor

    Hierarchy

    • TransformedCollisionTileMapLayer

    Index

    Constructors

    Methods

    Properties

    Constructors

    constructor

    Methods

    get

    • get(x: number, y: number): undefined | TransformedCollisionTile

    Methods

    get

    • get(x: number, y: number): undefined | TransformedCollisionTile

    getAllHitboxes

    • getAllHitboxes(tag: string): Iterable<Polygon>

    getAllHitboxes

    • getAllHitboxes(tag: string): Iterable<Polygon>

    getDimensionX

    • getDimensionX(): number

    getDimensionX

    • getDimensionX(): number

    getDimensionY

    • getDimensionY(): number

    getDimensionY

    • getDimensionY(): number

    getHeight

    • getHeight(): number

    getHitboxes

    • getHitboxes(tag: string, xMin: number, yMin: number, xMax: number, yMax: number): Iterable<Polygon>

    getHeight

    • getHeight(): number

    getHitboxes

    • getHitboxes(tag: string, xMin: number, yMin: number, xMax: number, yMax: number): Iterable<Polygon>

    getWidth

    • getWidth(): number

    isFlippedDiagonally

    • isFlippedDiagonally(x: number, y: number): boolean

    getWidth

    • getWidth(): number

    isFlippedDiagonally

    • isFlippedDiagonally(x: number, y: number): boolean

    isFlippedHorizontally

    • isFlippedHorizontally(x: number, y: number): boolean

    isFlippedHorizontally

    • isFlippedHorizontally(x: number, y: number): boolean

    isFlippedVertically

    • isFlippedVertically(x: number, y: number): boolean

    isFlippedVertically

    • isFlippedVertically(x: number, y: number): boolean

    Properties

    Readonly tileMap

    tileMap: TransformedCollisionTileMap
    +

    Properties

    Readonly tileMap

    tileMap: TransformedCollisionTileMap

    The time map that contains this layer.

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class TileMapCollisionMaskRuntimeObject

    An object that handle hitboxes for a tile map.

    -

    Hierarchy

    Implements

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    Hierarchy

    Implements

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    addEffect

    • addEffect(effectData: EffectData): boolean

    Returns void

    addEffect

    • addEffect(effectData: EffectData): boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    Returns boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    • Add a force to the object to move it.

      Parameters

      • x: number

        The x coordinates of the force

        @@ -18,7 +18,7 @@

        The y coordinates of the force

      • multiplier: number

        Set the force multiplier

        -

      Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    Returns void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    Returns void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    • Create the behavior described by the given BehaviorData

      Parameters

      • behaviorData: BehaviorData

        The data to be used to construct the behavior.

      Returns boolean

      true if the behavior was properly created, false otherwise.

      -

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns boolean

    true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

    -

    behaviorActivated

    • behaviorActivated(name: string): boolean

    behaviorActivated

    • behaviorActivated(name: string): boolean

    clearEffects

    • clearEffects(): boolean

    clearEffects

    • clearEffects(): boolean

    clearForces

    • clearForces(): void

    clearForces

    • clearForces(): void

    Static collisionTest

    Static collisionTest

    • Return true if the hitboxes of two objects are overlapping

      static

      Parameters

      • obj1: RuntimeObject

        The first runtimeObject

        @@ -78,68 +78,68 @@
      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if obj1 and obj2 are in collision

      -

    cursorOnObject

    cursorOnObject

    deleteFromScene

    deleteFromScene

    Static distanceTest

    Returns void

    Static distanceTest

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: any): void

    Returns void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: any): void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    • Get the AABB (axis aligned bounding box) for the object.

      The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

      You should probably redefine updateAABB instead of this function.

      Returns AABB

      The bounding box

      -

    getAABBBottom

    • getAABBBottom(): number

    getAABBBottom

    • getAABBBottom(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBRight

    • getAABBRight(): number

    getAABBRight

    • getAABBRight(): number

    getAABBTop

    • getAABBTop(): number

    getAABBTop

    • getAABBTop(): number

    getAngle

    • getAngle(): number

    getAngle

    • getAngle(): number

    getAngleToObject

    getAngleToObject

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    Returns number

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    getAverageForce

    Returns number

    getAverageForce

    getBehavior

    getBehavior

    • Get a behavior from its name. If the behavior does not exists, undefined is returned.

      Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -147,57 +147,57 @@

      Parameters

      • name: string

        The behavior name.

      Returns null | RuntimeBehavior

      The behavior with the given name, or undefined.

      -

    getCenterX

    • getCenterX(): number

    getCenterX

    • getCenterX(): number

    • Return the X position of the object center, relative to the object X position (getDrawableX). Use getCenterXInScene to get the position of the center in the scene.

      Returns number

      the X position of the object center, relative to getDrawableX().

      -

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterY

    • getCenterY(): number

    getCenterY

    • getCenterY(): number

    • Return the Y position of the object center, relative to the object position (getDrawableY). Use getCenterYInScene to get the position of the center in the scene.

      Returns number

      the Y position of the object center, relative to getDrawableY().

      -

    getCenterYInScene

    • getCenterYInScene(): number

    getCenterYInScene

    • getCenterYInScene(): number

    getDebugMode

    • getDebugMode(): boolean

    getDistanceToObject

    getDebugMode

    • getDebugMode(): boolean

    getDistanceToObject

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    getDrawableX

    • getDrawableX(): number

    Returns number

    getDrawableX

    • getDrawableX(): number

    • Get the X position of the rendered object.

      For most objects, this will returns the same value as getX(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableX will differ.

      Returns number

      The X position of the rendered object.

      -

    getDrawableY

    • getDrawableY(): number

    getDrawableY

    • getDrawableY(): number

    • Get the Y position of the rendered object.

      For most objects, this will returns the same value as getY(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableY will differ.

      Returns number

      The Y position of the rendered object.

      -

    getElapsedTime

    getElapsedTime

    getFillColor

    • getFillColor(): number

    getFillOpacity

    • getFillOpacity(): number

    getHeight

    • getHeight(): number

    Returns number

    getFillColor

    • getFillColor(): number

    getFillOpacity

    • getFillOpacity(): number

    getHeight

    • getHeight(): number

    getHitBoxes

    getHitBoxes

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    Parameters

    Returns Iterable<Polygon>

    at least all the hit boxes that overlap a given area.

    -

    getInstanceContainer

    getInstanceContainer

    getLayer

    getLayer

    getName

    getName

    getNameId

    getNameId

    Static getNameIdentifier

    Static getNameIdentifier

    getNetworkSyncData

    getNetworkSyncData

    getOutlineColor

    getOutlineOpacity

    getOutlineSize

    getParent

    getOutlineColor

    getOutlineOpacity

    getOutlineSize

    getParent

    getRendererEffects

    getRendererEffects

    getRendererObject

    getRuntimeScene

    getRendererObject

    getRuntimeScene

    getScale

    getScale

    getScaleX

    getScaleX

    getScaleY

    getScaleY

    getSqDistanceToObject

    getSqDistanceToObject

    getSqDistanceToPosition

    Returns number

    getSqDistanceToPosition

    getTilemapJsonFile

    getTilesetJsonFile

    getTimerElapsedTimeInSeconds

    Returns number

    getTilemapJsonFile

    getTilesetJsonFile

    getTimerElapsedTimeInSeconds

    getTimerElapsedTimeInSecondsOrNaN

    getTimerElapsedTimeInSecondsOrNaN

    getUniqueId

    getUniqueId

    Static getVariableChildCount

    Static getVariableChildCount

    Static getVariableNumber

    Static getVariableNumber

    Static getVariableString

    Static getVariableString

    getVariables

    getVariables

    getVisibilityAABB

    getVisibilityAABB

    getWidth

    getWidth

    getX

    getX

    getXFromAngleAndDistance

    getXFromAngleAndDistance

    getY

    Returns number

    getY

    getYFromAngleAndDistance

    getYFromAngleAndDistance

    getZOrder

    Returns number

    getZOrder

    hasBehavior

    hasBehavior

    hasEffect

    Returns boolean

    hasEffect

    hasNoForces

    hasNoForces

    hasVariable

    hasVariable

    hide

    hide

    insideObject

    Returns void

    insideObject

    invalidateHitboxes

    invalidateHitboxes

    isCollidingWithPoint

    isCollidingWithPoint

    isEffectEnabled

    isEffectEnabled

    isHidden

    isHidden

    isIncludedInParentCollisionMask

    isOnLayer

    isIncludedInParentCollisionMask

    isOnLayer

    isTilemapJsonFile

    isTilesetJsonFile

    isTotalForceAngleAround

    isTilemapJsonFile

    isTilesetJsonFile

    isTotalForceAngleAround

    isVisible

    isVisible

    notifyBehaviorsObjectHotReloaded

    notifyBehaviorsObjectHotReloaded

    onCreated

    onCreated

    onDeletedFromScene

    onDeletedFromScene

    onDestroyed

    onScenePaused

    Returns void

    onDestroyed

    onScenePaused

    onSceneResumed

    Returns void

    onSceneResumed

    pauseTimer

    Returns void

    pauseTimer

    putAround

    Returns void

    putAround

    putAroundObject

    Returns void

    putAroundObject

    raycastTest

    raycastTest

    registerDestroyCallback

    reinitialize

    registerDestroyCallback

    reinitialize

    -

    Parameters

    Returns void

    removeBehavior

    removeBehavior

    removeEffect

    removeEffect

    removeTimer

    Returns boolean

    removeTimer

    resetTimer

    Returns void

    resetTimer

    Static returnVariable

    Returns void

    Static returnVariable

    rotate

    rotate

    rotateTowardAngle

    rotateTowardAngle

    rotateTowardPosition

    separateFromObjects

    Returns void

    rotateTowardPosition

    separateFromObjects

    separateFromObjectsList

    separateFromObjectsList

    separateObjectsWithForces

    separateObjectsWithForces

    separateObjectsWithoutForces

    separateObjectsWithoutForces

    setAngle

    Returns void

    setAngle

    setCenterPositionInScene

    setCenterPositionInScene

    setCenterXInScene

    Returns void

    setCenterXInScene

    setCenterYInScene

    Returns void

    setCenterYInScene

    setDebugMode

    setEffectBooleanParameter

    setDebugMode

    setEffectBooleanParameter

    setEffectDoubleParameter

    Returns boolean

    setEffectDoubleParameter

    setEffectStringParameter

    Returns boolean

    setEffectStringParameter

    setFillColor

    setFillOpacity

    setFillColor

    setFillOpacity

    setHeight

    Returns void

    setHeight

    setIncludedInParentCollisionMask

    setLayer

    setIncludedInParentCollisionMask

    setLayer

    setOutlineColor

    setOutlineOpacity

    setOutlineColor

    setOutlineOpacity

    setOutlineSize

    setPosition

    Returns void

    setOutlineSize

    setPosition

    setScale

    Returns void

    setScale

    setScaleX

    Returns void

    setScaleX

    setScaleY

    Returns void

    setScaleY

    setSize

    Returns void

    setSize

    setTilemapJsonFile

    setTilemapJsonFile

    setTilesetJsonFile

    Static setVariableNumber

    setTilesetJsonFile

    Static setVariableNumber

    Static setVariableString

    Returns void

    Static setVariableString

    setWidth

    Returns void

    setWidth

    setX

    setX

    setY

    setY

    setZOrder

    setZOrder

    stepBehaviorsPostEvents

    Returns void

    stepBehaviorsPostEvents

    stepBehaviorsPreEvents

    stepBehaviorsPreEvents

    timerElapsedTime

    timerElapsedTime

    timerPaused

    timerPaused

    unpauseTimer

    unpauseTimer

    unregisterDestroyCallback

    update

    Returns void

    unregisterDestroyCallback

    update

    updateAABB

    Returns void

    updateAABB

    updateAllEffectParameters

    updateAllEffectParameters

    updateForces

    Returns boolean

    updateForces

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    updateFromObjectData

    updateFromObjectData

    updateHitBoxes

    updateHitBoxes

    updatePreRender

    updatePreRender

    updateTimers

    updateTimers

    updateTransformation

    Returns void

    updateTransformation

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []
    +

    Returns void

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []

    Global container for unused forces, avoiding recreating forces each tick.

    -
    static

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number
      • +

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number

      • Get the squared distance, in pixels, between the center of this object and a position.

        Parameters

        • targetX: number

          Target X position

        • targetY: number

          Target Y position

          -

        Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • +

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • Get the number of children from a variable

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The number of children

        -

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

      • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The value of the specified variable

        -

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

      • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns string

        The string of the specified variable

        -

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null
    +

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null

    A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

    -

    persistentUuid

    persistentUuid: null | string = null
    +

    persistentUuid

    persistentUuid: null | string = null

    An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

    -

    pick

    pick: boolean = false
    +

    pick

    pick: boolean = false

    A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

    -

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

      • Return the variable passed as argument without any change. Only for usage by events.

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns Variable

        The specified variable

        -

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void
      • +

      Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void

      • Shortcut to set the value of a variable considered as a number

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: number

          The value to be set

          -

        Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void
      • +

      Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void

      • Shortcut to set the value of a variable considered as a string

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: string

          The value to be set

          -

        Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • +

      Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable
          +

          Parameters

          • array: Variable
          • value: string | number | boolean

          Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable

          The variable to be tested

        • childName: string

          The name of the child

          -

        Returns boolean

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

      • static

        Parameters

        • variable: Variable

          The variable to be cleared

          -

        Returns void

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

        • variable: Variable

          The variable to be changed

        • childName: string

          The name of the child

          -

        Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • +

      Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Constructors

    constructor

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class TileMapRuntimeObject

    Displays a Tilemap object (mapeditor.org supported).

    -

    Hierarchy

    Implements

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    Hierarchy

    Implements

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    addEffect

    • addEffect(effectData: EffectData): boolean

    Returns void

    addEffect

    • addEffect(effectData: EffectData): boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    Returns boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    • Add a force to the object to move it.

      Parameters

      • x: number

        The x coordinates of the force

        @@ -18,7 +18,7 @@

        The y coordinates of the force

      • multiplier: number

        Set the force multiplier

        -

      Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    Returns void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    Returns void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    • Create the behavior described by the given BehaviorData

      Parameters

      • behaviorData: BehaviorData

        The data to be used to construct the behavior.

      Returns boolean

      true if the behavior was properly created, false otherwise.

      -

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns boolean

    true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

    -

    behaviorActivated

    • behaviorActivated(name: string): boolean

    behaviorActivated

    • behaviorActivated(name: string): boolean

    clearEffects

    • clearEffects(): boolean

    clearEffects

    • clearEffects(): boolean

    clearForces

    • clearForces(): void

    clearForces

    • clearForces(): void

    Static collisionTest

    Static collisionTest

    • Return true if the hitboxes of two objects are overlapping

      static

      Parameters

      • obj1: RuntimeObject

        The first runtimeObject

        @@ -78,68 +78,68 @@
      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if obj1 and obj2 are in collision

      -

    cursorOnObject

    cursorOnObject

    deleteFromScene

    deleteFromScene

    Static distanceTest

    Returns void

    Static distanceTest

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: any): void

    Returns void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: any): void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    • Get the AABB (axis aligned bounding box) for the object.

      The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

      You should probably redefine updateAABB instead of this function.

      Returns AABB

      The bounding box

      -

    getAABBBottom

    • getAABBBottom(): number

    getAABBBottom

    • getAABBBottom(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBRight

    • getAABBRight(): number

    getAABBRight

    • getAABBRight(): number

    getAABBTop

    • getAABBTop(): number

    getAABBTop

    • getAABBTop(): number

    getAngle

    • getAngle(): number

    getAngle

    • getAngle(): number

    getAngleToObject

    getAngleToObject

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    Returns number

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    getAnimationFps

    • getAnimationFps(): number

    getAnimationSpeedScale

    • getAnimationSpeedScale(): number

    getAverageForce

    Returns number

    getAnimationFps

    • getAnimationFps(): number

    getAnimationSpeedScale

    • getAnimationSpeedScale(): number

    getAverageForce

    getBehavior

    getBehavior

    • Get a behavior from its name. If the behavior does not exists, undefined is returned.

      Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -147,59 +147,59 @@

      Parameters

      • name: string

        The behavior name.

      Returns null | RuntimeBehavior

      The behavior with the given name, or undefined.

      -

    getCenterX

    • getCenterX(): number

    getCenterX

    • getCenterX(): number

    • Return the X position of the object center, relative to the object X position (getDrawableX). Use getCenterXInScene to get the position of the center in the scene.

      Returns number

      the X position of the object center, relative to getDrawableX().

      -

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterY

    • getCenterY(): number

    getCenterY

    • getCenterY(): number

    • Return the Y position of the object center, relative to the object position (getDrawableY). Use getCenterYInScene to get the position of the center in the scene.

      Returns number

      the Y position of the object center, relative to getDrawableY().

      -

    getCenterYInScene

    • getCenterYInScene(): number

    getCenterYInScene

    • getCenterYInScene(): number

    getDisplayMode

    • getDisplayMode(): string

    getDistanceToObject

    getDisplayMode

    • getDisplayMode(): string

    getDistanceToObject

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    getDrawableX

    • getDrawableX(): number

    Returns number

    getDrawableX

    • getDrawableX(): number

    • Get the X position of the rendered object.

      For most objects, this will returns the same value as getX(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableX will differ.

      Returns number

      The X position of the rendered object.

      -

    getDrawableY

    • getDrawableY(): number

    getDrawableY

    • getDrawableY(): number

    • Get the Y position of the rendered object.

      For most objects, this will returns the same value as getY(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableY will differ.

      Returns number

      The Y position of the rendered object.

      -

    getElapsedTime

    getElapsedTime

    getHeight

    • getHeight(): number

    Returns number

    getHeight

    • getHeight(): number

    getHitBoxes

    getHitBoxes

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    • Return at least all the hit boxes that overlap a given area.

      The hit boxes don't need to actually overlap the area, (i.e: it's correct to return more hit boxes than those in the specified area) @@ -224,179 +224,179 @@

    • bottom: number

      bound of the area in scene coordinates

    Returns Iterable<Polygon>

    at least all the hit boxes that overlap a given area.

    -

    getInstanceContainer

    getInstanceContainer

    getLayer

    • getLayer(): string

    getLayer

    • getLayer(): string

    getLayerIndex

    • getLayerIndex(): number

    getLevelIndex

    • getLevelIndex(): number

    getName

    • getName(): string

    getLayerIndex

    • getLayerIndex(): number

    getLevelIndex

    • getLevelIndex(): number

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    • Get the identifier associated to an object name. Some features may want to compare objects name a large number of time. In this case, it may be more efficient to compare objects name identifiers.

      -
      static

      Parameters

      • name: string

      Returns number

    getNetworkSyncData

    getNetworkSyncData

    getOpacity

    • getOpacity(): number

    getOpacity

    • getOpacity(): number

    getParent

    getParent

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererObject

    • getRendererObject(): CompositeTilemap

    getRuntimeScene

    getRendererObject

    • getRendererObject(): CompositeTilemap

    getRuntimeScene

    getScale

    • getScale(): number

    getScale

    • getScale(): number

    getScaleX

    • getScaleX(): number

    getScaleX

    • getScaleX(): number

    getScaleY

    • getScaleY(): number

    getScaleY

    • getScaleY(): number

    getSqDistanceToObject

    getSqDistanceToObject

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    getTilemapJsonFile

    • getTilemapJsonFile(): string

    getTilesetJsonFile

    • getTilesetJsonFile(): string

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    Returns number

    getTilemapJsonFile

    • getTilemapJsonFile(): string

    getTilesetJsonFile

    • getTilesetJsonFile(): string

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    • Get a timer elapsed time.

      This is used by expressions to return 0 when a timer doesn't exist because numeric expressions must always return a number.

      Parameters

      • timerName: string

        The timer name.

      Returns number

      The timer elapsed time in seconds, 0 if the timer doesn't exist.

      -

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getUniqueId

    • getUniqueId(): number

    getUniqueId

    • getUniqueId(): number

    • Get the unique identifier of the object.
      The identifier is set by the runtimeScene owning the object.
      You can also use the id property (this._object.id) for increased efficiency instead of calling this method.

      Returns number

      The object identifier

      -

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableString

    • getVariableString(variable: Variable): string

    Static getVariableString

    • getVariableString(variable: Variable): string

    getVariables

    getVariables

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    • Get the AABB (axis aligned bounding box) to be used to determine if the object is visible on screen. The gdjs.RuntimeScene will hide the renderer object if the object is not visible on screen ("culling").

      The default implementation uses the AABB returned by getAABB.

      If null is returned, the object is assumed to be always visible.

      Returns null | AABB

      The bounding box or null.

      -

    getWidth

    • getWidth(): number

    getWidth

    • getWidth(): number

    getX

    • getX(): number

    getX

    • getX(): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    • Compute the X position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getY

    • getY(): number

    Returns number

    getY

    • getY(): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    • Compute the Y position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getZOrder

    • getZOrder(): number

    Returns number

    getZOrder

    • getZOrder(): number

    hasBehavior

    • hasBehavior(name: string): boolean

    hasBehavior

    • hasBehavior(name: string): boolean

    hasEffect

    • hasEffect(name: string): boolean

    Returns boolean

    hasEffect

    • hasEffect(name: string): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hide

    • hide(enable: boolean): void

    hide

    • hide(enable: boolean): void

    insideObject

    • insideObject(x: number, y: number): boolean

    Returns void

    insideObject

    • insideObject(x: number, y: number): boolean

    • Return true if the specified position is inside object bounding box.

      The position should be in "world" coordinates, i.e use gdjs.Layer.convertCoords if you need to pass the mouse or a touch position that you get from gdjs.InputManager. To check if a point is inside the object collision mask, you can use isCollidingWithPoint instead.

      -

      Parameters

      • x: number
      • y: number

      Returns boolean

    invalidateHitboxes

    • invalidateHitboxes(): void

    invalidateHitboxes

    • invalidateHitboxes(): void

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isDisplayMode

    • isDisplayMode(selectedDisplayMode: string): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isDisplayMode

    • isDisplayMode(selectedDisplayMode: string): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isHidden

    • isHidden(): boolean

    isHidden

    • isHidden(): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isTilemapJsonFile

    • isTilemapJsonFile(selectedTilemapJsonFile: string): boolean

    isTilesetJsonFile

    • isTilesetJsonFile(selectedTilesetJsonFile: string): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    isTilemapJsonFile

    • isTilemapJsonFile(selectedTilemapJsonFile: string): boolean

    isTilesetJsonFile

    • isTilesetJsonFile(selectedTilesetJsonFile: string): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    • Return true if the angle of the total force applied on the object is in a given range.

      Parameters

      • angle: number
        @@ -405,43 +405,43 @@

        The maximum distance from the given angle.

      Returns boolean

      true if the difference between the force angle the given angle is less or equals the toleranceInDegrees.

      -

    isVisible

    • isVisible(): boolean

    isVisible

    • isVisible(): boolean

    • Return true if the object is not hidden.

      Note: This is unrelated to the actual visibility of the object on the screen. For this, see getVisibilityAABB to get the bounding boxes of the object as displayed on the scene.

      Returns boolean

      true if the object is not hidden.

      -

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    • To be called by the child classes in their constructor, at the very end. Notify the behaviors that they have been constructed (this must be done when the object is ready, otherwise behaviors can do operations on the object which could be not initialized yet).

      If you redefine this function, make sure to call the original method (RuntimeObject.prototype.onCreated.call(this);).

      -

      Returns void

    onDeletedFromScene

    onDeletedFromScene

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    Returns void

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    onSceneResumed

    Returns void

    onSceneResumed

    pauseTimer

    • pauseTimer(timerName: string): void

    Returns void

    pauseTimer

    • pauseTimer(timerName: string): void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    Returns void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    • Put the object around a position, with a specific distance and angle. The distance and angle are computed between the position and the center of the object.

      Parameters

      • x: number
        @@ -452,7 +452,7 @@

        The distance between the object and the target, in pixels.

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    • Put the object around another object, with a specific distance and angle. The distance and angle are computed between the centers of the objects.

      Parameters

      • obj: null | RuntimeObject
        @@ -461,7 +461,7 @@

        The distance between the object and the target

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    • Called to reset the object to its default state. This is used for objects that are "recycled": they are dismissed (at which point onDestroyFromScene is called) but still stored in a cache to be reused next time an object must be created. At this point, @@ -487,7 +487,7 @@

    • The _runtimeScene, _nameId, name and type are guaranteed to stay the same and do not need to be set again.
    -

    Parameters

    Returns void

    removeBehavior

    removeBehavior

    removeEffect

    removeEffect

    removeTimer

    Returns boolean

    removeTimer

    resetTimer

    Returns void

    resetTimer

    Static returnVariable

    Returns void

    Static returnVariable

    rotate

    rotate

    rotateTowardAngle

    rotateTowardAngle

    rotateTowardPosition

    separateFromObjects

    Returns void

    rotateTowardPosition

    separateFromObjects

    separateFromObjectsList

    separateFromObjectsList

    separateObjectsWithForces

    separateObjectsWithForces

    separateObjectsWithoutForces

    separateObjectsWithoutForces

    setAngle

    Returns void

    setAngle

    setAnimationFps

    setAnimationSpeedScale

    setCenterPositionInScene

    setAnimationFps

    setAnimationSpeedScale

    setCenterPositionInScene

    setCenterXInScene

    Returns void

    setCenterXInScene

    setCenterYInScene

    Returns void

    setCenterYInScene

    setDisplayMode

    setEffectBooleanParameter

    setDisplayMode

    setEffectBooleanParameter

    setEffectDoubleParameter

    Returns boolean

    setEffectDoubleParameter

    setEffectStringParameter

    Returns boolean

    setEffectStringParameter

    setHeight

    Returns boolean

    setHeight

    setIncludedInParentCollisionMask

    setLayer

    setIncludedInParentCollisionMask

    setLayer

    setLayerIndex

    setLevelIndex

    setOpacity

    Returns void

    setLayerIndex

    setLevelIndex

    setOpacity

    setPosition

    setPosition

    setScale

    Returns void

    setScale

    setScaleX

    Returns void

    setScaleX

    setScaleY

    Returns void

    setScaleY

    setSize

    Returns void

    setSize

    setTilemapJsonFile

    setTilemapJsonFile

    setTilesetJsonFile

    Static setVariableNumber

    setTilesetJsonFile

    Static setVariableNumber

    Static setVariableString

    Returns void

    Static setVariableString

    setWidth

    Returns void

    setWidth

    setX

    setX

    setY

    setY

    setZOrder

    setZOrder

    stepBehaviorsPostEvents

    Returns void

    stepBehaviorsPostEvents

    stepBehaviorsPreEvents

    stepBehaviorsPreEvents

    timerElapsedTime

    timerElapsedTime

    timerPaused

    timerPaused

    unpauseTimer

    unpauseTimer

    unregisterDestroyCallback

    update

    Returns void

    unregisterDestroyCallback

    update

    updateAABB

    updateAABB

    updateAllEffectParameters

    updateAllEffectParameters

    updateForces

    Returns boolean

    updateForces

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    updateFromObjectData

    updateFromObjectData

    updateHitBoxes

    updateHitBoxes

    updatePreRender

    updatePreRender

    updateTimers

    Returns void

    updateTimers

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []
    +

    Returns void

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []

    Global container for unused forces, avoiding recreating forces each tick.

    -
    static

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number
      • +

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number

      • Get the squared distance, in pixels, between the center of this object and a position.

        Parameters

        • targetX: number

          Target X position

        • targetY: number

          Target Y position

          -

        Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • +

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • Get the number of children from a variable

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The number of children

        -

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

      • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The value of the specified variable

        -

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

      • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns string

        The string of the specified variable

        -

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null
    +

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null

    A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

    -

    persistentUuid

    persistentUuid: null | string = null
    +

    persistentUuid

    persistentUuid: null | string = null

    An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

    -

    pick

    pick: boolean = false
    +

    pick

    pick: boolean = false

    A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

    -

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

      • Return the variable passed as argument without any change. Only for usage by events.

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns Variable

        The specified variable

        -

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void
      • +

      Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void

      • Shortcut to set the value of a variable considered as a number

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: number

          The value to be set

          -

        Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void
      • +

      Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void

      • Shortcut to set the value of a variable considered as a string

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: string

          The value to be set

          -

        Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • +

      Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable
          +

          Parameters

          • array: Variable
          • value: string | number | boolean

          Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable

          The variable to be tested

        • childName: string

          The name of the child

          -

        Returns boolean

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

      • static

        Parameters

        • variable: Variable

          The variable to be cleared

          -

        Returns void

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

        • variable: Variable

          The variable to be changed

        • childName: string

          The name of the child

          -

        Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • +

      Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Constructors

    constructor

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class TileMapRuntimeObjectPixiRenderer

    The PIXI.js renderer for the Tile map runtime object.

    -

    Hierarchy

    • TileMapRuntimeObjectPixiRenderer

    Index

    Constructors

    Methods

    Constructors

    constructor

    Hierarchy

    • TileMapRuntimeObjectPixiRenderer

    Index

    Constructors

    Methods

    Constructors

    constructor

    Methods

    destroy

    • destroy(): void

    getHeight

    • getHeight(): number

    getRendererObject

    • getRendererObject(): CompositeTilemap

    getScaleX

    • getScaleX(): number

    getScaleY

    • getScaleY(): number

    getTileMapHeight

    • getTileMapHeight(): number

    getTileMapWidth

    • getTileMapWidth(): number

    getWidth

    • getWidth(): number

    incrementAnimationFrameX

    setHeight

    • setHeight(height: number): void

    setScaleX

    • setScaleX(scaleX: number): void

    setScaleY

    • setScaleY(scaleY: number): void

    setWidth

    • setWidth(width: number): void

    updateAngle

    • updateAngle(): void

    updateOpacity

    • updateOpacity(): void

    updatePixiTileMap

    • updatePixiTileMap(tileMap: EditableTileMap, textureCache: TileTextureCache): void

    updatePosition

    • updatePosition(): void

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class TiledSpriteRuntimeObject

    The TiledSpriteRuntimeObject displays a tiled texture.

    -

    Hierarchy

    Implements

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    Hierarchy

    Implements

    Index

    Methods

    Properties

    Constructors

    Methods

    activateBehavior

    • activateBehavior(name: string, enable: boolean): void

    addEffect

    • addEffect(effectData: EffectData): boolean

    Returns void

    addEffect

    • addEffect(effectData: EffectData): boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    Returns boolean

    addForce

    • addForce(x: number, y: number, multiplier: number): void

    • Add a force to the object to move it.

      Parameters

      • x: number

        The x coordinates of the force

        @@ -18,7 +18,7 @@

        The y coordinates of the force

      • multiplier: number

        Set the force multiplier

        -

      Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    Returns void

    addForceTowardObject

    • addForceTowardObject(object: null | RuntimeObject, len: number, multiplier: number): void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    Returns void

    addForceTowardPosition

    • addForceTowardPosition(x: number, y: number, len: number, multiplier: number): void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    Returns void

    addNewBehavior

    • addNewBehavior(behaviorData: BehaviorData): boolean

    • Create the behavior described by the given BehaviorData

      Parameters

      • behaviorData: BehaviorData

        The data to be used to construct the behavior.

      Returns boolean

      true if the behavior was properly created, false otherwise.

      -

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    addPolarForce

    • addPolarForce(angle: number, len: number, multiplier: number): void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns void

    averageForceAngleIs

    • averageForceAngleIs(angle: number, toleranceInDegrees: number): boolean

    Returns boolean

    true if the difference between the average angle of the forces and the angle parameter is inferior to toleranceInDegrees parameter.

    -

    behaviorActivated

    • behaviorActivated(name: string): boolean

    behaviorActivated

    • behaviorActivated(name: string): boolean

    clearEffects

    • clearEffects(): boolean

    clearEffects

    • clearEffects(): boolean

    clearForces

    • clearForces(): void

    clearForces

    • clearForces(): void

    Static collisionTest

    Static collisionTest

    • Return true if the hitboxes of two objects are overlapping

      static

      Parameters

      • obj1: RuntimeObject

        The first runtimeObject

        @@ -78,67 +78,67 @@
      • ignoreTouchingEdges: boolean

        If true, then edges that are touching each other, without the hitbox polygons actually overlapping, won't be considered in collision.

      Returns boolean

      true if obj1 and obj2 are in collision

      -

    cursorOnObject

    cursorOnObject

    deleteFromScene

    deleteFromScene

    Static distanceTest

    Returns void

    Static distanceTest

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    enableEffect

    • enableEffect(name: string, enable: boolean): void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    Returns void

    extraInitializationFromInitialInstance

    • extraInitializationFromInitialInstance(initialInstanceData: InstanceData): void

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    get3DRendererObject

    • get3DRendererObject(): undefined | null | Object3D<Object3DEventMap>

    getAABB

    • Get the AABB (axis aligned bounding box) for the object.

      The default implementation uses either the position/size of the object (when angle is 0) or hitboxes (when angle is not 0) to compute the bounding box. Result is cached until invalidated (by a position change, angle change...).

      You should probably redefine updateAABB instead of this function.

      Returns AABB

      The bounding box

      -

    getAABBBottom

    • getAABBBottom(): number

    getAABBBottom

    • getAABBBottom(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterX

    • getAABBCenterX(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBCenterY

    • getAABBCenterY(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBLeft

    • getAABBLeft(): number

    getAABBRight

    • getAABBRight(): number

    getAABBRight

    • getAABBRight(): number

    getAABBTop

    • getAABBTop(): number

    getAABBTop

    • getAABBTop(): number

    getAngle

    • getAngle(): number

    getAngle

    • getAngle(): number

    getAngleToObject

    getAngleToObject

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    Returns number

    getAngleToPosition

    • getAngleToPosition(targetX: number, targetY: number): number

    getAverageForce

    Returns number

    getAverageForce

    getBehavior

    getBehavior

    • Get a behavior from its name. If the behavior does not exists, undefined is returned.

      Never keep a reference to a behavior, as they can be hot-reloaded. Instead, @@ -146,62 +146,62 @@

      Parameters

      • name: string

        The behavior name.

      Returns null | RuntimeBehavior

      The behavior with the given name, or undefined.

      -

    getCenterX

    • getCenterX(): number

    getCenterX

    • getCenterX(): number

    • Return the X position of the object center, relative to the object X position (getDrawableX). Use getCenterXInScene to get the position of the center in the scene.

      Returns number

      the X position of the object center, relative to getDrawableX().

      -

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterXInScene

    • getCenterXInScene(): number

    getCenterY

    • getCenterY(): number

    getCenterY

    • getCenterY(): number

    • Return the Y position of the object center, relative to the object position (getDrawableY). Use getCenterYInScene to get the position of the center in the scene.

      Returns number

      the Y position of the object center, relative to getDrawableY().

      -

    getCenterYInScene

    • getCenterYInScene(): number

    getCenterYInScene

    • getCenterYInScene(): number

    getColor

    • getColor(): string

    getColor

    • getColor(): string

    getDistanceToObject

    getDistanceToObject

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getDistanceToPosition

    • getDistanceToPosition(targetX: number, targetY: number): number

    getDrawableX

    • getDrawableX(): number

    Returns number

    getDrawableX

    • getDrawableX(): number

    • Get the X position of the rendered object.

      For most objects, this will returns the same value as getX(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableX will differ.

      Returns number

      The X position of the rendered object.

      -

    getDrawableY

    • getDrawableY(): number

    getDrawableY

    • getDrawableY(): number

    • Get the Y position of the rendered object.

      For most objects, this will returns the same value as getY(). But if the object has an origin that is not the same as the point (0,0) of the object displayed, getDrawableY will differ.

      Returns number

      The Y position of the rendered object.

      -

    getElapsedTime

    getElapsedTime

    getHeight

    • getHeight(): number

    Returns number

    getHeight

    • getHeight(): number

    getHitBoxes

    getHitBoxes

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    getHitBoxesAround

    • getHitBoxesAround(left: number, top: number, right: number, bottom: number): Iterable<Polygon>

    • Return at least all the hit boxes that overlap a given area.

      The hit boxes don't need to actually overlap the area, (i.e: it's correct to return more hit boxes than those in the specified area) @@ -226,183 +226,183 @@

    • bottom: number

      bound of the area in scene coordinates

    Returns Iterable<Polygon>

    at least all the hit boxes that overlap a given area.

    -

    getInstanceContainer

    getInstanceContainer

    getLayer

    • getLayer(): string

    getLayer

    • getLayer(): string

    getName

    • getName(): string

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    Static getNameIdentifier

    • getNameIdentifier(name: string): number

    • Get the identifier associated to an object name. Some features may want to compare objects name a large number of time. In this case, it may be more efficient to compare objects name identifiers.

      -
      static

      Parameters

      • name: string

      Returns number

    getNetworkSyncData

    getNetworkSyncData

    getOpacity

    • getOpacity(): number

    getOpacity

    • getOpacity(): number

    getParent

    getParent

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererEffects

    • getRendererEffects(): Record<string, Filter>

    getRendererObject

    • getRendererObject(): TilingSprite

    getRuntimeScene

    getRendererObject

    • getRendererObject(): TilingSprite

    getRuntimeScene

    getScale

    • getScale(): number

    getScale

    • getScale(): number

    getScaleX

    • getScaleX(): number

    getScaleX

    • getScaleX(): number

    getScaleY

    • getScaleY(): number

    getScaleY

    • getScaleY(): number

    getSqDistanceToObject

    getSqDistanceToObject

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    Returns number

    getSqDistanceToPosition

    • getSqDistanceToPosition(targetX: number, targetY: number): number

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    Returns number

    getTimerElapsedTimeInSeconds

    • getTimerElapsedTimeInSeconds(timerName: string): number

    • Get a timer elapsed time.

      This is used by expressions to return 0 when a timer doesn't exist because numeric expressions must always return a number.

      Parameters

      • timerName: string

        The timer name.

      Returns number

      The timer elapsed time in seconds, 0 if the timer doesn't exist.

      -

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getTimerElapsedTimeInSecondsOrNaN

    • getTimerElapsedTimeInSecondsOrNaN(timerName: string): number

    getUniqueId

    • getUniqueId(): number

    getUniqueId

    • getUniqueId(): number

    • Get the unique identifier of the object.
      The identifier is set by the runtimeScene owning the object.
      You can also use the id property (this._object.id) for increased efficiency instead of calling this method.

      Returns number

      The object identifier

      -

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableNumber

    • getVariableNumber(variable: Variable): number

    Static getVariableString

    • getVariableString(variable: Variable): string

    Static getVariableString

    • getVariableString(variable: Variable): string

    getVariables

    getVariables

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    getVisibilityAABB

    • getVisibilityAABB(): null | AABB

    • Get the AABB (axis aligned bounding box) to be used to determine if the object is visible on screen. The gdjs.RuntimeScene will hide the renderer object if the object is not visible on screen ("culling").

      The default implementation uses the AABB returned by getAABB.

      If null is returned, the object is assumed to be always visible.

      Returns null | AABB

      The bounding box or null.

      -

    getWidth

    • getWidth(): number

    getWidth

    • getWidth(): number

    getX

    • getX(): number

    getX

    • getX(): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    getXFromAngleAndDistance

    • getXFromAngleAndDistance(angle: number, distance: number): number

    • Compute the X position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getXOffset

    • getXOffset(): number

    Returns number

    getXOffset

    • getXOffset(): number

    getY

    • getY(): number

    getY

    • getY(): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    getYFromAngleAndDistance

    • getYFromAngleAndDistance(angle: number, distance: number): number

    • Compute the Y position when given an angle and distance relative to the starting object. This is also known as getting the cartesian coordinates of a 2D vector, using its polar coordinates.

      Parameters

      • angle: number

        The angle, in degrees.

      • distance: number

        The distance from the object, in pixels

        -

      Returns number

    getYOffset

    • getYOffset(): number

    Returns number

    getYOffset

    • getYOffset(): number

    getZOrder

    • getZOrder(): number

    getZOrder

    • getZOrder(): number

    hasBehavior

    • hasBehavior(name: string): boolean

    hasBehavior

    • hasBehavior(name: string): boolean

    hasEffect

    • hasEffect(name: string): boolean

    Returns boolean

    hasEffect

    • hasEffect(name: string): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasNoForces

    • hasNoForces(): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hasVariable

    • hasVariable(name: string): boolean

    hide

    • hide(enable: boolean): void

    hide

    • hide(enable: boolean): void

    insideObject

    • insideObject(x: number, y: number): boolean

    Returns void

    insideObject

    • insideObject(x: number, y: number): boolean

    • Return true if the specified position is inside object bounding box.

      The position should be in "world" coordinates, i.e use gdjs.Layer.convertCoords if you need to pass the mouse or a touch position that you get from gdjs.InputManager. To check if a point is inside the object collision mask, you can use isCollidingWithPoint instead.

      -

      Parameters

      • x: number
      • y: number

      Returns boolean

    invalidateHitboxes

    • invalidateHitboxes(): void

    invalidateHitboxes

    • invalidateHitboxes(): void

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isCollidingWithPoint

    • isCollidingWithPoint(pointX: number, pointY: number): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isEffectEnabled

    • isEffectEnabled(name: string): boolean

    isHidden

    • isHidden(): boolean

    isHidden

    • isHidden(): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isIncludedInParentCollisionMask

    • isIncludedInParentCollisionMask(): boolean

    isOnLayer

    • isOnLayer(layer: string): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    isTotalForceAngleAround

    • isTotalForceAngleAround(angle: number, toleranceInDegrees: number): boolean

    • Return true if the angle of the total force applied on the object is in a given range.

      Parameters

      • angle: number
        @@ -411,43 +411,43 @@

        The maximum distance from the given angle.

      Returns boolean

      true if the difference between the force angle the given angle is less or equals the toleranceInDegrees.

      -

    isVisible

    • isVisible(): boolean

    isVisible

    • isVisible(): boolean

    • Return true if the object is not hidden.

      Note: This is unrelated to the actual visibility of the object on the screen. For this, see getVisibilityAABB to get the bounding boxes of the object as displayed on the scene.

      Returns boolean

      true if the object is not hidden.

      -

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    notifyBehaviorsObjectHotReloaded

    • notifyBehaviorsObjectHotReloaded(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    • To be called by the child classes in their constructor, at the very end. Notify the behaviors that they have been constructed (this must be done when the object is ready, otherwise behaviors can do operations on the object which could be not initialized yet).

      If you redefine this function, make sure to call the original method (RuntimeObject.prototype.onCreated.call(this);).

      -

      Returns void

    onDeletedFromScene

    onDeletedFromScene

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    Returns void

    onDestroyed

    • onDestroyed(): void

    onScenePaused

    onSceneResumed

    Returns void

    onSceneResumed

    pauseTimer

    • pauseTimer(timerName: string): void

    Returns void

    pauseTimer

    • pauseTimer(timerName: string): void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    Returns void

    putAround

    • putAround(x: number, y: number, distance: number, angleInDegrees: number): void

    • Put the object around a position, with a specific distance and angle. The distance and angle are computed between the position and the center of the object.

      Parameters

      • x: number
        @@ -458,7 +458,7 @@

        The distance between the object and the target, in pixels.

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    Returns void

    putAroundObject

    • putAroundObject(obj: null | RuntimeObject, distance: number, angleInDegrees: number): void

    • Put the object around another object, with a specific distance and angle. The distance and angle are computed between the centers of the objects.

      Parameters

      • obj: null | RuntimeObject
        @@ -467,7 +467,7 @@

        The distance between the object and the target

      • angleInDegrees: number

        The angle between the object and the target, in degrees.

        -

      Returns void

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    raycastTest

    • raycastTest(x: number, y: number, endX: number, endY: number, closest: boolean): RaycastTestResult

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    registerDestroyCallback

    • registerDestroyCallback(callback: () => void): void

    reinitialize

    • reinitialize(objectData: ObjectData): void

    • Called to reset the object to its default state. This is used for objects that are "recycled": they are dismissed (at which point onDestroyFromScene is called) but still stored in a cache to be reused next time an object must be created. At this point, @@ -493,7 +493,7 @@

    • The _runtimeScene, _nameId, name and type are guaranteed to stay the same and do not need to be set again.
    -

    Parameters

    Returns void

    removeBehavior

    removeBehavior

    removeEffect

    removeEffect

    removeTimer

    Returns boolean

    removeTimer

    resetTimer

    Returns void

    resetTimer

    Static returnVariable

    Returns void

    Static returnVariable

    rotate

    rotate

    rotateTowardAngle

    rotateTowardAngle

    rotateTowardPosition

    separateFromObjects

    Returns void

    rotateTowardPosition

    separateFromObjects

    separateFromObjectsList

    separateFromObjectsList

    separateObjectsWithForces

    separateObjectsWithForces

    separateObjectsWithoutForces

    separateObjectsWithoutForces

    setAngle

    Returns void

    setAngle

    setCenterPositionInScene

    Returns void

    setCenterPositionInScene

    setCenterXInScene

    Returns void

    setCenterXInScene

    setCenterYInScene

    Returns void

    setCenterYInScene

    setColor

    setColor

    setEffectBooleanParameter

    Returns void

    setEffectBooleanParameter

    setEffectDoubleParameter

    Returns boolean

    setEffectDoubleParameter

    setEffectStringParameter

    Returns boolean

    setEffectStringParameter

    setHeight

    Returns boolean

    setHeight

    setIncludedInParentCollisionMask

    setLayer

    Returns void

    setIncludedInParentCollisionMask

    setLayer

    setOpacity

    Returns void

    setOpacity

    setPosition

    setPosition

    setScale

    Returns void

    setScale

    setScaleX

    Returns void

    setScaleX

    setScaleY

    Returns void

    setScaleY

    setSize

    Returns void

    setSize

    setTexture

    Returns void

    setTexture

    Static setVariableNumber

    Returns void

    Static setVariableNumber

    Static setVariableString

    Returns void

    Static setVariableString

    setWidth

    Returns void

    setWidth

    setX

    Returns void

    setX

    setXOffset

    Returns void

    setXOffset

    setY

    Returns void

    setY

    setYOffset

    Returns void

    setYOffset

    setZOrder

    Returns void

    setZOrder

    stepBehaviorsPostEvents

    Returns void

    stepBehaviorsPostEvents

    stepBehaviorsPreEvents

    stepBehaviorsPreEvents

    timerElapsedTime

    timerElapsedTime

    timerPaused

    timerPaused

    unpauseTimer

    unpauseTimer

    unregisterDestroyCallback

    update

    Returns void

    unregisterDestroyCallback

    update

    updateAABB

    Returns void

    updateAABB

    updateAllEffectParameters

    updateAllEffectParameters

    updateForces

    Returns boolean

    updateForces

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    updateFromObjectData

    updateFromObjectData

    updateHitBoxes

    updateHitBoxes

    updatePreRender

    updatePreRender

    updateTimers

    Returns void

    updateTimers

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []
    +

    Returns void

    Properties

    angle

    angle: number = 0

    Static forcesGarbage

    forcesGarbage: Force[] = []

    Global container for unused forces, avoiding recreating forces each tick.

    -
    static

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

    getFirstVariableNumber

    getFirstVariableNumber: (array: Variable) => number = RuntimeObject.getFirstVariableNumber

    Type declaration

      • Shortcut to get the first value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

    Static getFirstVariableString

    getFirstVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

    getFirstVariableString

    getFirstVariableString: (array: Variable) => string = RuntimeObject.getFirstVariableString

    Type declaration

      • Shortcut to get the first value of an array variable as a string.

        -

        Parameters

        Returns string

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

    Static getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

    getLastVariableNumber

    getLastVariableNumber: (array: Variable) => number = RuntimeObject.getLastVariableNumber

    Type declaration

      • Shortcut to get the last value of an array variable as a number.

        -

        Parameters

        Returns number

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

    Static getLastVariableString

    getLastVariableString: (array: Variable) => string = ...

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

    getLastVariableString

    getLastVariableString: (array: Variable) => string = RuntimeObject.getLastVariableString

    Type declaration

      • Shortcut to get the last value of an array variable as a string.

        -

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number
      • +

        Parameters

        Returns string

    getSqDistanceTo

    getSqDistanceTo: (targetX: number, targetY: number) => number = RuntimeObject.prototype.getSqDistanceToPosition

    Type declaration

      • (targetX: number, targetY: number): number

      • Get the squared distance, in pixels, between the center of this object and a position.

        Parameters

        • targetX: number

          Target X position

        • targetY: number

          Target Y position

          -

        Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns number

    getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = RuntimeObject.getVariableBoolean

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • +

        Parameters

        Returns boolean

    getVariableChildCount

    getVariableChildCount: (variable: Variable) => number = RuntimeObject.getVariableChildCount

    Type declaration

      • Get the number of children from a variable

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The number of children

        -

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

    getVariableNumber

    getVariableNumber: (variable: Variable) => number = RuntimeObject.getVariableNumber

    Type declaration

      • Get the value of a variable considered as a number. Equivalent of variable.getAsNumber()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns number

        The value of the specified variable

        -

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

    getVariableString

    getVariableString: (variable: Variable) => string = RuntimeObject.getVariableString

    Type declaration

      • Get the value of a variable considered as a string. Equivalent of variable.getAsString()

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns string

        The string of the specified variable

        -

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null
    +

    hidden

    hidden: boolean = false

    Readonly id

    id: number

    layer

    layer: string = ''

    name

    name: string

    networkId

    networkId: null | string = null

    A network ID associated to the object to be used for multiplayer, to identify the object across peers. We don't use persistentUuid as it's only used for hot-reload. We don't use the object ID either as it's not unique across peers.

    -

    opacity

    opacity: number = 255

    persistentUuid

    persistentUuid: null | string = null
    +

    opacity

    opacity: number = 255

    persistentUuid

    persistentUuid: null | string = null

    An optional UUID associated to the object to be used for hot reload. Don't modify or use otherwise.

    -

    pick

    pick: boolean = false
    +

    pick

    pick: boolean = false

    A property to be used by external algorithms to indicate if the object is picked or not in an object selection. By construction, this is not "thread safe" or "re-entrant algorithm" safe.

    -

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

    returnVariable

    returnVariable: (variable: Variable) => Variable = RuntimeObject.returnVariable

    Type declaration

      • Return the variable passed as argument without any change. Only for usage by events.

        static

        Parameters

        • variable: Variable

          The variable to be accessed

        Returns Variable

        The specified variable

        -

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

    setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = RuntimeObject.setVariableBoolean

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void
      • +

      Returns void

    setVariableNumber

    setVariableNumber: (variable: Variable, newValue: number) => void = RuntimeObject.setVariableNumber

    Type declaration

      • (variable: Variable, newValue: number): void

      • Shortcut to set the value of a variable considered as a number

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: number

          The value to be set

          -

        Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void
      • +

      Returns void

    setVariableString

    setVariableString: (variable: Variable, newValue: string) => void = RuntimeObject.setVariableString

    Type declaration

      • (variable: Variable, newValue: string): void

      • Shortcut to set the value of a variable considered as a string

        Parameters

        • variable: Variable

          The variable to be changed

        • newValue: string

          The value to be set

          -

        Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • +

      Returns void

    Static supportsReinitialization

    supportsReinitialization: boolean = false

    toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = RuntimeObject.toggleVariableBoolean

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    type

    type: string

    valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = RuntimeObject.valuePush

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable
          +

          Parameters

          • array: Variable
          • value: string | number | boolean

          Returns void

    variableChildExists

    variableChildExists: (variable: Variable, childName: string) => boolean = RuntimeObject.variableChildExists

    Type declaration

      • (variable: Variable, childName: string): boolean
      • static

        Parameters

        • variable: Variable

          The variable to be tested

        • childName: string

          The name of the child

          -

        Returns boolean

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

    variableClearChildren

    variableClearChildren: (variable: Variable) => void = RuntimeObject.variableClearChildren

    Type declaration

      • static

        Parameters

        • variable: Variable

          The variable to be cleared

          -

        Returns void

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

    variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = RuntimeObject.variablePushCopy

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

    variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = RuntimeObject.variableRemoveAt

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

    variableRemoveChild

    variableRemoveChild: (variable: Variable, childName: string) => void = RuntimeObject.variableRemoveChild

    Type declaration

      • (variable: Variable, childName: string): void
      • static

        Parameters

        • variable: Variable

          The variable to be changed

        • childName: string

          The name of the child

          -

        Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean
      • +

      Returns void

    x

    x: number = 0

    y

    y: number = 0

    zOrder

    zOrder: number = 0

    Protected aabb

    aabb: AABB = ...

    Protected hitBoxes

    hitBoxes: Polygon[]

    Protected hitBoxesDirty

    hitBoxesDirty: boolean = true

    Static Private getVariableBoolean

    getVariableBoolean: (variable: Variable, compareWith: boolean) => boolean = ...

    Type declaration

      • (variable: Variable, compareWith: boolean): boolean

      • Shortcut to compare the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        -

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void
      • +

        Parameters

        Returns boolean

    Static Private setVariableBoolean

    setVariableBoolean: (variable: Variable, newValue: boolean) => void = ...

    Type declaration

      • (variable: Variable, newValue: boolean): void

      • Shortcut to set the value of a variable considered as a boolean. This shortcut function is needed for events code generation.

        Parameters

        Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • +

      Returns void

    Static Private toggleVariableBoolean

    toggleVariableBoolean: (variable: Variable) => void = ...

    Type declaration

      • Toggles a variable. This shortcut function is needed for events code generation.

        see

        {gdjs.evtTools.common.toggleVariableBoolean}

        -

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void
      • +

        Parameters

        Returns void

    Static Private valuePush

    valuePush: (array: Variable, value: string | number | boolean) => void = ...

    Type declaration

      • (array: Variable, value: string | number | boolean): void

      • This shortcut function is needed for events code generation.

        -

        Parameters

        • array: Variable
        • value: string | number | boolean

        Returns void

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

    Static Private variablePushCopy

    variablePushCopy: (array: Variable, variable: Variable) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

    Static Private variableRemoveAt

    variableRemoveAt: (array: Variable, index: number) => void = ...

    Type declaration

      • This shortcut function is needed for events code generation.

        -

        Parameters

        Returns void

    Constructors

    constructor

    Constructors

    constructor

    • Parameters

      • instanceContainer: RuntimeInstanceContainer

        The container the object belongs to.

      • tiledSpriteObjectData: TiledSpriteObjectData

        The initial properties of the object

        diff --git a/GDJS Runtime Documentation/classes/gdjs.TimeManager.html b/GDJS Runtime Documentation/classes/gdjs.TimeManager.html index 4f8e1c2c2..cfd6ab26d 100644 --- a/GDJS Runtime Documentation/classes/gdjs.TimeManager.html +++ b/GDJS Runtime Documentation/classes/gdjs.TimeManager.html @@ -2,24 +2,24 @@

        Manage the timers and times elapsed during last frame, since the beginning of the scene and other time related values. All durations are expressed in milliseconds.

        -

    Hierarchy

    • TimeManager

    Index

    Methods

    Constructors

    Methods

    addTimer

    • addTimer(name: string): void

    getElapsedTime

    • getElapsedTime(): number

    Hierarchy

    • TimeManager

    Index

    Methods

    Constructors

    Methods

    addTimer

    • addTimer(name: string): void

    getElapsedTime

    • getElapsedTime(): number

    • Return the time elapsed since the last call to update (i.e: the last frame), in milliseconds.

      -

      Returns number

    getTimeFromStart

    • getTimeFromStart(): number

    getTimeFromStart

    • getTimeFromStart(): number

    • Get the time since the instantiation of the manager (i.e: since the beginning of the scene most of the time), in milliseconds.

      -

      Returns number

    getTimeScale

    • getTimeScale(): number

    getTimeScale

    • getTimeScale(): number

    getTimer

    • getTimer(name: string): Timer

    hasTimer

    • hasTimer(name: string): boolean

    isFirstFrame

    • isFirstFrame(): boolean

    getTimer

    • getTimer(name: string): Timer

    hasTimer

    • hasTimer(name: string): boolean

    isFirstFrame

    • isFirstFrame(): boolean

    • Return true if update was called only once (i.e: if the scene is rendering its first frame).

      -

      Returns boolean

    removeTimer

    • removeTimer(name: string): void

    reset

    • reset(): void

    setTimeScale

    • setTimeScale(timeScale: number): void

    removeTimer

    • removeTimer(name: string): void

    reset

    • reset(): void

    setTimeScale

    • setTimeScale(timeScale: number): void

    • Set the time scale: time will be slower if time scale is < 1, faster if > 1.

      Parameters

      • timeScale: number

        The new time scale (must be positive).

        -

      Returns void

    update

    • update(elapsedTime: number, minimumFPS: number): void

    Constructors

    constructor

    Legend

    • Constructor
    • Method

    Settings

    Theme

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Timer

    Represents a timer, which must be updated manually with gdjs.Timer.updateTime.

    -

    Hierarchy

    • Timer

    Index

    Constructors

    Methods

    Constructors

    constructor

    • new Timer(name: string): Timer

    Hierarchy

    • Timer

    Index

    Constructors

    Methods

    Constructors

    constructor

    • new Timer(name: string): Timer

    Methods

    getName

    • getName(): string

    Returns Timer

    Methods

    getName

    • getName(): string

    getNetworkSyncData

    • getNetworkSyncData(): TimerNetworkSyncData

    getTime

    • getTime(): number

    getNetworkSyncData

    • getNetworkSyncData(): TimerNetworkSyncData

    getTime

    • getTime(): number

    • Get the time of the timer, in milliseconds.

      Returns number

      The time of the timer, in milliseconds.

      -

    isPaused

    • isPaused(): boolean

    isPaused

    • isPaused(): boolean

    reset

    • reset(): void

    reset

    • reset(): void

    setPaused

    • setPaused(enable: boolean): void

    setPaused

    • setPaused(enable: boolean): void

    • Set if the timer is paused.

      Parameters

      • enable: boolean

        true to pause the timer, false otherwise.

        -

      Returns void

    setTime

    • setTime(time: number): void

    Returns void

    setTime

    • setTime(time: number): void

    • Change the time.

      Parameters

      • time: number

        The new time, in milliseconds.

        -

      Returns void

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(syncData: TimerNetworkSyncData): void

    updateTime

    • updateTime(time: number): void

    Returns void

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(syncData: TimerNetworkSyncData): void

    updateTime

    • updateTime(time: number): void

    stepPreEvents

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    Returns void

    updateFromBehaviorData

    • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean

    updateFromNetworkSyncData

    updateFromNetworkSyncData

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    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

    Constructors

    constructor

    Properties

    name

    name: string

    owner

    owner: RuntimeObject

    type

    type: string

    Legend

    • Constructor
    • Method
    • Inherited property
    • Inherited method

    Settings

    Theme

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class TweenRuntimeBehavior

    Hierarchy

    Index

    Methods

    Constructors

    Properties

    Methods

    activate

    • activate(enable: boolean): void

    activated

    • activated(): boolean

    addColorEffectPropertyTween

    • addColorEffectPropertyTween(effectBehavior: any, identifier: string, toColorStr: string, effectName: string, propertyName: string, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    addColorEffectPropertyTween

    • addColorEffectPropertyTween(effectBehavior: any, identifier: string, toColorStr: string, effectName: string, propertyName: string, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween a color object effect property.

      Parameters

      • effectBehavior: any

        Only used by events can be set to null

        @@ -22,7 +22,7 @@

        Duration in seconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addNumberEffectPropertyTween

    • addNumberEffectPropertyTween(effectBehavior: any, identifier: string, toValue: number, effectName: string, propertyName: string, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addNumberEffectPropertyTween

    • addNumberEffectPropertyTween(effectBehavior: any, identifier: string, toValue: number, effectName: string, propertyName: string, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween a numeric object effect property.

      Parameters

      • effectBehavior: any

        Only used by events can be set to null

        @@ -40,7 +40,7 @@

        Duration in seconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectAngleTween

    • addObjectAngleTween(identifier: string, toAngle: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectAngleTween

    • addObjectAngleTween(identifier: string, toAngle: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object angle.

      deprecated

      Use addObjectAngleTween2 instead.

      Parameters

      • identifier: string
        @@ -53,7 +53,7 @@

        Duration in milliseconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectAngleTween2

    • addObjectAngleTween2(identifier: string, toAngle: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectAngleTween2

    • addObjectAngleTween2(identifier: string, toAngle: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object angle.

      Parameters

      • identifier: string

        Unique id to identify the tween

        @@ -65,7 +65,7 @@

        Duration in seconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectColorHSLTween

    • addObjectColorHSLTween(identifier: string, toHue: number, animateHue: boolean, toSaturation: number, toLightness: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectColorHSLTween

    • addObjectColorHSLTween(identifier: string, toHue: number, animateHue: boolean, toSaturation: number, toLightness: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object HSL color, with the "to" color given using HSL (H: any number, S and L: 0-100).

      deprecated

      Use addObjectColorHSLTween2 instead.

      Parameters

      • identifier: string
        @@ -82,7 +82,7 @@

        Duration in milliseconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectColorHSLTween2

    • addObjectColorHSLTween2(identifier: string, toHue: number, animateHue: boolean, toSaturation: number, toLightness: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectColorHSLTween2

    • addObjectColorHSLTween2(identifier: string, toHue: number, animateHue: boolean, toSaturation: number, toLightness: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object HSL color, with the "to" color given using HSL (H: any number, S and L: 0-100).

      Parameters

      • identifier: string

        Unique id to identify the tween

        @@ -98,7 +98,7 @@

        Duration in seconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectColorTween

    • addObjectColorTween(identifier: string, toColorStr: string, easing: string, duration: number, destroyObjectWhenFinished: boolean, useHSLColorTransition: boolean): void

    Returns void

    addObjectColorTween

    • addObjectColorTween(identifier: string, toColorStr: string, easing: string, duration: number, destroyObjectWhenFinished: boolean, useHSLColorTransition: boolean): void

    • Tween an object color.

      deprecated

      Use addObjectColorTween2 instead.

      Parameters

      • identifier: string
        @@ -113,7 +113,7 @@

        Destroy this object when the tween ends

      • useHSLColorTransition: boolean

        Tween using HSL color mappings, rather than direct RGB line

        -

      Returns void

    addObjectColorTween2

    • addObjectColorTween2(identifier: string, toColorStr: string, easing: string, duration: number, destroyObjectWhenFinished: boolean, useHSLColorTransition?: boolean): void

    Returns void

    addObjectColorTween2

    • addObjectColorTween2(identifier: string, toColorStr: string, easing: string, duration: number, destroyObjectWhenFinished: boolean, useHSLColorTransition?: boolean): void

    • Tween an object color.

      Parameters

      • identifier: string

        Unique id to identify the tween

        @@ -127,7 +127,7 @@

        Destroy this object when the tween ends

      • useHSLColorTransition: boolean = true

        Tween using HSL color mappings, rather than direct RGB line

        -

      Returns void

    addObjectDepthTween

    • addObjectDepthTween(identifier: string, toDepth: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectDepthTween

    • addObjectDepthTween(identifier: string, toDepth: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object depth.

      deprecated

      Use addObjectDepthTween2 instead.

      Parameters

      • identifier: string
        @@ -140,7 +140,7 @@

        Duration in milliseconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectDepthTween2

    • addObjectDepthTween2(object3DBehavior: any, identifier: string, toDepth: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectDepthTween2

    • addObjectDepthTween2(object3DBehavior: any, identifier: string, toDepth: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object depth.

      Parameters

      • object3DBehavior: any

        Only used by events can be set to null

        @@ -154,7 +154,7 @@

        Duration in seconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectHeightTween

    • addObjectHeightTween(identifier: string, toHeight: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectHeightTween

    • addObjectHeightTween(identifier: string, toHeight: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object height.

      deprecated

      Use addObjectHeightTween2 instead.

      Parameters

      • identifier: string
        @@ -167,7 +167,7 @@

        Duration in milliseconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectHeightTween2

    • addObjectHeightTween2(identifier: string, toHeight: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectHeightTween2

    • addObjectHeightTween2(identifier: string, toHeight: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object height.

      Parameters

      • identifier: string

        Unique id to identify the tween

        @@ -179,7 +179,7 @@

        Duration in seconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectOpacityTween

    • addObjectOpacityTween(identifier: string, toOpacity: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectOpacityTween

    • addObjectOpacityTween(identifier: string, toOpacity: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object opacity.

      deprecated

      Use addObjectOpacityTween2 instead.

      Parameters

      • identifier: string
        @@ -192,7 +192,7 @@

        Duration in milliseconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectOpacityTween2

    • addObjectOpacityTween2(identifier: string, toOpacity: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectOpacityTween2

    • addObjectOpacityTween2(identifier: string, toOpacity: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object opacity.

      Parameters

      • identifier: string

        Unique id to identify the tween

        @@ -204,7 +204,7 @@

        Duration in second

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectPositionTween

    • addObjectPositionTween(identifier: string, toX: number, toY: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectPositionTween

    • addObjectPositionTween(identifier: string, toX: number, toY: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object position.

      deprecated

      Use addObjectPositionTween2 instead.

      Parameters

      • identifier: string
        @@ -219,7 +219,7 @@

        Duration in milliseconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectPositionTween2

    • addObjectPositionTween2(identifier: string, toX: number, toY: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectPositionTween2

    • addObjectPositionTween2(identifier: string, toX: number, toY: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object position.

      Parameters

      • identifier: string

        Unique id to identify the tween

        @@ -233,7 +233,7 @@

        Duration in seconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectPositionXTween

    • addObjectPositionXTween(identifier: string, toX: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectPositionXTween

    • addObjectPositionXTween(identifier: string, toX: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object X position.

      deprecated

      Use addObjectPositionXTween2 instead.

      Parameters

      • identifier: string
        @@ -246,7 +246,7 @@

        Duration in milliseconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectPositionXTween2

    • addObjectPositionXTween2(identifier: string, toX: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectPositionXTween2

    • addObjectPositionXTween2(identifier: string, toX: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object X position.

      Parameters

      • identifier: string

        Unique id to identify the tween

        @@ -258,7 +258,7 @@

        Duration in seconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectPositionYTween

    • addObjectPositionYTween(identifier: string, toY: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectPositionYTween

    • addObjectPositionYTween(identifier: string, toY: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object Y position.

      deprecated

      Use addObjectPositionYTween2 instead.

      Parameters

      • identifier: string
        @@ -271,7 +271,7 @@

        Duration in milliseconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectPositionYTween2

    • addObjectPositionYTween2(identifier: string, toY: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectPositionYTween2

    • addObjectPositionYTween2(identifier: string, toY: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object Y position.

      Parameters

      • identifier: string

        Unique id to identify the tween

        @@ -283,7 +283,7 @@

        Duration in seconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectPositionZTween

    • addObjectPositionZTween(identifier: string, toZ: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectPositionZTween

    • addObjectPositionZTween(identifier: string, toZ: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object Z position.

      deprecated

      Use addObjectPositionZTween2 instead.

      Parameters

      • identifier: string
        @@ -296,7 +296,7 @@

        Duration in milliseconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectPositionZTween2

    • addObjectPositionZTween2(object3DBehavior: any, identifier: string, toZ: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectPositionZTween2

    • addObjectPositionZTween2(object3DBehavior: any, identifier: string, toZ: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object Z position.

      Parameters

      • object3DBehavior: any

        Only used by events can be set to null

        @@ -310,7 +310,7 @@

        Duration in seconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectRotationXTween

    • addObjectRotationXTween(object3DBehavior: any, identifier: string, toAngle: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectRotationXTween

    • addObjectRotationXTween(object3DBehavior: any, identifier: string, toAngle: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween a 3D object rotation X.

      Parameters

      • object3DBehavior: any

        Only used by events can be set to null

        @@ -324,7 +324,7 @@

        Duration in seconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectRotationYTween

    • addObjectRotationYTween(object3DBehavior: any, identifier: string, toAngle: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectRotationYTween

    • addObjectRotationYTween(object3DBehavior: any, identifier: string, toAngle: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween a 3D object rotation Y.

      Parameters

      • object3DBehavior: any

        Only used by events can be set to null

        @@ -338,7 +338,7 @@

        Duration in seconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectScaleTween

    • addObjectScaleTween(identifier: string, toScaleX: number, toScaleY: number, easing: string, duration: number, destroyObjectWhenFinished: boolean, scaleFromCenterOfObject: boolean): void

    Returns void

    addObjectScaleTween

    • addObjectScaleTween(identifier: string, toScaleX: number, toScaleY: number, easing: string, duration: number, destroyObjectWhenFinished: boolean, scaleFromCenterOfObject: boolean): void

    • Tween an object scale.

      deprecated

      Use addObjectScaleTween2 instead.

      Parameters

      • identifier: string
        @@ -355,7 +355,7 @@

        Destroy this object when the tween ends

      • scaleFromCenterOfObject: boolean

        Scale the transform from the center of the object (or point that is called center), not the top-left origin

        -

      Returns void

    addObjectScaleTween2

    • addObjectScaleTween2(identifier: string, toScaleX: number, toScaleY: number, easing: string, duration: number, destroyObjectWhenFinished: boolean, scaleFromCenterOfObject: boolean): void

    Returns void

    addObjectScaleTween2

    • addObjectScaleTween2(identifier: string, toScaleX: number, toScaleY: number, easing: string, duration: number, destroyObjectWhenFinished: boolean, scaleFromCenterOfObject: boolean): void

    • Tween an object scale.

      deprecated

      Use addObjectScaleXTween2 and addObjectScaleYTween2 instead.

      Parameters

      • identifier: string
        @@ -372,7 +372,7 @@

        Destroy this object when the tween ends

      • scaleFromCenterOfObject: boolean

        Scale the transform from the center of the object (or point that is called center), not the top-left origin

        -

      Returns void

    addObjectScaleTween3

    • addObjectScaleTween3(identifier: string, toScale: number, easing: string, duration: number, destroyObjectWhenFinished: boolean, scaleFromCenterOfObject: boolean): void

    Returns void

    addObjectScaleTween3

    • addObjectScaleTween3(identifier: string, toScale: number, easing: string, duration: number, destroyObjectWhenFinished: boolean, scaleFromCenterOfObject: boolean): void

    • Tween an object scale.

      Parameters

      • identifier: string

        Unique id to identify the tween

        @@ -386,7 +386,7 @@

        Destroy this object when the tween ends

      • scaleFromCenterOfObject: boolean

        Scale the transform from the center of the object (or point that is called center), not the top-left origin

        -

      Returns void

    addObjectScaleXTween

    • addObjectScaleXTween(identifier: string, toScaleX: number, easing: string, duration: number, destroyObjectWhenFinished: boolean, scaleFromCenterOfObject: boolean): void

    Returns void

    addObjectScaleXTween

    • addObjectScaleXTween(identifier: string, toScaleX: number, easing: string, duration: number, destroyObjectWhenFinished: boolean, scaleFromCenterOfObject: boolean): void

    • Tween an object X-scale.

      deprecated

      Use addObjectScaleXTween2 instead.

      Parameters

      • identifier: string
        @@ -401,7 +401,7 @@

        Destroy this object when the tween ends

      • scaleFromCenterOfObject: boolean

        Scale the transform from the center of the object (or point that is called center), not the top-left origin

        -

      Returns void

    addObjectScaleXTween2

    • addObjectScaleXTween2(identifier: string, toScaleX: number, easing: string, duration: number, destroyObjectWhenFinished: boolean, scaleFromCenterOfObject: boolean): void

    Returns void

    addObjectScaleXTween2

    • addObjectScaleXTween2(identifier: string, toScaleX: number, easing: string, duration: number, destroyObjectWhenFinished: boolean, scaleFromCenterOfObject: boolean): void

    • Tween an object X-scale.

      Parameters

      • identifier: string

        Unique id to identify the tween

        @@ -415,7 +415,7 @@

        Destroy this object when the tween ends

      • scaleFromCenterOfObject: boolean

        Scale the transform from the center of the object (or point that is called center), not the top-left origin

        -

      Returns void

    addObjectScaleYTween

    • addObjectScaleYTween(identifier: string, toScaleY: number, easing: string, duration: number, destroyObjectWhenFinished: boolean, scaleFromCenterOfObject: boolean): void

    Returns void

    addObjectScaleYTween

    • addObjectScaleYTween(identifier: string, toScaleY: number, easing: string, duration: number, destroyObjectWhenFinished: boolean, scaleFromCenterOfObject: boolean): void

    • Tween an object Y-scale.

      deprecated

      Use addObjectScaleYTween2 instead.

      Parameters

      • identifier: string
        @@ -430,7 +430,7 @@

        Destroy this object when the tween ends

      • scaleFromCenterOfObject: boolean

        Scale the transform from the center of the object (or point that is called center), not the top-left origin

        -

      Returns void

    addObjectScaleYTween2

    • addObjectScaleYTween2(identifier: string, toScaleY: number, easing: string, duration: number, destroyObjectWhenFinished: boolean, scaleFromCenterOfObject: boolean): void

    Returns void

    addObjectScaleYTween2

    • addObjectScaleYTween2(identifier: string, toScaleY: number, easing: string, duration: number, destroyObjectWhenFinished: boolean, scaleFromCenterOfObject: boolean): void

    • Tween an object Y-scale.

      Parameters

      • identifier: string

        Unique id to identify the tween

        @@ -444,7 +444,7 @@

        Destroy this object when the tween ends

      • scaleFromCenterOfObject: boolean

        Scale the transform from the center of the object (or point that is called center), not the top-left origin

        -

      Returns void

    addObjectWidthTween

    • addObjectWidthTween(identifier: string, toWidth: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectWidthTween

    • addObjectWidthTween(identifier: string, toWidth: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object width.

      deprecated

      Use addObjectWidthTween2 instead.

      Parameters

      • identifier: string
        @@ -457,7 +457,7 @@

        Duration in milliseconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addObjectWidthTween2

    • addObjectWidthTween2(identifier: string, toWidth: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addObjectWidthTween2

    • addObjectWidthTween2(identifier: string, toWidth: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object width.

      Parameters

      • identifier: string

        Unique id to identify the tween

        @@ -469,7 +469,7 @@

        Duration in seconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addTextObjectCharacterSizeTween

    • addTextObjectCharacterSizeTween(identifier: string, toSize: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addTextObjectCharacterSizeTween

    • addTextObjectCharacterSizeTween(identifier: string, toSize: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween a text object character size.

      deprecated

      Use addTextObjectCharacterSizeTween2 instead.

      Parameters

      • identifier: string
        @@ -482,7 +482,7 @@

        Duration in milliseconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addTextObjectCharacterSizeTween2

    • addTextObjectCharacterSizeTween2(identifier: string, toSize: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addTextObjectCharacterSizeTween2

    • addTextObjectCharacterSizeTween2(identifier: string, toSize: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween a text object character size.

      Parameters

      • identifier: string

        Unique id to identify the tween

        @@ -494,7 +494,7 @@

        Duration in seconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addValueTween

    • addValueTween(identifier: string, fromValue: number, toValue: number, easing: string, duration: number, useExponentialInterpolation: boolean, destroyObjectWhenFinished: boolean): void

    Returns void

    addValueTween

    • addValueTween(identifier: string, fromValue: number, toValue: number, easing: string, duration: number, useExponentialInterpolation: boolean, destroyObjectWhenFinished: boolean): void

    • Add an object value tween.

      Parameters

      • identifier: string

        Unique id to identify the tween

        @@ -511,7 +511,7 @@ It's useful for values that are factors like a scale or a zoom.

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addVariableTween

    • addVariableTween(identifier: string, variable: Variable, fromValue: number, toValue: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addVariableTween

    • addVariableTween(identifier: string, variable: Variable, fromValue: number, toValue: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void
  • destroyObjectWhenFinished: boolean

    Destroy this object when the tween ends

    -

    • Returns void

    addVariableTween2

    • addVariableTween2(identifier: string, variable: Variable, toValue: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addVariableTween2

    • addVariableTween2(identifier: string, variable: Variable, toValue: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object variable.

      deprecated

      Use addVariableTween3 instead.

      Parameters

      • identifier: string
        @@ -549,7 +549,7 @@

        Duration in milliseconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    addVariableTween3

    • addVariableTween3(identifier: string, variable: Variable, toValue: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    Returns void

    addVariableTween3

    • addVariableTween3(identifier: string, variable: Variable, toValue: number, easing: string, duration: number, destroyObjectWhenFinished: boolean): void

    • Tween an object variable.

      Parameters

      • identifier: string

        Unique id to identify the tween

        @@ -563,111 +563,111 @@

        Duration in seconds

      • destroyObjectWhenFinished: boolean

        Destroy this object when the tween ends

        -

      Returns void

    doStepPostEvents

    Returns void

    doStepPostEvents

    doStepPreEvents

    Returns void

    doStepPreEvents

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    exists

    • exists(identifier: string): boolean

    enableSynchronization

    • enableSynchronization(enable: boolean): void

    exists

    • exists(identifier: string): boolean

    getName

    • getName(): string

    getName

    • getName(): string

    getNameId

    • getNameId(): number

    getNameId

    • getNameId(): number

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    getProgress

    • getProgress(identifier: string): number

    getNetworkSyncData

    • getNetworkSyncData(): BehaviorNetworkSyncData

    getProgress

    • getProgress(identifier: string): number

    getValue

    • getValue(identifier: string): number

    getValue

    • getValue(identifier: string): number

    hasFinished

    • hasFinished(identifier: string): boolean

    hasFinished

    • hasFinished(identifier: string): boolean

    isPlaying

    • isPlaying(identifier: string): boolean

    Returns boolean

    isPlaying

    • isPlaying(identifier: string): boolean

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    Returns boolean

    isSyncedOverNetwork

    • isSyncedOverNetwork(): boolean

    onActivate

    • onActivate(): void

    onCreated

    • onCreated(): void

    onCreated

    • onCreated(): void

    onDeActivate

    • onDeActivate(): void

    onDeActivate

    • onDeActivate(): void

    onDestroy

    • onDestroy(): 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

    onObjectHotReloaded

    • onObjectHotReloaded(): void

    pauseTween

    • pauseTween(identifier: string): void

    pauseTween

    • pauseTween(identifier: string): void

    removeTween

    • removeTween(identifier: string): void

    Returns void

    removeTween

    • removeTween(identifier: string): void

    resumeTween

    • resumeTween(identifier: string): void

    Returns void

    resumeTween

    • resumeTween(identifier: string): void

    stepPostEvents

    Returns void

    stepPostEvents

    stepPreEvents

    Returns void

    stepPreEvents

    stopTween

    • stopTween(identifier: string, jumpToDest: boolean): void

    Returns void

    stopTween

    • stopTween(identifier: string, jumpToDest: boolean): void

    updateFromBehaviorData

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

    Returns void

    updateFromBehaviorData

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

      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

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: BehaviorNetworkSyncData): void

    usesLifecycleFunction

    • usesLifecycleFunction(): boolean

    Returns void

    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

    Constructors

    constructor

    Constructors

    constructor

    Properties

    name

    name: string

    owner

    owner: RuntimeObject

    type

    type: string

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Variable

    A Variable is an object storing a value (number or a string) or children variables.

    -

    Hierarchy

    • Variable

    Index

    Methods

    Constructors

    Methods

    add

    • add(val: number): void

    Hierarchy

    • Variable

    Index

    Methods

    Constructors

    Methods

    add

    • add(val: number): void

    addChild

    Returns void

    addChild

    • Add a child variable with the specified name.

      If there is an existing child variable with this name, it is erased.

      Parameters

      • childName: string
        @@ -12,19 +12,19 @@
      • childVariable: Variable

        The variable to add as a child

      Returns Variable

      The variable (for chaining calls)

      -

    castTo

    • castTo(newType: VariableType): void

    castTo

    • castTo(newType: VariableType): void

    • Converts the variable into another type.

      Parameters

      • newType: VariableType

        The new type of the variable

        -

      Returns void

    clearChildren

    • clearChildren(): void

    Returns void

    clearChildren

    • clearChildren(): void

    clone

    clone

    concatenateString

    • concatenateString(str: string): void

    concatenateString

    • concatenateString(str: string): void

    • Concatenate the given string at the end of the variable value

      Parameters

      • str: string

        the string to append

        -

      Returns void

    Static copy

    Returns void

    Static copy

    • Deeply copies a variable into another.

      Parameters

      • source: Variable

        The source variable.

        @@ -33,133 +33,133 @@
      • Optional merge: boolean

        Should the target be merged with the source, or be an exact copy?

      Returns Variable

      The target variable.

      -

    disableSynchronization

    • disableSynchronization(): void

    div

    • div(val: number): void

    disableSynchronization

    • disableSynchronization(): void

    div

    • div(val: number): void

    fromJSON

    Returns void

    fromJSON

    • Unserialize a JSON string into this variable.

      This just logs an error if the JSON is invalid.

      Parameters

      • json: string

        A JSON string.

        -

      Returns Variable

    fromJSObject

    Returns Variable

    fromJSObject

    • Converts a JavaScript object into a value compatible with GDevelop variables and store it inside this variable.

      Parameters

      • obj: any

        The value to convert.

        -

      Returns Variable

    getAllChildren

    • getAllChildren(): Children

    Returns Variable

    getAllChildren

    • getAllChildren(): Children

    • Return the object containing all the children of the variable.

      Returns Children

      All the children of the variable

      -

    getAllChildrenArray

    getAllChildrenArray

    getAsBoolean

    • getAsBoolean(): boolean

    getAsBoolean

    • getAsBoolean(): boolean

    • Get the value of the variable, considered as a boolean

      Returns boolean

      The boolean value of the variable.

      -

    getAsNumber

    • getAsNumber(): number

    getAsNumber

    • getAsNumber(): number

    • Get the value of the variable, considered as a number

      Returns number

      The number stored in the variable

      -

    getAsString

    • getAsString(): string

    getAsString

    • getAsString(): string

    • Get the value of the variable, considered as a string

      Returns string

      The string stored in the variable

      -

    getChild

    • getChild(childName: string | number): Variable

    getChild

    • getChild(childName: string | number): Variable

    • Get the child with the specified name or at the specified index.

      If the variable is an array, prefer getChildAt. If the variable is a structure, prefer getChildNamed.

      If the variable has not the specified child, an empty variable with the specified name (or index) is added as child.

      Parameters

      • childName: string | number

      Returns Variable

      The child variable

      -

    getChildAt

    getChildAt

    getChildNamed

    • getChildNamed(childName: string): Variable

    getChildNamed

    • getChildNamed(childName: string): Variable

    • Get the child with the specified name.

      If the variable has not the specified child, an empty variable with the specified name is added as child.

      Parameters

      • childName: string

      Returns Variable

      The child variable

      -

    getChildrenCount

    • getChildrenCount(): number

    getChildrenCount

    • getChildrenCount(): number

    getPlayerOwnership

    • getPlayerOwnership(): null | number

    getType

    • getType(): VariableType

    getPlayerOwnership

    • getPlayerOwnership(): null | number

    getType

    • getType(): VariableType

    getValue

    • getValue(): string | number | boolean

    getValue

    • getValue(): string | number | boolean

    hasChild

    • hasChild(childName: string): boolean

    hasChild

    • hasChild(childName: string): boolean

    • Return the child in a variable.

      Check if the variable has the specified children

      Parameters

      • childName: string

      Returns boolean

      true if variable has the children with the specified name

      -

    isNumber

    • isNumber(): boolean

    isNumber

    • isNumber(): boolean

    Static isPrimitive

    • isPrimitive(type: VariableType): type is "string" | "number" | "boolean"

    Static isPrimitive

    • isPrimitive(type: VariableType): type is "string" | "number" | "boolean"

    • Return true if the variable type is a primitive type.

      -

      Parameters

      • type: VariableType

      Returns type is "string" | "number" | "boolean"

    isPrimitive

    • isPrimitive(): boolean

    isPrimitive

    • isPrimitive(): boolean

    isStructure

    • isStructure(): boolean

    isStructure

    • isStructure(): boolean

    isUndefinedInContainer

    • isUndefinedInContainer(): boolean

    isUndefinedInContainer

    • isUndefinedInContainer(): boolean

    • Check if the variable must be considered as not existing in its container (usually a gdjs.VariablesContainer).

      Returns boolean

      true if the container must consider that the variable does not exist.

      -

    mul

    • mul(val: number): void

    mul

    • mul(val: number): void

    pushValue

    • pushValue(value: string | number | boolean): void

    Returns void

    pushValue

    • pushValue(value: string | number | boolean): void

    pushVariableCopy

    • pushVariableCopy(variable: Variable): void

    pushVariableCopy

    • pushVariableCopy(variable: Variable): void

    reinitialize

    • reinitialize(varData?: Readonly<{ children?: Readonly<{ name?: string | undefined; value?: string | number | boolean | undefined; children?: Readonly<...>[] | undefined; type?: VariableType | undefined; }>[]; name?: string; type?: VariableType; value?: string | number | boolean }>): void

    • Parameters

      • Optional varData: Readonly<{ children?: Readonly<{ name?: string | undefined; value?: string | number | boolean | undefined; children?: Readonly<...>[] | undefined; type?: VariableType | undefined; }>[]; name?: string; type?: VariableType; value?: string | number | boolean }>

      Returns void

    removeAtIndex

    • removeAtIndex(index: number): void

    reinitialize

    • reinitialize(varData?: Readonly<{ children?: Readonly<{ name?: string | undefined; value?: string | number | boolean | undefined; children?: Readonly<...>[] | undefined; type?: VariableType | undefined; }>[]; name?: string; type?: VariableType; value?: string | number | boolean }>): void

    • Parameters

      • Optional varData: Readonly<{ children?: Readonly<{ name?: string | undefined; value?: string | number | boolean | undefined; children?: Readonly<...>[] | undefined; type?: VariableType | undefined; }>[]; name?: string; type?: VariableType; value?: string | number | boolean }>

      Returns void

    removeAtIndex

    • removeAtIndex(index: number): void

    removeChild

    • removeChild(childName: string): void

    removeChild

    • removeChild(childName: string): void

    • Remove the child with the specified name.

      If the variable has not the specified child, nothing is done.

      Parameters

      • childName: string

        The name of the child to be removed

        -

      Returns void

    replaceChildren

    • replaceChildren(newChildren: Children): void

    Returns void

    replaceChildren

    • replaceChildren(newChildren: Children): void

    • Replaces all the children with a new map of children.

      Parameters

      • newChildren: Children

        The map of new children.

        -

      Returns void

    replaceChildrenArray

    • replaceChildrenArray(newChildren: Variable[]): void

    Returns void

    replaceChildrenArray

    • replaceChildrenArray(newChildren: Variable[]): void

    setBoolean

    • setBoolean(newValue: boolean): void

    Returns void

    setBoolean

    • setBoolean(newValue: boolean): void

    • Change the value of the variable, considered as a boolean

      Parameters

      • newValue: boolean

        The new boolean to be set.

        -

      Returns void

    setNumber

    • setNumber(newValue: number): void

    Returns void

    setNumber

    • setNumber(newValue: number): void

    • Change the value of the variable, considered as a number

      Parameters

      • newValue: number

        The new value to be set

        -

      Returns void

    setPlayerOwnership

    • setPlayerOwnership(playerNumber: number): void

    setString

    • setString(newValue: string): void

    Returns void

    setPlayerOwnership

    • setPlayerOwnership(playerNumber: number): void

    setString

    • setString(newValue: string): void

    • Change the value of the variable, considered as a string

      Parameters

      • newValue: string

        The new string to be set

        -

      Returns void

    setUndefinedInContainer

    • setUndefinedInContainer(): void

    Returns void

    setUndefinedInContainer

    • setUndefinedInContainer(): void

    • Used (usually by gdjs.VariablesContainer) to set that the variable must be considered as not existing in the container.

      -

      Returns void

    setValue

    • setValue(newValue: string | number | boolean): void

    setValue

    • setValue(newValue: string | number | boolean): void

    • Sets the primitive value using the setter of the current type.

      Parameters

      • newValue: string | number | boolean

        The primitive value of the variable.

        -

      Returns void

    sub

    • sub(val: number): void

    Returns void

    sub

    • sub(val: number): void

    • Subtract the given number to the variable value

      Parameters

      • val: number

        the number to subtract

        -

      Returns void

    toJSObject

    • toJSObject(): any

    Returns void

    toJSObject

    • toJSObject(): any

    • Converts this variable into an equivalent JavaScript object.

      Returns any

      A JavaScript object equivalent to the variable.

      -

    toggle

    • toggle(): void

    toggle

    • toggle(): void

    Private concatenate

    • concatenate(str: string): void

    Private getAsNumberOrString

    • getAsNumberOrString(): string | number

    Private concatenate

    • concatenate(str: string): void

    Private getAsNumberOrString

    • getAsNumberOrString(): string | number

    • Get the value of the variable, as a number if it's one, or as a string (if it's a string or something else)

      In most cases, prefer calling getAsNumber or getAsString directly. This is a fallback in case a variable type can't be known statically for sure, like getValue.

      -

      Returns string | number

    Constructors

    constructor

    • new Variable(varData?: Readonly<{ children?: Readonly<{ name?: string | undefined; value?: string | number | boolean | undefined; children?: Readonly<...>[] | undefined; type?: VariableType | undefined; }>[]; name?: string; type?: VariableType; value?: string | number | boolean }>): Variable

    • Parameters

      • Optional varData: Readonly<{ children?: Readonly<{ name?: string | undefined; value?: string | number | boolean | undefined; children?: Readonly<...>[] | undefined; type?: VariableType | undefined; }>[]; name?: string; type?: VariableType; value?: string | number | boolean }>

      Returns Variable

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class VariablesContainer

    VariablesContainer stores variables, usually for a a RuntimeGame, a RuntimeScene or a RuntimeObject.

    -

    Hierarchy

    • VariablesContainer

    Index

    Methods

    Properties

    Constructors

    Methods

    add

    • add(name: string, newVariable: Variable): void

    Hierarchy

    • VariablesContainer

    Index

    Methods

    Properties

    Constructors

    Methods

    add

    • add(name: string, newVariable: Variable): void

    get

    Returns void

    get

    getFromIndex

    getFromIndex

    • Get a variable using its index. If you're unsure about how to use this method, prefer to use get. The index of a variable is its index in the data passed to initFrom.

      This method is generally used by events generated code to increase lookup speed for variables.

      @@ -21,17 +21,17 @@

      The variable index

    Returns Variable

    The specified variable. If not found, an empty variable is added to the container, but it should not happen.

    -

    getNetworkSyncData

    • getNetworkSyncData(syncOptions: GetNetworkSyncDataOptions): VariableNetworkSyncData[]

    getStructureNetworkSyncData

    • getStructureNetworkSyncData(variable: Variable): undefined | VariableNetworkSyncData[]

    getVariableNameInContainerByLoopingThroughAllVariables

    • getVariableNameInContainerByLoopingThroughAllVariables(variable: Variable): null | string

    has

    • has(name: string): boolean

    getNetworkSyncData

    • getNetworkSyncData(syncOptions: GetNetworkSyncDataOptions): VariableNetworkSyncData[]

    getStructureNetworkSyncData

    • getStructureNetworkSyncData(variable: Variable): undefined | VariableNetworkSyncData[]

    getVariableNameInContainerByLoopingThroughAllVariables

    • getVariableNameInContainerByLoopingThroughAllVariables(variable: Variable): null | string

    has

    • has(name: string): boolean

    hasVariable

    • hasVariable(variable: Variable): boolean

    hasVariable

    • hasVariable(variable: Variable): boolean

    initFrom

    • initFrom(data: Readonly<{ children?: Readonly<{ name?: string | undefined; value?: string | number | boolean | undefined; children?: Readonly<...>[] | undefined; type?: VariableType | undefined; }>[]; name?: string; type?: VariableType; value?: string | number | boolean }>[], keepOldVariables?: Boolean): void

    initFrom

    • initFrom(data: Readonly<{ children?: Readonly<{ name?: string | undefined; value?: string | number | boolean | undefined; children?: Readonly<...>[] | undefined; type?: VariableType | undefined; }>[]; name?: string; type?: VariableType; value?: string | number | boolean }>[], keepOldVariables?: Boolean): void

    • Initialize variables from a container data.
      If keepOldVariables is set to false (by default), all already existing variables will be erased, but the new variables will be accessible thanks to getFromIndex.
      @@ -39,18 +39,18 @@ still accessible thanks to getFromIndex.

      Parameters

      • data: Readonly<{ children?: Readonly<{ name?: string | undefined; value?: string | number | boolean | undefined; children?: Readonly<...>[] | undefined; type?: VariableType | undefined; }>[]; name?: string; type?: VariableType; value?: string | number | boolean }>[]

        The array containing data used to initialize variables.

        -
      • Optional keepOldVariables: Boolean

      Returns void

    remove

    • remove(name: string): void

    Returns void

    remove

    • remove(name: string): void

    • Remove a variable. (the variable is not really removed from the container to avoid creating garbage, but marked as undefined)

      Parameters

      • name: string

        Variable to be removed

        -

      Returns void

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: VariableNetworkSyncData[]): void

    Properties

    Static badVariable

    badVariable: Variable = ...
    +

    Returns void

    updateFromNetworkSyncData

    • updateFromNetworkSyncData(networkSyncData: VariableNetworkSyncData[]): void

    Properties

    Static badVariable

    badVariable: Variable = ...

    "Bad" variable, used by events when no other valid variable can be found. This variable has no state and always return 0 or the empty string.

    -
    static

    Static badVariablesContainer

    badVariablesContainer: VariablesContainer = ...
    +
    static

    Static badVariablesContainer

    badVariablesContainer: VariablesContainer = ...

    "Bad" variable container, used by events when no other valid container can be found. This container has no state and always returns the bad variable ( see VariablesContainer.badVariable ).

    -
    static

    Constructors

    constructor

    • new VariablesContainer(initialVariablesData?: Readonly<{ children?: Readonly<{ name?: string | undefined; value?: string | number | boolean | undefined; children?: Readonly<...>[] | undefined; type?: VariableType | undefined; }>[]; name?: string; type?: VariableType; value?: string | number | boolean }>[]): VariablesContainer

    • Parameters

      • Optional initialVariablesData: Readonly<{ children?: Readonly<{ name?: string | undefined; value?: string | number | boolean | undefined; children?: Readonly<...>[] | undefined; type?: VariableType | undefined; }>[]; name?: string; type?: VariableType; value?: string | number | boolean }>[]

      Returns VariablesContainer

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class VideoRuntimeObjectPixiRenderer

    The PIXI.js renderer for the VideoRuntimeObject.

    -

    Hierarchy

    • VideoRuntimeObjectPixiRenderer

    Index

    Constructors

    Methods

    Constructors

    constructor

    Hierarchy

    • VideoRuntimeObjectPixiRenderer

    Index

    Constructors

    Methods

    Constructors

    constructor

    Methods

    ensureUpToDate

    • ensureUpToDate(): void

    getCurrentTime

    • getCurrentTime(): number

    Returns VideoRuntimeObjectPixiRenderer

    Methods

    ensureUpToDate

    • ensureUpToDate(): void

    getCurrentTime

    • getCurrentTime(): number

    getDuration

    • getDuration(): number

    getDuration

    • getDuration(): number

    getHeight

    • getHeight(): number

    getPlaybackSpeed

    • getPlaybackSpeed(): number

    getHeight

    • getHeight(): number

    getPlaybackSpeed

    • getPlaybackSpeed(): number

    getRendererObject

    • getRendererObject(): any

    getVolume

    • getVolume(): number

    getRendererObject

    • getRendererObject(): any

    getVolume

    • getVolume(): number

    getWidth

    • getWidth(): number

    isEnded

    • isEnded(): boolean

    getWidth

    • getWidth(): number

    isEnded

    • isEnded(): boolean

    isLooped

    • isLooped(): boolean

    isLooped

    • isLooped(): boolean

    isMuted

    • isMuted(): boolean

    isMuted

    • isMuted(): boolean

    isPlayed

    • isPlayed(): boolean

    isPlayed

    • isPlayed(): boolean

    onDestroy

    • onDestroy(): void

    onDestroy

    • onDestroy(): void

    pause

    • pause(): void

    pause

    • pause(): void

    play

    • play(): void

    play

    • play(): void

    setCurrentTime

    • setCurrentTime(number: any): void

    setCurrentTime

    • setCurrentTime(number: any): void

    setHeight

    • setHeight(height: number): void

    setHeight

    • setHeight(height: number): void

    setLoop

    • setLoop(enable: boolean): void

    Returns void

    setLoop

    • setLoop(enable: boolean): void

    setMute

    • setMute(enable: boolean): void

    Returns void

    setMute

    • setMute(enable: boolean): void

    setPlaybackSpeed

    • setPlaybackSpeed(playbackRate: any): void

    Returns void

    setPlaybackSpeed

    • setPlaybackSpeed(playbackRate: any): void

    setVolume

    • setVolume(volume: number): void

    setVolume

    • setVolume(volume: number): void

    setWidth

    • setWidth(width: number): void

    Returns void

    setWidth

    • setWidth(width: number): void

    stop

    • stop(): void

    Returns void

    stop

    • stop(): void

    updateAngle

    • updateAngle(): void

    updateLoop

    • updateLoop(): void

    updateOpacity

    • updateOpacity(): void

    updatePosition

    • updatePosition(): void

    updateVolume

    • updateVolume(): void

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class WebsocketDebuggerClient

    This debugger client connects to a websocket server, exchanging and receiving messages with this server.

    -

    Hierarchy

    Index

    Methods

    Constructors

    Properties

    Methods

    call

    • call(path: string[], args: any[]): boolean

    Hierarchy

    Index

    Methods

    Constructors

    Properties

    Methods

    call

    • call(path: string[], args: any[]): boolean

    log

    • log(group: string, message: string, type: "info" | "warning" | "error", internal: boolean): void

    log

    • log(group: string, message: string, type: "info" | "warning" | "error", internal: boolean): void

    onUncaughtException

    • onUncaughtException(exception: Error): void

    sendGamePaused

    • sendGamePaused(): void

    onUncaughtException

    • onUncaughtException(exception: Error): void

    sendGamePaused

    • sendGamePaused(): void

    sendGameResumed

    • sendGameResumed(): void

    sendGameResumed

    • sendGameResumed(): void

    sendHotReloaderLogs

    sendHotReloaderLogs

    sendProfilerOutput

    Returns void

    sendProfilerOutput

    sendProfilerStarted

    • sendProfilerStarted(): void

    Returns void

    sendProfilerStarted

    • sendProfilerStarted(): void

    sendProfilerStopped

    • sendProfilerStopped(): void

    sendProfilerStopped

    • sendProfilerStopped(): void

    sendRuntimeGameDump

    • sendRuntimeGameDump(): void

    sendRuntimeGameDump

    • sendRuntimeGameDump(): void

    set

    • set(path: string[], newValue: any): boolean

    set

    • set(path: string[], newValue: any): boolean

    Protected handleCommand

    • handleCommand(data: any): void

    Protected handleCommand

    • handleCommand(data: any): void

    Constructors

    constructor

    Properties

    Private hasLoggedError

    hasLoggedError: boolean = false

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class WindowMessageDebuggerClient

    This debugger client connects to the parent window, exchanging and receiving messages using postMessage and the message event listener.

    -

    Hierarchy

    Index

    Methods

    Constructors

    Methods

    call

    • call(path: string[], args: any[]): boolean

    Hierarchy

    Index

    Methods

    Constructors

    Methods

    call

    • call(path: string[], args: any[]): boolean

    log

    • log(group: string, message: string, type: "info" | "warning" | "error", internal: boolean): void

    log

    • log(group: string, message: string, type: "info" | "warning" | "error", internal: boolean): void

    onUncaughtException

    • onUncaughtException(exception: Error): void

    sendGamePaused

    • sendGamePaused(): void

    onUncaughtException

    • onUncaughtException(exception: Error): void

    sendGamePaused

    • sendGamePaused(): void

    sendGameResumed

    • sendGameResumed(): void

    sendGameResumed

    • sendGameResumed(): void

    sendHotReloaderLogs

    sendHotReloaderLogs

    sendProfilerOutput

    Returns void

    sendProfilerOutput

    sendProfilerStarted

    • sendProfilerStarted(): void

    Returns void

    sendProfilerStarted

    • sendProfilerStarted(): void

    sendProfilerStopped

    • sendProfilerStopped(): void

    sendProfilerStopped

    • sendProfilerStopped(): void

    sendRuntimeGameDump

    • sendRuntimeGameDump(): void

    sendRuntimeGameDump

    • sendRuntimeGameDump(): void

    set

    • set(path: string[], newValue: any): boolean

    set

    • set(path: string[], newValue: any): boolean

    Protected handleCommand

    • handleCommand(data: any): void

    Protected handleCommand

    • handleCommand(data: any): void

    Constructors

    constructor

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class Event

    An event that can be listened to.

    -

    Hierarchy

    • Event

    Implements

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    Properties

    dataloss

    dataloss: boolean = false

    Private Readonly data

    data: IEventData[] = []

    Methods

    getData

    • getData(): string

    Hierarchy

    • Event

    Implements

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    Properties

    dataloss

    dataloss: boolean = false

    Private Readonly data

    data: IEventData[] = []

    Methods

    getData

    • getData(): string

    getSender

    • getSender(): string

    getSender

    • getSender(): string

    isTriggered

    • isTriggered(): boolean

    isTriggered

    • isTriggered(): boolean

    popData

    • popData(): void

    popData

    • popData(): void

    pushData

    pushData

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class EventData

    The data bound to an event that got triggered.

    -

    Hierarchy

    • EventData

    Implements

    Index

    Constructors

    Properties

    Constructors

    constructor

    • new EventData(data: string, sender: string): EventData

    Properties

    Readonly data

    data: string = ''
    +

    Hierarchy

    • EventData

    Implements

    Index

    Constructors

    Properties

    Constructors

    constructor

    • new EventData(data: string, sender: string): EventData

    Properties

    Readonly data

    data: string = ''

    The data sent alongside the event.

    -

    Readonly sender

    sender: string = ''
    +

    Readonly sender

    sender: string = ''

    The ID of the sender of the event.

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class WaitTask

    Hierarchy

    Index

    Constructors

    Methods

    Properties

    Constructors

    constructor

    • new WaitTask(durationInMilliseconds: number): WaitTask

    Methods

    update

    setAnimationName

    • setAnimationName(newAnimationName: string): void

    setAnimationSpeedScale

    • setAnimationSpeedScale(ratio: number): void

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface AnimationFrameTextureManager<T>

    Abstraction from graphic libraries texture classes.

    -

    Type parameters

    • T

    Hierarchy

    • AnimationFrameTextureManager

    Index

    Methods

    Methods

    getAnimationFrameHeight

    • getAnimationFrameHeight(pixiTexture: T): any

    getAnimationFrameTexture

    • getAnimationFrameTexture(imageName: string): T

    getAnimationFrameWidth

    • getAnimationFrameWidth(pixiTexture: T): any

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface Base3DHandler

    Hierarchy

    • Base3DHandler

    Implemented by

    Index

    Methods

    Methods

    flipZ

    • flipZ(enable: boolean): void

    getCenterZInScene

    • getCenterZInScene(): number

    setDepth

    • setDepth(depth: number): void

    setRotationX

    • setRotationX(angle: number): void

    setRotationX

    • setRotationX(angle: number): void

    • Set the object rotation on the X axis.

      This is an Euler angle. Objects use the ZYX order.

      Parameters

      • angle: number

        the rotation angle on the X axis in degree

        -

      Returns void

    setRotationY

    • setRotationY(angle: number): void

    Returns void

    setRotationY

    • setRotationY(angle: number): void

    • Set the object rotation on the Y axis.

      This is an Euler angle. Objects use the ZYX order.

      Parameters

      • angle: number

        the rotation angle on the Y axis in degree

        -

      Returns void

    setScaleZ

    • setScaleZ(newScale: number): void

    Returns void

    setScaleZ

    • setScaleZ(newScale: number): void

    • Change the scale on Z axis of the object (changing its depth).

      Parameters

      • newScale: number

        The new scale (must be greater than 0).

        -

      Returns void

    setZ

    • setZ(z: number): void

    Returns void

    setZ

    • setZ(z: number): void

    turnAroundX

    • turnAroundX(deltaAngle: number): void

    turnAroundX

    • turnAroundX(deltaAngle: number): void

    • Turn the object around the scene X axis at its center.

      Parameters

      • deltaAngle: number

        the rotation angle in degree

        -

      Returns void

    turnAroundY

    • turnAroundY(deltaAngle: number): void

    Returns void

    turnAroundY

    • turnAroundY(deltaAngle: number): void

    • Turn the object around the scene Y axis at its center.

      Parameters

      • deltaAngle: number

        the rotation angle in degree

        -

      Returns void

    turnAroundZ

    • turnAroundZ(deltaAngle: number): void

    Returns void

    turnAroundZ

    • turnAroundZ(deltaAngle: number): void

    setEffectDoubleParameter

    • setEffectDoubleParameter(name: string, parameterName: string, value: number): boolean

    • Change an effect property value (for properties that are numbers).

      Parameters

      • name: string

        The name of the effect to update.

        @@ -25,7 +25,7 @@

        The name of the property to update.

      • value: number

        The new value (number).

        -

      Returns boolean

    setEffectStringParameter

    • setEffectStringParameter(name: string, parameterName: string, value: string): boolean

    Returns boolean

    setEffectStringParameter

    • setEffectStringParameter(name: string, parameterName: string, value: string): boolean

    Const signInWithProvider

    • signInWithProvider(providerName: ProviderName, callbackStateVariable?: Variable): void

    Const token

    • token(): string

    Returns void

    Const token

    • token(): string

    Variables

    authenticated

    authenticated: boolean = false
    +

    Returns string

    Variables

    authenticated

    authenticated: boolean = false

    The current authentication status.

    -

    currentUser

    currentUser: firebase.User | null = null
    +

    currentUser

    currentUser: firebase.User | null = null

    The logged-in users data.

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace dangerous

    Contains dangerous management functions. Requires reauthentication before usage.

    -
    namespace

    Index

    Functions

    Functions

    Const changeEmail

    • changeEmail(oldEmail: string, password: string, newEmail: string, sendVerificationEmail?: boolean, callbackStateVariable?: Variable): void

    Index

    Functions

    Functions

    Const changeEmail

    • changeEmail(oldEmail: string, password: string, newEmail: string, sendVerificationEmail?: boolean, callbackStateVariable?: Variable): void

    • Changes the users email. Use this when using basic auth.

      Parameters

      • oldEmail: string
        @@ -9,14 +9,14 @@

        Old password for reauthentication.

      • newEmail: string

        New email for the user.

        -
      • sendVerificationEmail: boolean = true
      • Optional callbackStateVariable: Variable

      Returns void

    Const changeEmailProvider

    • changeEmailProvider(newEmail: string, sendVerificationEmail: boolean, callbackStateVariable?: Variable): void

    Returns void

    Const changeEmailProvider

    • changeEmailProvider(newEmail: string, sendVerificationEmail: boolean, callbackStateVariable?: Variable): void

    • Changes the users email. Use this when using an external provider.

      Parameters

      • newEmail: string

        New email for the user.

      • sendVerificationEmail: boolean

        Send a verification email to the old address before changing the email?

        -
      • Optional callbackStateVariable: Variable

      Returns void

    Const changePassword

    • changePassword(email: string, oldPassword: string, newPassword: string, callbackStateVariable?: Variable): void

    Returns void

    Const changePassword

    • changePassword(email: string, oldPassword: string, newPassword: string, callbackStateVariable?: Variable): void

    Const changePasswordProvider

    • changePasswordProvider(newPassword: string, callbackStateVariable?: Variable): void

    Returns void

    Const changePasswordProvider

    • changePasswordProvider(newPassword: string, callbackStateVariable?: Variable): void

    Const deleteUser

    • deleteUser(email: string, password: string, callbackStateVariable?: Variable): void

    Returns void

    Const deleteUser

    • deleteUser(email: string, password: string, callbackStateVariable?: Variable): void

    Const deleteUserProvider

    • deleteUserProvider(callbackStateVariable?: Variable): void

    Returns void

    Const deleteUserProvider

    • deleteUserProvider(callbackStateVariable?: Variable): void

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace userManagement

    A namespace containing tools for managing the current user.

    -
    namespace

    Index

    Namespaces

    Functions

    Functions

    Const getCreationTime

    • getCreationTime(): string

    Index

    Namespaces

    Functions

    Functions

    Const getCreationTime

    • getCreationTime(): string

    Const getDisplayName

    • getDisplayName(): string

    Const getDisplayName

    • getDisplayName(): string

    Const getEmail

    • getEmail(): string

    Const getEmail

    • getEmail(): string

    Const getLastLoginTime

    • getLastLoginTime(): string

    Const getLastLoginTime

    • getLastLoginTime(): string

    Const getPhoneNumber

    • getPhoneNumber(): string

    Const getPhoneNumber

    • getPhoneNumber(): string

    Const getPhotoURL

    • getPhotoURL(): string

    Const getPhotoURL

    • getPhotoURL(): string

    Const getRefreshToken

    • getRefreshToken(): string

    Const getRefreshToken

    • getRefreshToken(): string

    Const getTenantID

    • getTenantID(): string

    Const getTenantID

    • getTenantID(): string

    Const getUID

    • getUID(): string

    Const getUID

    • getUID(): string

    Const isEmailVerified

    • isEmailVerified(): boolean

    Const isEmailVerified

    • isEmailVerified(): boolean

    Const sendVerificationEmail

    • sendVerificationEmail(): Promise<void> | ""

    Const sendVerificationEmail

    • sendVerificationEmail(): Promise<void> | ""

    Const setDisplayName

    • setDisplayName(newDisplayName: string): Promise<void>

    Const setDisplayName

    • setDisplayName(newDisplayName: string): Promise<void>

    Const setPhotoURL

    • setPhotoURL(newPhotoURL: string): Promise<void>

    Const setPhotoURL

    • setPhotoURL(newPhotoURL: string): Promise<void>

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace database

    Firebase Cloud database Event Tools.

    -
    namespace

    Index

    Functions

    Functions

    Const deleteField

    • deleteField(path: string, field: string, callbackStateVariable?: Variable): void

    Index

    Functions

    Functions

    Const deleteField

    • deleteField(path: string, field: string, callbackStateVariable?: Variable): void

    Const deleteVariable

    • deleteVariable(path: string, callbackStateVariable?: Variable): void

    Returns void

    Const deleteVariable

    • deleteVariable(path: string, callbackStateVariable?: Variable): void

    Const getField

    • getField(path: string, field: string, callbackValueVariable: Variable, callbackStateVariable?: Variable): void

    Returns void

    Const getField

    • getField(path: string, field: string, callbackValueVariable: Variable, callbackStateVariable?: Variable): void

    • Gets a field of a database variable and store it in a variable.

      Parameters

      • path: string

        The name under which the variable will be saved (document name).

        @@ -18,13 +18,13 @@

        The field to get.

      • callbackValueVariable: Variable

        The variable where to store the result.

        -
      • Optional callbackStateVariable: Variable

      Returns void

    Const getVariable

    • getVariable(path: string, callbackValueVariable: Variable, callbackStateVariable?: Variable): void

    Returns void

    Const getVariable

    • getVariable(path: string, callbackValueVariable: Variable, callbackStateVariable?: Variable): void

    Const hasField

    • hasField(path: string, field: string, callbackValueVariable: Variable, callbackStateVariable?: Variable): void

    Returns void

    Const hasField

    • hasField(path: string, field: string, callbackValueVariable: Variable, callbackStateVariable?: Variable): void

    Const hasVariable

    • hasVariable(path: string, callbackValueVariable: Variable, callbackStateVariable?: Variable): void

    Returns void

    Const hasVariable

    • hasVariable(path: string, callbackValueVariable: Variable, callbackStateVariable?: Variable): void

    Const updateField

    • updateField(path: string, field: string, value: string | number, callbackStateVariable?: Variable): void

    Returns void

    Const updateField

    • updateField(path: string, field: string, value: string | number, callbackStateVariable?: Variable): void

    • Updates a field of a database variable.

      Parameters

      • path: string

        The name under which the variable will be saved (document name).

        @@ -46,13 +46,13 @@

        The field where to update.

      • value: string | number

        The value to write.

        -
      • Optional callbackStateVariable: Variable

      Returns void

    Const updateVariable

    • updateVariable(path: string, variable: Variable, callbackStateVariable?: Variable): void

    Returns void

    Const updateVariable

    • updateVariable(path: string, variable: Variable, callbackStateVariable?: Variable): void

    Const writeField

    • writeField(path: string, field: string, value: string | number, callbackStateVariable?: Variable): void

    Returns void

    Const writeField

    • writeField(path: string, field: string, value: string | number, callbackStateVariable?: Variable): void

    Const writeVariable

    • writeVariable(path: string, variable: Variable, callbackStateVariable?: Variable): void

    Returns void

    Const writeVariable

    • writeVariable(path: string, variable: Variable, callbackStateVariable?: Variable): void

    Const deleteDocument

    • deleteDocument(collectionName: string, documentName: string, callbackStateVariable?: Variable): void

    Const deleteField

    • deleteField(collectionName: string, documentName: string, field: string, callbackStateVariable?: Variable): void

    Returns void

    Const deleteField

    • deleteField(collectionName: string, documentName: string, field: string, callbackStateVariable?: Variable): void

    Const executeQuery

    • executeQuery(queryID: string, callbackValueVariable?: Variable, callbackStatusVariable?: Variable): void

    Returns void

    Const executeQuery

    • executeQuery(queryID: string, callbackValueVariable?: Variable, callbackStatusVariable?: Variable): void

    Const getDocument

    • getDocument(collectionName: string, documentName: string, callbackValueVariable?: Variable, callbackStateVariable?: Variable): void

    Returns void

    Const getDocument

    • getDocument(collectionName: string, documentName: string, callbackValueVariable?: Variable, callbackStateVariable?: Variable): void

    Const getField

    • getField(collectionName: string, documentName: string, field: string, callbackValueVariable?: Variable, callbackStateVariable?: Variable): void

    Returns void

    Const getField

    • getField(collectionName: string, documentName: string, field: string, callbackValueVariable?: Variable, callbackStateVariable?: Variable): void

    Const getServerTimestamp

    • getServerTimestamp(): string

    Returns void

    Const getServerTimestamp

    • getServerTimestamp(): string

    Const hasDocument

    • hasDocument(collectionName: string, documentName: string, callbackValueVariable?: Variable, callbackStateVariable?: Variable): void

    Const hasDocument

    • hasDocument(collectionName: string, documentName: string, callbackValueVariable?: Variable, callbackStateVariable?: Variable): void

    Const hasField

    • hasField(collectionName: string, documentName: string, field: string, callbackValueVariable?: Variable, callbackStateVariable?: Variable): void

    Returns void

    Const hasField

    • hasField(collectionName: string, documentName: string, field: string, callbackValueVariable?: Variable, callbackStateVariable?: Variable): void

    Const listDocuments

    • listDocuments(collectionName: string, callbackValueVariable?: Variable, callbackStateVariable?: Variable): void

    Returns void

    Const listDocuments

    • listDocuments(collectionName: string, callbackValueVariable?: Variable, callbackStateVariable?: Variable): void

    Const queryLimit

    • queryLimit(queryID: string, amount: number, last: boolean): void

    Returns void

    Const queryLimit

    • queryLimit(queryID: string, amount: number, last: boolean): void

    • Limits the amount of documents returned by the query.

      Parameters

      • queryID: string

        The query to add the filter to.

        @@ -67,7 +67,7 @@

        The amount of documents to limit to

      • last: boolean

        If true, limits to the last documents instead of the first documents.

        -

      Returns void

    Const queryOrderBy

    • queryOrderBy(queryID: string, field: string, direction: OrderByDirection): void

    Returns void

    Const queryOrderBy

    • queryOrderBy(queryID: string, field: string, direction: OrderByDirection): void

    Const querySkipSome

    • querySkipSome(queryID: string, value: number, before: boolean, includeSelf: boolean): void

    Returns void

    Const querySkipSome

    • querySkipSome(queryID: string, value: number, before: boolean, includeSelf: boolean): void

    • Makes a query skip documents after or before a certain value of a field the query was ordered with.

      Parameters

      • queryID: string
        @@ -86,7 +86,7 @@

        If set to true, all documents before the document are skipped, else all documents after it are skipped.

      • includeSelf: boolean

        If set to true, doesn't skip the document.

        -

      Returns void

    Const queryWhere

    • queryWhere(queryID: string, field: string, op: "<" | "<=" | "==" | "!=" | ">=" | ">" | "array-contains", value: string | number): void

    Returns void

    Const queryWhere

    • queryWhere(queryID: string, field: string, op: "<" | "<=" | "==" | "!=" | ">=" | ">" | "array-contains", value: string | number): void

    Const startQuery

    • startQuery(queryID: string, collectionName: string): void

    Returns void

    Const startQuery

    • startQuery(queryID: string, collectionName: string): void

    Const startQueryFrom

    • startQueryFrom(queryID: string, sourceQueryID: string): void

    Returns void

    Const startQueryFrom

    • startQueryFrom(queryID: string, sourceQueryID: string): void

    Const updateDocument

    • updateDocument(collectionName: string, variableName: string, variable: Variable, callbackStateVariable?: Variable): void

    Returns void

    Const updateDocument

    • updateDocument(collectionName: string, variableName: string, variable: Variable, callbackStateVariable?: Variable): void

    Const updateField

    • updateField(collectionName: string, documentName: string, field: string, value: any, callbackStateVariable?: Variable): void

    Returns void

    Const updateField

    • updateField(collectionName: string, documentName: string, field: string, value: any, callbackStateVariable?: Variable): void

    Const watchQuery

    • watchQuery(queryID: string, callbackValueVariable?: Variable, callbackStatusVariable?: Variable): void

    Returns void

    Const watchQuery

    • watchQuery(queryID: string, callbackValueVariable?: Variable, callbackStatusVariable?: Variable): void

    Const writeDocument

    • writeDocument(collectionName: string, variableName: string, variable: Variable, callbackStateVariable?: Variable): void

    Returns void

    Const writeDocument

    • writeDocument(collectionName: string, variableName: string, variable: Variable, callbackStateVariable?: Variable): void

    Const writeField

    • writeField(collectionName: string, documentName: string, field: string, value: any, callbackStateVariable?: Variable, merge?: boolean): void

    Returns void

    Const writeField

    • writeField(collectionName: string, documentName: string, field: string, value: any, callbackStateVariable?: Variable, merge?: boolean): void

    Const stopTracer

    • stopTracer(tracerName: string): void

    Const uploadFile

    • uploadFile(uploadID: string, file: string, onlinePath: string, type?: "none" | "base64" | "base64url" | "data_url", callbackStateVariable?: Variable, callbackValueVariable?: Variable): void

    • Uploads a file as string to the firebase storage bucket.

      Parameters

      • uploadID: string
      • file: string

        The entire file as string.

      • onlinePath: string

        The path under which the file will be accessible on the bucket.

        -
      • Optional type: "none" | "base64" | "base64url" | "data_url"
      • Optional callbackStateVariable: Variable
      • Optional callbackValueVariable: Variable

      Returns void

    Variables

    uploads

    uploads: Map<string, UploadTask> = ...
    +
  • Optional type: "none" | "base64" | "base64url" | "data_url"
  • Optional callbackStateVariable: Variable
  • Optional callbackValueVariable: Variable

    • Returns void

    Variables

    uploads

    uploads: Map<string, UploadTask> = ...

    The map containing all current uploads.

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace input

    Index

    Functions

    Variables

    Functions

    Const anyKeyPressed

    Const anyKeyReleased

    Const cursorOnObject

    Const getCursorX

    Const getCursorY

    Const getLastEndedTouchId

    • getLastEndedTouchId(): number

    Const getLastTouchId

    • getLastTouchId(): number

    Const getMouseOnlyCursorX

    Const getMouseOnlyCursorY

    Const getMouseWheelDelta

    Const getMouseX

    Const getMouseY

    Const getStartedTouchCount

    Const getStartedTouchIdentifier

    Const getStartedTouchOrMouseCount

    Const getStartedTouchOrMouseIdentifier

    Const getTouchX

    Const getTouchY

    Const hasAnyTouchOrMouseStarted

    Const hasAnyTouchStarted

    Const hasTouchEnded

    Const hideCursor

    Const isKeyPressed

    Variables

    keysNameToCode

    keysNameToCode: { Add: number; Back: number; BackSlash: number; Comma: number; Dash: number; Delete: number; Divide: number; Down: number; End: number; Equal: number; Escape: number; F1: number; F10: number; F11: number; F12: number; F2: number; F3: number; F4: number; F5: number; F6: number; F7: number; F8: number; F9: number; Home: number; Insert: number; LAlt: number; LBracket: number; LControl: number; LShift: number; LSystem: number; Left: number; Menu: number; Multiply: number; Num0: number; Num1: number; Num2: number; Num3: number; Num4: number; Num5: number; Num6: number; Num7: number; Num8: number; Num9: number; Numpad0: number; Numpad1: number; Numpad2: number; Numpad3: number; Numpad4: number; Numpad5: number; Numpad6: number; Numpad7: number; Numpad8: number; Numpad9: number; NumpadAdd: number; NumpadDivide: number; NumpadDown: number; NumpadEnd: number; NumpadHome: number; NumpadLeft: number; NumpadMultiply: number; NumpadPageDown: number; NumpadPageUp: number; NumpadReturn: number; NumpadRight: number; NumpadSubtract: number; NumpadUp: number; PageDown: number; PageUp: number; Pause: number; Period: number; Quote: number; RAlt: number; RBracket: number; RControl: number; RShift: number; RSystem: number; Return: number; Right: number; SemiColon: number; Slash: number; Space: number; Subtract: number; Tab: number; Tilde: number; Up: number; a: number; b: number; c: number; d: number; e: number; f: number; g: number; h: number; i: number; j: number; k: number; l: number; m: number; n: number; o: number; p: number; q: number; r: number; s: number; t: number; u: number; v: number; w: number; x: number; y: number; z: number } = ...

    Hashmap associated each name of a key to its location-aware keyCode.

    memberof

    gdjs.evtTools

    -

    Type declaration

    • Add: number
    • Back: number
    • BackSlash: number
    • Comma: number
    • Dash: number
    • Delete: number
    • Divide: number
    • Down: number
    • End: number
    • Equal: number
    • Escape: number
    • F1: number
    • F10: number
    • F11: number
    • F12: number
    • F2: number
    • F3: number
    • F4: number
    • F5: number
    • F6: number
    • F7: number
    • F8: number
    • F9: number
    • Home: number
    • Insert: number
    • LAlt: number
    • LBracket: number
    • LControl: number
    • LShift: number
    • LSystem: number
    • Left: number
    • Menu: number
    • Multiply: number
    • Num0: number
    • Num1: number
    • Num2: number
    • Num3: number
    • Num4: number
    • Num5: number
    • Num6: number
    • Num7: number
    • Num8: number
    • Num9: number
    • Numpad0: number
    • Numpad1: number
    • Numpad2: number
    • Numpad3: number
    • Numpad4: number
    • Numpad5: number
    • Numpad6: number
    • Numpad7: number
    • Numpad8: number
    • Numpad9: number
    • NumpadAdd: number
    • NumpadDivide: number
    • NumpadDown: number
    • NumpadEnd: number
    • NumpadHome: number
    • NumpadLeft: number
    • NumpadMultiply: number
    • NumpadPageDown: number
    • NumpadPageUp: number
    • NumpadReturn: number
    • NumpadRight: number
    • NumpadSubtract: number
    • NumpadUp: number
    • PageDown: number
    • PageUp: number
    • Pause: number
    • Period: number
    • Quote: number
    • RAlt: number
    • RBracket: number
    • RControl: number
    • RShift: number
    • RSystem: number
    • Return: number
    • Right: number
    • SemiColon: number
    • Slash: number
    • Space: number
    • Subtract: number
    • Tab: number
    • Tilde: number
    • Up: number
    • a: number
    • b: number
    • c: number
    • d: number
    • e: number
    • f: number
    • g: number
    • h: number
    • i: number
    • j: number
    • k: number
    • l: number
    • m: number
    • n: number
    • o: number
    • p: number
    • q: number
    • r: number
    • s: number
    • t: number
    • u: number
    • v: number
    • w: number
    • x: number
    • y: number
    • z: number

    lastEndedTouchId

    lastEndedTouchId: number = 0
    deprecated

    lastTouchId

    lastTouchId: number = 0
    deprecated

    mouseButtonsNameToCode

    mouseButtonsNameToCode: { Back: number; Forward: number; Left: number; Middle: number; Right: number } = ...
    +

    Type declaration

    • Add: number
    • Back: number
    • BackSlash: number
    • Comma: number
    • Dash: number
    • Delete: number
    • Divide: number
    • Down: number
    • End: number
    • Equal: number
    • Escape: number
    • F1: number
    • F10: number
    • F11: number
    • F12: number
    • F2: number
    • F3: number
    • F4: number
    • F5: number
    • F6: number
    • F7: number
    • F8: number
    • F9: number
    • Home: number
    • Insert: number
    • LAlt: number
    • LBracket: number
    • LControl: number
    • LShift: number
    • LSystem: number
    • Left: number
    • Menu: number
    • Multiply: number
    • Num0: number
    • Num1: number
    • Num2: number
    • Num3: number
    • Num4: number
    • Num5: number
    • Num6: number
    • Num7: number
    • Num8: number
    • Num9: number
    • Numpad0: number
    • Numpad1: number
    • Numpad2: number
    • Numpad3: number
    • Numpad4: number
    • Numpad5: number
    • Numpad6: number
    • Numpad7: number
    • Numpad8: number
    • Numpad9: number
    • NumpadAdd: number
    • NumpadDivide: number
    • NumpadDown: number
    • NumpadEnd: number
    • NumpadHome: number
    • NumpadLeft: number
    • NumpadMultiply: number
    • NumpadPageDown: number
    • NumpadPageUp: number
    • NumpadReturn: number
    • NumpadRight: number
    • NumpadSubtract: number
    • NumpadUp: number
    • PageDown: number
    • PageUp: number
    • Pause: number
    • Period: number
    • Quote: number
    • RAlt: number
    • RBracket: number
    • RControl: number
    • RShift: number
    • RSystem: number
    • Return: number
    • Right: number
    • SemiColon: number
    • Slash: number
    • Space: number
    • Subtract: number
    • Tab: number
    • Tilde: number
    • Up: number
    • a: number
    • b: number
    • c: number
    • d: number
    • e: number
    • f: number
    • g: number
    • h: number
    • i: number
    • j: number
    • k: number
    • l: number
    • m: number
    • n: number
    • o: number
    • p: number
    • q: number
    • r: number
    • s: number
    • t: number
    • u: number
    • v: number
    • w: number
    • x: number
    • y: number
    • z: number

    lastEndedTouchId

    lastEndedTouchId: number = 0
    deprecated

    lastTouchId

    lastTouchId: number = 0
    deprecated

    mouseButtonsNameToCode

    mouseButtonsNameToCode: { Back: number; Forward: number; Left: number; Middle: number; Right: number } = ...

    A hashmap associates each name of a mouse button with its respective code.

    memberof

    gdjs.evtTools

    Type declaration

    • Back: number
    • Forward: number
    • Left: number
    • Middle: number
    • Right: number

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace inventory

    Index

    Functions

    Functions

    Const add

    Const count

    Const equip

    Const has

    Const isEquipped

    Const isFull

    Const maximum

    Const remove

    Const serializeToVariable

    Const setMaximum

    Const setUnlimited

    Const unserializeFromVariable

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace inventory

    Index

    Functions

    Functions

    Const add

    Const count

    Const equip

    Const has

    Const isEquipped

    Const isFull

    Const maximum

    Const remove

    Const serializeToVariable

    Const setMaximum

    Const setUnlimited

    Const unserializeFromVariable

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace leaderboards

    Index

    Functions

    Functions

    Const closeLeaderboardView

    Const displayLeaderboard

    • displayLeaderboard(runtimeScene: RuntimeScene, leaderboardId: string, displayLoader: boolean): Promise<void>

    Const formatPlayerName

    • formatPlayerName(rawName?: null | string): string

    Const getLastSaveError

    • getLastSaveError(leaderboardId?: string): null | string

    Const hasBeenSaved

    • hasBeenSaved(leaderboardId?: string): boolean

    Const hasPlayerJustClosedLeaderboardView

    • hasPlayerJustClosedLeaderboardView(): boolean
    • +leaderboards | GDevelop JavaScript game engine
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Namespace leaderboards

      Index

      Functions

      Functions

      Const closeLeaderboardView

      Const displayLeaderboard

      • displayLeaderboard(runtimeScene: RuntimeScene, leaderboardId: string, displayLoader: boolean): Promise<void>

      Const formatPlayerName

      • formatPlayerName(rawName?: null | string): string

      Const getLastSaveError

      • getLastSaveError(leaderboardId?: string): null | string

      Const hasBeenSaved

      • hasBeenSaved(leaderboardId?: string): boolean

      Const hasPlayerJustClosedLeaderboardView

      • hasPlayerJustClosedLeaderboardView(): boolean

      Const hasSavingErrored

      • hasSavingErrored(leaderboardId?: string): boolean

      Const isLeaderboardViewErrored

      • isLeaderboardViewErrored(): boolean

      Const isLeaderboardViewLoaded

      • isLeaderboardViewLoaded(): boolean

      Const isLeaderboardViewLoading

      • isLeaderboardViewLoading(): boolean

      Const isSaving

      • isSaving(leaderboardId?: string): boolean

      Const saveConnectedPlayerScore

      Const savePlayerScore

      • savePlayerScore(runtimeScene: RuntimeScene, leaderboardId: string, score: number, playerName: string): PromiseTask<void>

      Const setPreferSendConnectedPlayerScore

      • setPreferSendConnectedPlayerScore(runtimeScene: RuntimeScene, enable: boolean): void

      Settings

      Theme

      Generated using TypeDoc

      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Namespace linkedObjects

      Index

      Functions

      Functions

      Const linkObjects

      Const pickObjectsLinkedTo

      Const removeAllLinksOf

      Const removeLinkBetween

      Settings

      Theme

      Generated using TypeDoc

      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Namespace linkedObjects

      Index

      Functions

      Functions

      Const linkObjects

      Const pickObjectsLinkedTo

      Const removeAllLinksOf

      Const removeLinkBetween

      Settings

      Theme

      Generated using TypeDoc

      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Namespace network

      Index

      Functions

      Functions

      Const enableMetrics

      Const jsonToObjectVariableStructure

      Const jsonToVariableStructure

      • jsonToVariableStructure(jsonStr: string, variable: Variable): void

      Const sendAwaitableAsyncRequest

      • sendAwaitableAsyncRequest(url: string, body: string, method: string, contentType: string, responseVar: Variable, errorVar: Variable): PromiseTask<void>

      Const sendDeprecatedSynchronousRequest

      • sendDeprecatedSynchronousRequest(host: any, uri: any, body: any, method: any, contentType: any, responseVar: any): void

      Const variableStructureToJSON

      • variableStructureToJSON(variable: Variable): string

      Returns void

    Const sendAwaitableAsyncRequest

    • sendAwaitableAsyncRequest(url: string, body: string, method: string, contentType: string, responseVar: Variable, errorVar: Variable): PromiseTask<void>

    Const sendDeprecatedSynchronousRequest

    • sendDeprecatedSynchronousRequest(host: any, uri: any, body: any, method: any, contentType: any, responseVar: any): void

    Const variableStructureToJSON

    • variableStructureToJSON(variable: Variable): string

    Const forceUseRelayServer

    • forceUseRelayServer(shouldUseRelayServer: boolean): void

    • Forces the usage of a relay (TURN) server, to avoid sharing IP addresses with the other peers.

      Parameters

      • shouldUseRelayServer: boolean

        Whether relay-only should be enabled or disabled.

        -

      Returns void

    Const getConnectedPeer

    • getConnectedPeer(): string

    Returns void

    Const getConnectedPeer

    • getConnectedPeer(): string

    Const getConnectionInstance

    • getConnectionInstance(peerID: string): undefined | DataConnection<NetworkEvent>

    Const getConnectionInstance

    • getConnectionInstance(peerID: string): undefined | DataConnection<NetworkEvent>

    • A JavaScript-only function to get the raw P2P DataConnection. This can be useful for example when you want to use a binary protocol instead of GDevelop variables for high-performance networking.

      -

      Parameters

      • peerID: string

      Returns undefined | DataConnection<NetworkEvent>

    Const getCurrentId

    • getCurrentId(): string

    Const getCurrentId

    • getCurrentId(): string

    Const getDisconnectedPeer

    • getDisconnectedPeer(): string

    Const getDisconnectedPeer

    • getDisconnectedPeer(): string

    Const getEvent

    • getEvent(name: string): IEvent

    Const getEvent

    • getEvent(name: string): IEvent

    Const getEventData

    • getEventData(eventName: string): string

    Const getEventData

    • getEventData(eventName: string): string

    • Get some data associated to the last trigger of an event.

      Parameters

      • eventName: string

        The event to get data from.

      Returns string

      • The data as JSON.
      -

    Const getEventSender

    • getEventSender(eventName: string): string

    Const getEventSender

    • getEventSender(eventName: string): string

    • Get the id of peer that caused the last trigger of an event.

      Parameters

      • eventName: string

        The event to get the sender from.

        -

      Returns string

    Const getEventVariable

    • getEventVariable(eventName: string, variable: Variable): void

    Returns string

    Const getEventVariable

    • getEventVariable(eventName: string, variable: Variable): void

    • Get a variable associated to the last trigger of an event.

      Parameters

      • eventName: string

        The event to get the variable from.

      • variable: Variable

        The variable where to store the variable content.

        -

      Returns void

    Const getLastError

    • getLastError(): string

    Returns void

    Const getLastError

    • getLastError(): string

    Const isReady

    • isReady(): boolean

    Const isReady

    • isReady(): boolean

    Const onConnection

    • onConnection(): boolean

    Const onConnection

    • onConnection(): boolean

    Const onDisconnect

    • onDisconnect(): boolean

    Const onDisconnect

    • onDisconnect(): boolean

    Const onError

    • onError(): boolean

    Const onError

    • onError(): boolean

    Const onEvent

    • onEvent(eventName: string, defaultDataLoss: boolean): boolean

    Const onEvent

    • onEvent(eventName: string, defaultDataLoss: boolean): boolean

    • Returns true when the event got triggered by another p2p client.

      Parameters

      • eventName: string
      • defaultDataLoss: boolean

        Is data loss allowed (accelerates event handling when true)?

        -

      Returns boolean

    Const overrideId

    • overrideId(id: string): void

    Returns boolean

    Const overrideId

    • overrideId(id: string): void

    • Overrides the default peer ID. Must be called before connecting to a broker. Overriding the ID may have unwanted consequences. Do not use this feature unless you really know what you are doing.

      Parameters

      • id: string

        The peer ID to use when connecting to a broker.

        -

      Returns void

    Const sendDataTo

    • sendDataTo(id: string, eventName: string, eventData: string): void

    Returns void

    Const sendDataTo

    • sendDataTo(id: string, eventName: string, eventData: string): void

    • Send an event to one specific connected client.

      Parameters

      • id: string

        The ID of the client to send the event to.

      • eventName: string

        The event to trigger.

        -
      • eventData: string

      Returns void

    Const sendDataToAll

    • sendDataToAll(eventName: string, eventData: string): void

    Returns void

    Const sendDataToAll

    • sendDataToAll(eventName: string, eventData: string): void

    • Send an event to all connected clients.

      Parameters

      • eventName: string

        The event to trigger.

        -
      • eventData: string

      Returns void

    Const sendVariableTo

    • sendVariableTo(id: string, eventName: string, variable: Variable): void

    Returns void

    Const sendVariableTo

    • sendVariableTo(id: string, eventName: string, variable: Variable): void

    • Send an event to one specific connected client.

      Parameters

      • id: string

        The ID of the client to send the event to.

        @@ -87,13 +87,13 @@

        The event to trigger.

      • variable: Variable

        Additional variable to send with the event.

        -

      Returns void

    Const sendVariableToAll

    • sendVariableToAll(eventName: string, variable: Variable): void

    Returns void

    Const sendVariableToAll

    • sendVariableToAll(eventName: string, variable: Variable): void

    • Send an event to all connected clients.

      Parameters

      • eventName: string

        The event to trigger.

      • variable: Variable

        Additional variable to send with the event.

        -

      Returns void

    Const useCustomBrokerServer

    • useCustomBrokerServer(host: string, port: number, path: string, key: string, ssl: boolean): void

    Returns void

    Const useCustomBrokerServer

    • useCustomBrokerServer(host: string, port: number, path: string, key: string, ssl: boolean): void

    • Connects to a custom broker server.

      Parameters

      • host: string

        The host of the broker server.

        @@ -105,7 +105,7 @@

        Optional password to connect to the broker server.

      • ssl: boolean

        Use ssl?

        -

      Returns void

    Const useCustomICECandidate

    • useCustomICECandidate(urls: string, username?: string, credential?: string): void

    Returns void

    Const useCustomICECandidate

    • useCustomICECandidate(urls: string, username?: string, credential?: string): void

    • Adds an ICE server candidate, and removes the default ones provided by PeerJs. Must be called before connecting to a broker.

      Parameters

      • urls: string

        The URL of the STUN/TURN server.

        @@ -113,7 +113,7 @@

        An optional username to send to the server.

      • Optional credential: string

        An optional password to send to the server.

        -

      Returns void

    Const useDefaultBrokerServer

    • useDefaultBrokerServer(): void

    Returns void

    Const useDefaultBrokerServer

    • useDefaultBrokerServer(): void

    • Use default broker server. This is not recommended for published games, this server should only be used for quick testing in development.

      diff --git a/GDJS Runtime Documentation/modules/gdjs.evtTools.platform.html b/GDJS Runtime Documentation/modules/gdjs.evtTools.platform.html index 2f813341f..5923f8107 100644 --- a/GDJS Runtime Documentation/modules/gdjs.evtTools.platform.html +++ b/GDJS Runtime Documentation/modules/gdjs.evtTools.platform.html @@ -1,4 +1,4 @@ -platform | GDevelop JavaScript game engine
      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Namespace platform

      Index

      Functions

      Functions

      Const isOnPlatform

      • isOnPlatform(objectsLists1: Hashtable<RuntimeObject[]>, behaviorName: string, objectsLists2: Hashtable<RuntimeObject[]>, inverted: boolean): boolean

      Settings

      Theme

      Generated using TypeDoc

      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Namespace platform

      Index

      Functions

      Functions

      Const isOnPlatform

      • isOnPlatform(objectsLists1: Hashtable<RuntimeObject[]>, behaviorName: string, objectsLists2: Hashtable<RuntimeObject[]>, inverted: boolean): boolean

      Settings

      Theme

      Generated using TypeDoc

      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Namespace runtimeScene

      Index

      Classes

      Functions

      Functions

      Const areSceneAssetsLoaded

      • areSceneAssetsLoaded(runtimeScene: RuntimeScene, sceneName: string): boolean
      • +runtimeScene | GDevelop JavaScript game engine
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Namespace runtimeScene

        Index

        Classes

        Functions

        Functions

        Const areSceneAssetsLoaded

        • areSceneAssetsLoaded(runtimeScene: RuntimeScene, sceneName: string): boolean

        Const createObjectsFromExternalLayout

        • createObjectsFromExternalLayout(scene: RuntimeInstanceContainer, externalLayout: string, xPos: number, yPos: number, zPos: number): void

        Const doesSceneExist

        • doesSceneExist(runtimeScene: RuntimeScene, sceneName: string): boolean

        Const createObjectsFromExternalLayout

        • createObjectsFromExternalLayout(scene: RuntimeInstanceContainer, externalLayout: string, xPos: number, yPos: number, zPos: number): void

        Const doesSceneExist

        • doesSceneExist(runtimeScene: RuntimeScene, sceneName: string): boolean

        Const getElapsedTimeInSeconds

        Const getSceneLoadingProgress

        • getSceneLoadingProgress(runtimeScene: RuntimeScene, sceneName: string): number

        Const getSceneName

        Const getTime

        Const getTimeFromStartInSeconds

        • getTimeFromStartInSeconds(runtimeScene: RuntimeScene): number

        Const getTimeScale

        Const getTimerElapsedTimeInSeconds

        • getTimerElapsedTimeInSeconds(runtimeScene: RuntimeScene, timerName: string): number

        Const getElapsedTimeInSeconds

        Const getSceneLoadingProgress

        • getSceneLoadingProgress(runtimeScene: RuntimeScene, sceneName: string): number

        Const getSceneName

        Const getTime

        Const getTimeFromStartInSeconds

        • getTimeFromStartInSeconds(runtimeScene: RuntimeScene): number

        Const getTimeScale

        Const getTimerElapsedTimeInSeconds

        • getTimerElapsedTimeInSeconds(runtimeScene: RuntimeScene, timerName: string): number

        • This is used by expressions to return 0 when a timer doesn't exist, because numeric expressions must always return a number.

          Parameters

          • runtimeScene: RuntimeScene
            @@ -11,7 +11,7 @@
          • timerName: string

            The timer name.

          Returns number

          The timer elapsed time in seconds or 0 if the timer doesn't exist.

          -

        Const getTimerElapsedTimeInSecondsOrNaN

        • getTimerElapsedTimeInSecondsOrNaN(runtimeScene: RuntimeScene, timerName: string): number

        Const getTimerElapsedTimeInSecondsOrNaN

        • getTimerElapsedTimeInSecondsOrNaN(runtimeScene: RuntimeScene, timerName: string): number

        • This is used by conditions to return false when a timer doesn't exist, no matter the relational operator.

          Parameters

          • runtimeScene: RuntimeScene
            @@ -19,11 +19,11 @@
          • timerName: string

            The timer name.

          Returns number

          The timer elapsed time in seconds or NaN if the timer doesn't exist.

          -

        Const hasGameJustResumed

        Const hasGameJustResumed

        Const pauseTimer

        • pauseTimer(runtimeScene: RuntimeScene, timerName: string): void

        Const popScene

        Const prioritizeLoadingOfScene

        • prioritizeLoadingOfScene(runtimeScene: RuntimeScene, sceneName: string): void

        Const pauseTimer

        • pauseTimer(runtimeScene: RuntimeScene, timerName: string): void

        Const popScene

        Const prioritizeLoadingOfScene

        • prioritizeLoadingOfScene(runtimeScene: RuntimeScene, sceneName: string): void

        Const pushScene

        • pushScene(runtimeScene: RuntimeScene, newSceneName: string): void

        Const removeTimer

        • removeTimer(runtimeScene: RuntimeScene, timerName: string): void

        Const replaceScene

        • replaceScene(runtimeScene: RuntimeScene, newSceneName: string, clearOthers: boolean): void

        Const resetTimer

        • resetTimer(runtimeScene: RuntimeScene, timerName: string): void

        Const sceneJustBegins

        Const sceneJustResumed

        Const setBackgroundColor

        • setBackgroundColor(runtimeScene: RuntimeScene, rgbColor: string): void

        Const setTimeScale

        • setTimeScale(runtimeScene: RuntimeScene, timeScale: number): void

        Const stopGame

        Const timerElapsedTime

        • timerElapsedTime(runtimeScene: RuntimeScene, timeInSeconds: number, timerName: string): boolean

        Const pushScene

        • pushScene(runtimeScene: RuntimeScene, newSceneName: string): void

        Const removeTimer

        • removeTimer(runtimeScene: RuntimeScene, timerName: string): void

        Const replaceScene

        • replaceScene(runtimeScene: RuntimeScene, newSceneName: string, clearOthers: boolean): void

        Const resetTimer

        • resetTimer(runtimeScene: RuntimeScene, timerName: string): void

        Const sceneJustBegins

        Const sceneJustResumed

        Const setBackgroundColor

        • setBackgroundColor(runtimeScene: RuntimeScene, rgbColor: string): void

        Const setTimeScale

        • setTimeScale(runtimeScene: RuntimeScene, timeScale: number): void

        Const stopGame

        Const timerElapsedTime

        • timerElapsedTime(runtimeScene: RuntimeScene, timeInSeconds: number, timerName: string): boolean

        • Test a timer elapsed time, if the timer doesn't exist it is created.

          deprecated

          prefer using getTimerElapsedTimeInSecondsOrNaN

          Parameters

          • runtimeScene: RuntimeScene
            @@ -33,7 +33,7 @@
          • timerName: string

            The timer name

          Returns boolean

          True if the timer exists and its value is greater than or equal than the given time, false otherwise

          -

        Const timerPaused

        • timerPaused(runtimeScene: RuntimeScene, timerName: string): boolean

        Const unpauseTimer

        • unpauseTimer(runtimeScene: RuntimeScene, timerName: string): void

        Const wait

        Settings

        Theme

        Generated using TypeDoc

        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Namespace shopify

        Index

        Functions

        Functions

        Const buildClient

        • buildClient(instanceContainer: RuntimeInstanceContainer, name: string, domain: string, appId: string, accessToken: string): void

        Const getCheckoutUrlForProduct

        • getCheckoutUrlForProduct(instanceContainer: RuntimeInstanceContainer, name: string, productId: string, quantity: number, variantIndex: number, successVariable: Variable, errorVariable: Variable): void

        Settings

        Theme

        Generated using TypeDoc

        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Namespace shopify

        Index

        Functions

        Functions

        Const buildClient

        • buildClient(instanceContainer: RuntimeInstanceContainer, name: string, domain: string, appId: string, accessToken: string): void

        Const getCheckoutUrlForProduct

        • getCheckoutUrlForProduct(instanceContainer: RuntimeInstanceContainer, name: string, productId: string, quantity: number, variantIndex: number, successVariable: Variable, errorVariable: Variable): void

        Settings

        Theme

        Generated using TypeDoc

        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Namespace sound

        Index

        Functions

        Functions

        Const continueMusicOnChannel

        • continueMusicOnChannel(runtimeScene: RuntimeScene, channel: number): void

        Const continueSoundOnChannel

        • continueSoundOnChannel(runtimeScene: RuntimeScene, channel: number): void

        Const fadeMusicVolume

        • fadeMusicVolume(runtimeScene: RuntimeScene, channel: number, toVolume: number, timeOfFade: number): void

        Const fadeSoundVolume

        • fadeSoundVolume(runtimeScene: RuntimeScene, channel: number, toVolume: number, timeOfFade: number): void

        Const getGlobalVolume

        Const getMusicOnChannelPitch

        • getMusicOnChannelPitch(runtimeScene: RuntimeScene, channel: number): number

        Const getMusicOnChannelPlayingOffset

        • getMusicOnChannelPlayingOffset(runtimeScene: RuntimeScene, channel: number): number

        Const getMusicOnChannelVolume

        • getMusicOnChannelVolume(runtimeScene: RuntimeScene, channel: number): number

        Const getSoundOnChannelPitch

        • getSoundOnChannelPitch(runtimeScene: RuntimeScene, channel: number): number

        Const getSoundOnChannelPlayingOffset

        • getSoundOnChannelPlayingOffset(runtimeScene: RuntimeScene, channel: number): number

        Const getSoundOnChannelVolume

        • getSoundOnChannelVolume(runtimeScene: RuntimeScene, channel: number): number

        Const isMusicOnChannelPaused

        • isMusicOnChannelPaused(runtimeScene: RuntimeScene, channel: number): boolean

        Const isMusicOnChannelPlaying

        • isMusicOnChannelPlaying(runtimeScene: RuntimeScene, channel: number): boolean

        Const isMusicOnChannelStopped

        • isMusicOnChannelStopped(runtimeScene: RuntimeScene, channel: number): boolean

        Const isSoundOnChannelPaused

        • isSoundOnChannelPaused(runtimeScene: RuntimeScene, channel: number): boolean

        Const isSoundOnChannelPlaying

        • isSoundOnChannelPlaying(runtimeScene: RuntimeScene, channel: number): boolean

        Const isSoundOnChannelStopped

        • isSoundOnChannelStopped(runtimeScene: RuntimeScene, channel: number): boolean

        Const pauseMusicOnChannel

        • pauseMusicOnChannel(runtimeScene: RuntimeScene, channel: number): void

        Const pauseSoundOnChannel

        • pauseSoundOnChannel(runtimeScene: RuntimeScene, channel: number): void

        Const playMusic

        • playMusic(runtimeScene: RuntimeScene, soundFile: string, loop: boolean, volume: number, pitch: number): void

        Const playMusicOnChannel

        • playMusicOnChannel(runtimeScene: RuntimeScene, soundFile: string, channel: number, loop: boolean, volume: number, pitch: number): void

        Const playSound

        • playSound(runtimeScene: RuntimeScene, soundFile: string, loop: boolean, volume: number, pitch: number): void

        Const playSoundOnChannel

        • playSoundOnChannel(runtimeScene: RuntimeScene, soundFile: string, channel: number, loop: boolean, volume: number, pitch: number): void

        Const preloadMusic

        • preloadMusic(runtimeScene: RuntimeScene, soundFile: string): void

        Const preloadSound

        • preloadSound(runtimeScene: RuntimeScene, soundFile: string): void

        Const setGlobalVolume

        • setGlobalVolume(runtimeScene: RuntimeScene, globalVolume: number): void

        Const setMusicOnChannelPitch

        • setMusicOnChannelPitch(runtimeScene: RuntimeScene, channel: number, pitch: number): void

        Const setMusicOnChannelPlayingOffset

        • setMusicOnChannelPlayingOffset(runtimeScene: RuntimeScene, channel: number, playingOffset: number): void

        Const setMusicOnChannelVolume

        • setMusicOnChannelVolume(runtimeScene: RuntimeScene, channel: number, volume: number): void

        Const setSoundOnChannelPitch

        • setSoundOnChannelPitch(runtimeScene: RuntimeScene, channel: number, pitch: number): void

        Const setSoundOnChannelPlayingOffset

        • setSoundOnChannelPlayingOffset(runtimeScene: RuntimeScene, channel: number, playingOffset: number): void

        Const setSoundOnChannelVolume

        • setSoundOnChannelVolume(runtimeScene: RuntimeScene, channel: number, volume: number): void

        Const stopMusicOnChannel

        • stopMusicOnChannel(runtimeScene: RuntimeScene, channel: number): void

        Const stopSoundOnChannel

        • stopSoundOnChannel(runtimeScene: RuntimeScene, channel: number): void

        Const unloadAllAudio

        Const unloadMusic

        • unloadMusic(runtimeScene: RuntimeScene, soundFile: string): void

        Const unloadSound

        • unloadSound(runtimeScene: RuntimeScene, soundFile: string): void

        Settings

        Theme

        Generated using TypeDoc

        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Namespace sound

        Index

        Functions

        Functions

        Const continueMusicOnChannel

        • continueMusicOnChannel(runtimeScene: RuntimeScene, channel: number): void

        Const continueSoundOnChannel

        • continueSoundOnChannel(runtimeScene: RuntimeScene, channel: number): void

        Const fadeMusicVolume

        • fadeMusicVolume(runtimeScene: RuntimeScene, channel: number, toVolume: number, timeOfFade: number): void

        Const fadeSoundVolume

        • fadeSoundVolume(runtimeScene: RuntimeScene, channel: number, toVolume: number, timeOfFade: number): void

        Const getGlobalVolume

        Const getMusicOnChannelPitch

        • getMusicOnChannelPitch(runtimeScene: RuntimeScene, channel: number): number

        Const getMusicOnChannelPlayingOffset

        • getMusicOnChannelPlayingOffset(runtimeScene: RuntimeScene, channel: number): number

        Const getMusicOnChannelVolume

        • getMusicOnChannelVolume(runtimeScene: RuntimeScene, channel: number): number

        Const getSoundOnChannelPitch

        • getSoundOnChannelPitch(runtimeScene: RuntimeScene, channel: number): number

        Const getSoundOnChannelPlayingOffset

        • getSoundOnChannelPlayingOffset(runtimeScene: RuntimeScene, channel: number): number

        Const getSoundOnChannelVolume

        • getSoundOnChannelVolume(runtimeScene: RuntimeScene, channel: number): number

        Const isMusicOnChannelPaused

        • isMusicOnChannelPaused(runtimeScene: RuntimeScene, channel: number): boolean

        Const isMusicOnChannelPlaying

        • isMusicOnChannelPlaying(runtimeScene: RuntimeScene, channel: number): boolean

        Const isMusicOnChannelStopped

        • isMusicOnChannelStopped(runtimeScene: RuntimeScene, channel: number): boolean

        Const isSoundOnChannelPaused

        • isSoundOnChannelPaused(runtimeScene: RuntimeScene, channel: number): boolean

        Const isSoundOnChannelPlaying

        • isSoundOnChannelPlaying(runtimeScene: RuntimeScene, channel: number): boolean

        Const isSoundOnChannelStopped

        • isSoundOnChannelStopped(runtimeScene: RuntimeScene, channel: number): boolean

        Const pauseMusicOnChannel

        • pauseMusicOnChannel(runtimeScene: RuntimeScene, channel: number): void

        Const pauseSoundOnChannel

        • pauseSoundOnChannel(runtimeScene: RuntimeScene, channel: number): void

        Const playMusic

        • playMusic(runtimeScene: RuntimeScene, soundFile: string, loop: boolean, volume: number, pitch: number): void

        Const playMusicOnChannel

        • playMusicOnChannel(runtimeScene: RuntimeScene, soundFile: string, channel: number, loop: boolean, volume: number, pitch: number): void

        Const playSound

        • playSound(runtimeScene: RuntimeScene, soundFile: string, loop: boolean, volume: number, pitch: number): void

        Const playSoundOnChannel

        • playSoundOnChannel(runtimeScene: RuntimeScene, soundFile: string, channel: number, loop: boolean, volume: number, pitch: number): void

        Const preloadMusic

        • preloadMusic(runtimeScene: RuntimeScene, soundFile: string): void

        Const preloadSound

        • preloadSound(runtimeScene: RuntimeScene, soundFile: string): void

        Const setGlobalVolume

        • setGlobalVolume(runtimeScene: RuntimeScene, globalVolume: number): void

        Const setMusicOnChannelPitch

        • setMusicOnChannelPitch(runtimeScene: RuntimeScene, channel: number, pitch: number): void

        Const setMusicOnChannelPlayingOffset

        • setMusicOnChannelPlayingOffset(runtimeScene: RuntimeScene, channel: number, playingOffset: number): void

        Const setMusicOnChannelVolume

        • setMusicOnChannelVolume(runtimeScene: RuntimeScene, channel: number, volume: number): void

        Const setSoundOnChannelPitch

        • setSoundOnChannelPitch(runtimeScene: RuntimeScene, channel: number, pitch: number): void

        Const setSoundOnChannelPlayingOffset

        • setSoundOnChannelPlayingOffset(runtimeScene: RuntimeScene, channel: number, playingOffset: number): void

        Const setSoundOnChannelVolume

        • setSoundOnChannelVolume(runtimeScene: RuntimeScene, channel: number, volume: number): void

        Const stopMusicOnChannel

        • stopMusicOnChannel(runtimeScene: RuntimeScene, channel: number): void

        Const stopSoundOnChannel

        • stopSoundOnChannel(runtimeScene: RuntimeScene, channel: number): void

        Const unloadAllAudio

        Const unloadMusic

        • unloadMusic(runtimeScene: RuntimeScene, soundFile: string): void

        Const unloadSound

        • unloadSound(runtimeScene: RuntimeScene, soundFile: string): void

        Settings

        Theme

        Generated using TypeDoc

        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Namespace spatialSound

        Index

        Functions

        Functions

        Const setSoundPosition

        Settings

        Theme

        Generated using TypeDoc

        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Namespace spatialSound

        Index

        Functions

        Functions

        Const setSoundPosition

        Settings

        Theme

        Generated using TypeDoc

        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Namespace string

        Tools related to strings manipulation, for events generated code.

        -

        Index

        Functions

        Functions

        Const fromCodePoint

        • fromCodePoint(codePoint: any): string

        Index

        Functions

        Functions

        Const fromCodePoint

        • fromCodePoint(codePoint: any): string

        Const newLine

        • newLine(): string

        Const newLine

        • newLine(): string

        Const strAt

        • strAt(str: string, start: number): string

        Const strAt

        • strAt(str: string, start: number): string

        Const strFind

        • strFind(str: string, what: string): number

        Const strFind

        • strFind(str: string, what: string): number

        • Search the first occurrence in a string (return the position of the result, from the beginning of the string, or -1 if not found)

          -

          Parameters

          • str: string
          • what: string

          Returns number

        Const strFindFrom

        • strFindFrom(str: string, what: string, pos: number): number

        Const strFindFrom

        • strFindFrom(str: string, what: string, pos: number): number

        • Search the first occurrence in a string, starting from a specified position (return the position of the result, from the beginning of the string, or -1 if not found)

          -

          Parameters

          • str: string
          • what: string
          • pos: number

          Returns number

        Const strFindLast

        • strFindLast(str: string, what: string): number

        Const strFindLast

        • strFindLast(str: string, what: string): number

        • Search the last occurrence in a string (return the position of the result, from the beginning of the string, or -1 if not found)

          -

          Parameters

          • str: string
          • what: string

          Returns number

        Const strFindLastFrom

        • strFindLastFrom(str: string, what: string, pos: number): number

        Const strFindLastFrom

        • strFindLastFrom(str: string, what: string, pos: number): number

        • Search the last occurrence in a string, starting from a specified position (return the position of the result, from the beginning of the string, or -1 if not found)

          -

          Parameters

          • str: string
          • what: string
          • pos: number

          Returns number

        Const strLen

        • strLen(str: string): number

        Const strLen

        • strLen(str: string): number

        Const strRFind

        • strRFind(str: string, what: string): number

        Const strRFindFrom

        • strRFindFrom(str: string, what: string, pos: number): number

        Const strRepeat

        • strRepeat(str: string, count: number): string

        Const strRFind

        • strRFind(str: string, what: string): number

        Const strRFindFrom

        • strRFindFrom(str: string, what: string, pos: number): number

        Const strRepeat

        • strRepeat(str: string, count: number): string

        Const strReplaceAll

        • strReplaceAll(str: string, pattern: string, replacement: string): string

        Const strReplaceAll

        • strReplaceAll(str: string, pattern: string, replacement: string): string

        • Return a new string with the content of str where all occurrences of pattern are replaced by replacement.

          -

          Parameters

          • str: string
          • pattern: string
          • replacement: string

          Returns string

        Const strReplaceOne

        • strReplaceOne(str: string, pattern: string, replacement: string): string

        Const strReplaceOne

        • strReplaceOne(str: string, pattern: string, replacement: string): string

        • Return a new string with the content of str where the first occurrence of pattern is replaced by replacement.

          -

          Parameters

          • str: string
          • pattern: string
          • replacement: string

          Returns string

        Const subStr

        • subStr(str: string, start: number, len: number): string

        Const subStr

        • subStr(str: string, start: number, len: number): string

        Const toLowerCase

        • toLowerCase(str: string): string

        Const toLowerCase

        • toLowerCase(str: string): string

        Const toUpperCase

        • toUpperCase(str: string): string

        Const toUpperCase

        • toUpperCase(str: string): string

        Settings

        Theme

        Generated using TypeDoc

        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Namespace systemInfo

        Index

        Functions

        Functions

        Const hasTouchScreen

        • hasTouchScreen(): boolean

        Const ease

        • ease(easingValue: string, fromValue: number, toValue: number, weighting: number): number

        • Tween between 2 values according to an easing function.

          Parameters

          • easingValue: string

            Type of easing

            @@ -44,21 +44,21 @@

            End value

          • weighting: number

            from 0 to 1

            -

          Returns number

        Const getProgress

        • getProgress(runtimeScene: RuntimeScene, identifier: string): number

        Returns number

      Const getProgress

      • getProgress(runtimeScene: RuntimeScene, identifier: string): number

      Const getTweensMap

      Const getValue

      • getValue(runtimeScene: RuntimeScene, identifier: string): number

      Const getTweensMap

      Const getValue

      • getValue(runtimeScene: RuntimeScene, identifier: string): number

      Const hslToRgb

      • hslToRgb(h: number, s: number, l: number): number[]

      Const pauseSceneTween

      • pauseSceneTween(runtimeScene: RuntimeScene, id: string): void

      Const removeSceneTween

      • removeSceneTween(runtimeScene: RuntimeScene, id: string): void

      Const resumeSceneTween

      • resumeSceneTween(runtimeScene: RuntimeScene, id: string): void

      Const rgbToHsl

      • rgbToHsl(r: number, g: number, b: number): number[]

      Const sceneTweenExists

      • sceneTweenExists(runtimeScene: RuntimeScene, id: string): boolean

      Const sceneTweenHasFinished

      • sceneTweenHasFinished(runtimeScene: RuntimeScene, id: string): boolean

      Const sceneTweenIsPlaying

      • sceneTweenIsPlaying(runtimeScene: RuntimeScene, id: string): boolean

      Const stopSceneTween

      • stopSceneTween(runtimeScene: RuntimeScene, id: string, shouldGoToEnd: boolean): void

      Const tweenCamera

      • tweenCamera(runtimeScene: RuntimeScene, identifier: string, toX: number, toY: number, layerName: string, duration: number, easing: string): void

      Const tweenCamera2

      • tweenCamera2(runtimeScene: RuntimeScene, identifier: string, toX: number, toY: number, layerName: string, easing: string, duration: number): void

      Const hslToRgb

      • hslToRgb(h: number, s: number, l: number): number[]

      Const pauseSceneTween

      • pauseSceneTween(runtimeScene: RuntimeScene, id: string): void

      Const removeSceneTween

      • removeSceneTween(runtimeScene: RuntimeScene, id: string): void

      Const resumeSceneTween

      • resumeSceneTween(runtimeScene: RuntimeScene, id: string): void

      Const rgbToHsl

      • rgbToHsl(r: number, g: number, b: number): number[]

      Const sceneTweenExists

      • sceneTweenExists(runtimeScene: RuntimeScene, id: string): boolean

      Const sceneTweenHasFinished

      • sceneTweenHasFinished(runtimeScene: RuntimeScene, id: string): boolean

      Const sceneTweenIsPlaying

      • sceneTweenIsPlaying(runtimeScene: RuntimeScene, id: string): boolean

      Const stopSceneTween

      • stopSceneTween(runtimeScene: RuntimeScene, id: string, shouldGoToEnd: boolean): void

      Const tweenCamera

      • tweenCamera(runtimeScene: RuntimeScene, identifier: string, toX: number, toY: number, layerName: string, duration: number, easing: string): void

      Const tweenCamera2

      • tweenCamera2(runtimeScene: RuntimeScene, identifier: string, toX: number, toY: number, layerName: string, easing: string, duration: number): void

      Const tweenCameraRotation

      • tweenCameraRotation(runtimeScene: RuntimeScene, identifier: string, toRotation: number, layerName: string, duration: number, easing: string): void

      Const tweenCameraRotation2

      • tweenCameraRotation2(runtimeScene: RuntimeScene, identifier: string, toRotation: number, layerName: string, easing: string, duration: number): void

      Returns void

    Const tweenCameraRotation

    • tweenCameraRotation(runtimeScene: RuntimeScene, identifier: string, toRotation: number, layerName: string, duration: number, easing: string): void

    Const tweenCameraRotation2

    • tweenCameraRotation2(runtimeScene: RuntimeScene, identifier: string, toRotation: number, layerName: string, easing: string, duration: number): void

    Const tweenCameraZoom

    • tweenCameraZoom(runtimeScene: RuntimeScene, identifier: string, toZoom: number, layerName: string, duration: number, easing: string): void

    Const tweenCameraZoom2

    • tweenCameraZoom2(runtimeScene: RuntimeScene, identifier: string, toZoom: number, layerName: string, easing: string, duration: number): void

    Returns void

    Const tweenCameraZoom

    • tweenCameraZoom(runtimeScene: RuntimeScene, identifier: string, toZoom: number, layerName: string, duration: number, easing: string): void

    Const tweenCameraZoom2

    • tweenCameraZoom2(runtimeScene: RuntimeScene, identifier: string, toZoom: number, layerName: string, easing: string, duration: number): void

    Const tweenColorEffectPropertyTween

    • tweenColorEffectPropertyTween(runtimeScene: RuntimeScene, identifier: string, toColorStr: string, layerName: string, effectName: string, propertyName: string, easing: string, duration: number): void

    Returns void

    Const tweenColorEffectPropertyTween

    • tweenColorEffectPropertyTween(runtimeScene: RuntimeScene, identifier: string, toColorStr: string, layerName: string, effectName: string, propertyName: string, easing: string, duration: number): void

    Const tweenNumberEffectPropertyTween

    • tweenNumberEffectPropertyTween(runtimeScene: RuntimeScene, identifier: string, toValue: number, layerName: string, effectName: string, propertyName: string, easing: string, duration: number): void

    Returns void

    Const tweenNumberEffectPropertyTween

    • tweenNumberEffectPropertyTween(runtimeScene: RuntimeScene, identifier: string, toValue: number, layerName: string, effectName: string, propertyName: string, easing: string, duration: number): void

    Const tweenVariableNumber

    • tweenVariableNumber(runtimeScene: RuntimeScene, identifier: string, variable: Variable, from: number, to: number, duration: number, easing: string): void

    Returns void

    Const tweenVariableNumber

    • tweenVariableNumber(runtimeScene: RuntimeScene, identifier: string, variable: Variable, from: number, to: number, duration: number, easing: string): void
    • deprecated

      Use tweenVariableNumber3 instead. This function is misleading since one could think that the tween starts right at the moment this function is called whereas the value of the variable will change at the next frame only. Moreover, the variable will not start from the start value exactly since time will have passed at the moment the next frame is rendered. See https://github.com/4ian/GDevelop/issues/4270

      -

      Parameters

      • runtimeScene: RuntimeScene
      • identifier: string
      • variable: Variable
      • from: number
      • to: number
      • duration: number
      • easing: string

      Returns void

    Const tweenVariableNumber2

    • tweenVariableNumber2(runtimeScene: RuntimeScene, identifier: string, variable: Variable, toValue: number, duration: number, easing: string): void

    Const tweenVariableNumber3

    • tweenVariableNumber3(runtimeScene: RuntimeScene, identifier: string, variable: Variable, toValue: number, easing: string, duration: number): void

    Const tweenVariableNumber2

    • tweenVariableNumber2(runtimeScene: RuntimeScene, identifier: string, variable: Variable, toValue: number, duration: number, easing: string): void

    Const tweenVariableNumber3

    • tweenVariableNumber3(runtimeScene: RuntimeScene, identifier: string, variable: Variable, toValue: number, easing: string, duration: number): void

    Variables

    easingFunctions

    easingFunctions: Record<string, EasingFunction> = ...

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace variable

    A namespace of functional equivalents to the gdjs.Variable methods, needed for events code generation.

    -
    namespace

    Index

    Functions

    Functions

    Const getFirstVariableNumber

    • getFirstVariableNumber(array: Variable): number

    Index

    Functions

    Functions

    Const getFirstVariableNumber

    • getFirstVariableNumber(array: Variable): number

    Const getFirstVariableString

    • getFirstVariableString(array: Variable): string

    Const getFirstVariableString

    • getFirstVariableString(array: Variable): string

    Const getLastVariableNumber

    • getLastVariableNumber(array: Variable): number

    Const getLastVariableNumber

    • getLastVariableNumber(array: Variable): number

    Const getLastVariableString

    • getLastVariableString(array: Variable): string

    Const getLastVariableString

    • getLastVariableString(array: Variable): string

    Const Private getVariableBoolean

    • getVariableBoolean(variable: Variable, compareWith: boolean): boolean

    Const Private getVariableBoolean

    • getVariableBoolean(variable: Variable, compareWith: boolean): boolean

    • Compares the boolean value of a variable. Equivalent to variable.getAsBoolean() === boolean. This shortcut function is needed for events code generation.

      -

      Parameters

      Returns boolean

    Const Private getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Const Private getVariableChildCount

    • getVariableChildCount(variable: Variable): number

    Const Private getVariableNumber

    • getVariableNumber(variable: Variable): number

    Const Private getVariableNumber

    • getVariableNumber(variable: Variable): number

    Const Private getVariableString

    • getVariableString(variable: Variable): string

    Const Private getVariableString

    • getVariableString(variable: Variable): string

    Const Private globalVariableExists

    Const Private globalVariableExists

    Const Private sceneVariableExists

    • sceneVariableExists(runtimeScene: RuntimeScene, variableName: string): boolean

    Const Private sceneVariableExists

    • sceneVariableExists(runtimeScene: RuntimeScene, variableName: string): boolean

    Const Private setVariableBoolean

    • setVariableBoolean(variable: Variable, newValue: boolean): void

    Const Private setVariableBoolean

    • setVariableBoolean(variable: Variable, newValue: boolean): void

    Const Private toggleVariableBoolean

    • toggleVariableBoolean(variable: Variable): void

    Const Private toggleVariableBoolean

    • toggleVariableBoolean(variable: Variable): void

    Const Private valuePush

    • valuePush(array: Variable, value: string | number | boolean): void

    Const Private valuePush

    • valuePush(array: Variable, value: string | number | boolean): void

    Const Private variableChildExists

    • variableChildExists(variable: Variable, childName: string): boolean

    Const Private variableChildExists

    • variableChildExists(variable: Variable, childName: string): boolean

    Const Private variableClearChildren

    • variableClearChildren(variable: Variable): void

    Const Private variableClearChildren

    • variableClearChildren(variable: Variable): void

    Const Private variablePushCopy

    Const Private variablePushCopy

    Const Private variableRemoveAt

    • variableRemoveAt(array: Variable, index: number): void

    Const Private variableRemoveAt

    • variableRemoveAt(array: Variable, index: number): void

    Const Private variableRemoveChild

    • variableRemoveChild(variable: Variable, childName: string): void

    Const Private variableRemoveChild

    • variableRemoveChild(variable: Variable, childName: string): void

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace window

    Tools related to window, for events generated code.

    -

    Index

    Functions

    Functions

    Const centerWindow

    Const getGameResolutionHeight

    Const getGameResolutionWidth

    Const getWindowInnerHeight

    • getWindowInnerHeight(): number

    Const getWindowInnerWidth

    • getWindowInnerWidth(): number

    Const getWindowTitle

    Const isFullScreen

    Const openURL

    Const setAdaptGameResolutionAtRuntime

    • setAdaptGameResolutionAtRuntime(runtimeScene: RuntimeScene, enable: boolean): void

    Const setFullScreen

    • setFullScreen(runtimeScene: RuntimeScene, enable: boolean, keepAspectRatio: boolean): void

    Const setGameResolutionResizeMode

    • setGameResolutionResizeMode(runtimeScene: RuntimeScene, resizeMode: string): void

    Const setGameResolutionSize

    • setGameResolutionSize(runtimeScene: RuntimeScene, width: number, height: number): void

    Const setMargins

    • setMargins(runtimeScene: RuntimeScene, top: number, right: number, bottom: number, left: number): void

    Const setWindowSize

    • setWindowSize(runtimeScene: RuntimeScene, width: number, height: number, updateGameResolution: boolean): void

    Const setWindowTitle

    • setWindowTitle(runtimeScene: RuntimeScene, title: string): void

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace fileSystem

    Index

    Functions

    Functions

    Const deleteFile

    • deleteFile(filePath: string, resultVar: Variable): void

    Const deleteFileAsync

    • deleteFileAsync(filePath: string, resultVar: Variable): void

    Const deleteFileAsyncTask

    Const getDesktopPath

    Returns void

    Const deleteFileAsyncTask

    Const getDesktopPath

    Const getDirectoryName

    • getDirectoryName(fileOrFolderPath: string): string

    Const getDocumentsPath

    Const getDirectoryName

    • getDirectoryName(fileOrFolderPath: string): string

    Const getDocumentsPath

    Const getExecutableFolderPath

    Const getExecutableFolderPath

    Const getExecutablePath

    Const getExecutablePath

    Const getExtensionName

    • getExtensionName(filePath: string): string

    Const getFileName

    • getFileName(filePath: string): string

    Const getPathDelimiter

    • getPathDelimiter(): string

    Const getExtensionName

    • getExtensionName(filePath: string): string

    Const getFileName

    • getFileName(filePath: string): string

    Const getPathDelimiter

    • getPathDelimiter(): string

    Const getPicturesPath

    Const getPicturesPath

    Const getTempPath

    Const getTempPath

    Const getUserHomePath

    Const getUserHomePath

    Const getUserdataPath

    Const getUserdataPath

    Const loadStringFromFile

    • loadStringFromFile(stringVar: Variable, loadPath: string, resultVar: Variable, removeCRCharacters: boolean): void

    Const loadStringFromFile

    • loadStringFromFile(stringVar: Variable, loadPath: string, resultVar: Variable, removeCRCharacters: boolean): void

    • Load a string from a file into a scene variable.

      Parameters

      • stringVar: Variable

        Variable where to store the content

        @@ -61,7 +61,7 @@

        The variable where to store the result of the operation

      • removeCRCharacters: boolean

        If true, will remove \r characters usually added by Windows when editing files

        -

      Returns void

    Const loadStringFromFileAsync

    • loadStringFromFileAsync(stringVar: Variable, loadPath: string, resultVar: Variable, removeCRCharacters: boolean): void

    Returns void

    Const loadStringFromFileAsync

    • loadStringFromFileAsync(stringVar: Variable, loadPath: string, resultVar: Variable, removeCRCharacters: boolean): void

    • Load a string from a file into a scene variable, asynchronously.

      Parameters

      • stringVar: Variable

        Variable where to store the content

        @@ -71,7 +71,7 @@

        The variable where to store the result of the operation

      • removeCRCharacters: boolean

        If true, will remove \r characters usually added by Windows when editing files

        -

      Returns void

    Const loadStringFromFileAsyncTask

    Const loadVariableFromJSONFile

    • loadVariableFromJSONFile(variable: Variable, loadPath: string, resultVar: Variable, removeCRCharacters: boolean): void

    Returns void

    Const loadStringFromFileAsyncTask

    Const loadVariableFromJSONFile

    • loadVariableFromJSONFile(variable: Variable, loadPath: string, resultVar: Variable, removeCRCharacters: boolean): void

    • Load a JSON file and convert it into a variable.

      Parameters

      • variable: Variable

        Variable to store the variable

        @@ -81,7 +81,7 @@

        The variable where to store the result of the operation

      • removeCRCharacters: boolean

        If true, will remove \r characters usually added by Windows when editing files

        -

      Returns void

    Const loadVariableFromJSONFileAsync

    • loadVariableFromJSONFileAsync(variable: Variable, loadPath: string, resultVar: Variable, removeCRCharacters: boolean): void

    Returns void

    Const loadVariableFromJSONFileAsync

    • loadVariableFromJSONFileAsync(variable: Variable, loadPath: string, resultVar: Variable, removeCRCharacters: boolean): void

    • Load a JSON file and convert it into a variable, asynchronously.

      Parameters

      • variable: Variable

        Variable to store the variable

        @@ -91,18 +91,18 @@

        The variable where to store the result of the operation

      • removeCRCharacters: boolean

        If true, will remove \r characters usually added by Windows when editing files

        -

      Returns void

    Const loadVariableFromJSONFileAsyncTask

    Const makeDirectory

    • makeDirectory(directory: string, resultVar: Variable): void

    Returns void

    Const loadVariableFromJSONFileAsyncTask

    Const makeDirectory

    • makeDirectory(directory: string, resultVar: Variable): void

    Const makeDirectoryAsync

    Const pathExists

    • pathExists(filePath: string): boolean

    Returns void

    Const makeDirectoryAsync

    Const pathExists

    • pathExists(filePath: string): boolean

    Const saveStringToFile

    • saveStringToFile(text: string, savePath: string, resultVar: Variable): void

    Const saveStringToFile

    • saveStringToFile(text: string, savePath: string, resultVar: Variable): void

    Const saveStringToFileAsync

    • saveStringToFileAsync(text: string, savePath: string, resultVar: Variable): void

    Returns void

    Const saveStringToFileAsync

    • saveStringToFileAsync(text: string, savePath: string, resultVar: Variable): void

    • Save a string into a file, asynchronously.

      Parameters

      • text: string

        The string to be saved

        @@ -118,7 +118,7 @@

        Path to the file

      • resultVar: Variable

        The variable where to store the result of the operation

        -

      Returns void

    Const saveStringToFileAsyncTask

    Const saveVariableToJSONFile

    • saveVariableToJSONFile(variable: Variable, savePath: string, resultVar: Variable): void

    Returns void

    Const saveStringToFileAsyncTask

    Const saveVariableToJSONFile

    • saveVariableToJSONFile(variable: Variable, savePath: string, resultVar: Variable): void

    Const saveVariableToJSONFileAsync

    • saveVariableToJSONFileAsync(variable: Variable, savePath: string, resultVar: Variable): void

    Returns void

    Const saveVariableToJSONFileAsync

    • saveVariableToJSONFileAsync(variable: Variable, savePath: string, resultVar: Variable): void

    Const saveVariableToJSONFileAsyncTask

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace gdjs

    Index

    Type aliases

    Classes

    Interfaces

    Variables

    Namespaces

    Enumerations

    Functions

    Type aliases

    AABB

    AABB: { max: FloatPoint; min: FloatPoint }
    +gdjs | GDevelop JavaScript game engine
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace gdjs

    Index

    Type aliases

    Classes

    Interfaces

    Variables

    Namespaces

    Enumerations

    Functions

    Type aliases

    AABB

    AABB: { max: FloatPoint; min: FloatPoint }

    An axis-aligned bounding box. Used to represents a box around an object for example.

    Type declaration

    • max: FloatPoint

      The [x,y] coordinates of the bottom right point

    • min: FloatPoint

      The [x,y] coordinates of the top left point

      -

    Antialiasing

    Antialiasing: "none" | "low" | "medium" | "high"

    BBTextObjectData

    BBTextObjectData: ObjectData & BBTextObjectDataType

    BBTextObjectDataType

    BBTextObjectDataType: { content: { align: "left" | "center" | "right"; color: string; fontFamily: string; fontSize: number; opacity: number; text: string; visible: boolean; wordWrap: boolean } }
    +

    Antialiasing

    Antialiasing: "none" | "low" | "medium" | "high"

    BBTextObjectData

    BBTextObjectData: ObjectData & BBTextObjectDataType

    BBTextObjectDataType

    BBTextObjectDataType: { content: { align: "left" | "center" | "right"; color: string; fontFamily: string; fontSize: number; opacity: number; text: string; visible: boolean; wordWrap: boolean } }

    Base parameters for gdjs.BBTextRuntimeObject

    Type declaration

    • content: { align: "left" | "center" | "right"; color: string; fontFamily: string; fontSize: number; opacity: number; text: string; visible: boolean; wordWrap: boolean }

      The base parameters of the BBText

      @@ -24,7 +24,7 @@

      Deprecated - Is the text visible?

    • wordWrap: boolean

      Activate word wrap if set to true

      -

    BBTextObjectNetworkSyncData

    BBTextObjectNetworkSyncData: ObjectNetworkSyncData & BBTextObjectNetworkSyncDataType

    BBTextObjectNetworkSyncDataType

    BBTextObjectNetworkSyncDataType: { align: string; c: number[]; ff: string; fs: number; hidden: boolean; o: float; text: string; wwidth: float; wwrap: boolean }

    Type declaration

    • align: string
    • c: number[]
    • ff: string
    • fs: number
    • hidden: boolean
    • o: float
    • text: string
    • wwidth: float
    • wwrap: boolean

    BBTextRuntimeObjectRenderer

    BBTextRuntimeObjectRenderer: BBTextRuntimeObjectPixiRenderer

    BitmapFontManager

    BitmapFontManager: PixiBitmapFontManager

    BitmapTextObjectData

    BitmapTextObjectData: ObjectData & BitmapTextObjectDataType

    BitmapTextObjectDataType

    BitmapTextObjectDataType: { content: { align: "left" | "center" | "right"; bitmapFontResourceName: string; opacity: float; scale: float; text: string; textureAtlasResourceName: string; tint: string; wordWrap: boolean; wrappingWidth: float } }
    +

    BBTextObjectNetworkSyncData

    BBTextObjectNetworkSyncData: ObjectNetworkSyncData & BBTextObjectNetworkSyncDataType

    BBTextObjectNetworkSyncDataType

    BBTextObjectNetworkSyncDataType: { align: string; c: number[]; ff: string; fs: number; hidden: boolean; o: float; text: string; wwidth: float; wwrap: boolean }

    Type declaration

    • align: string
    • c: number[]
    • ff: string
    • fs: number
    • hidden: boolean
    • o: float
    • text: string
    • wwidth: float
    • wwrap: boolean

    BBTextRuntimeObjectRenderer

    BBTextRuntimeObjectRenderer: BBTextRuntimeObjectPixiRenderer

    BitmapFontManager

    BitmapFontManager: PixiBitmapFontManager

    BitmapTextObjectData

    BitmapTextObjectData: ObjectData & BitmapTextObjectDataType

    BitmapTextObjectDataType

    BitmapTextObjectDataType: { content: { align: "left" | "center" | "right"; bitmapFontResourceName: string; opacity: float; scale: float; text: string; textureAtlasResourceName: string; tint: string; wordWrap: boolean; wrappingWidth: float } }

    Base parameters for gdjs.BitmapTextRuntimeObject

    Type declaration

    • content: { align: "left" | "center" | "right"; bitmapFontResourceName: string; opacity: float; scale: float; text: string; textureAtlasResourceName: string; tint: string; wordWrap: boolean; wrappingWidth: float }

      The base parameters of the Bitmap Text

      @@ -46,9 +46,9 @@

      Activate word wrap if set to true.

    • wrappingWidth: float

      Wrapping with from custom size properties.

      -

    BitmapTextObjectNetworkSyncData

    BitmapTextObjectNetworkSyncData: ObjectNetworkSyncData & BitmapTextObjectNetworkSyncDataType

    BitmapTextObjectNetworkSyncDataType

    BitmapTextObjectNetworkSyncDataType: { align: string; bfrn: string; opa: float; scale: number; tarn: string; text: string; tint: number[]; wwidth: float; wwrap: boolean }

    Type declaration

    • align: string
    • bfrn: string
    • opa: float
    • scale: number
    • tarn: string
    • text: string
    • tint: number[]
    • wwidth: float
    • wwrap: boolean

    ChangedRuntimeBehavior

    ChangedRuntimeBehavior: { behaviorTypeName: string; newBehaviorConstructor: Function; oldBehaviorConstructor: Function }

    Type declaration

    • behaviorTypeName: string
    • newBehaviorConstructor: Function
    • oldBehaviorConstructor: Function

    CollisionTestResult

    CollisionTestResult: { collision: boolean; move_axis: FloatPoint }

    Type declaration

    • collision: boolean
    • move_axis: FloatPoint

    Cube3DRuntimeObjectRenderer

    Cube3DRuntimeObjectRenderer: Cube3DRuntimeObjectPixiRenderer

    CustomObjectConfiguration

    CustomObjectConfiguration: ObjectConfiguration & { animatable?: SpriteAnimationData[]; childrenContent: {} }

    CustomRuntimeObject2DRenderer

    CustomRuntimeObject2DRenderer: CustomRuntimeObject2DPixiRenderer

    DebuggerRenderer

    DebuggerRenderer: DebuggerPixiRenderer

    DummyRuntimeObjectRenderer

    DummyRuntimeObjectRenderer: DummyRuntimeObjectPixiRenderer

    EffectsManager

    EffectsManager: PixiEffectsManager

    FontManager

    FontManager: FontFaceObserverFontManager

    FrameMeasure

    FrameMeasure: { lastStartTime: float; parent: FrameMeasure | null; subsections: Record<string, FrameMeasure>; time: float }

    Type declaration

    HotReloaderLog

    HotReloaderLog: { kind: "fatal" | "error" | "warning" | "info"; message: string }

    Type declaration

    • kind: "fatal" | "error" | "warning" | "info"
    • message: string

    ImageManager

    ImageManager: PixiImageManager

    JsonManagerRequestCallback

    JsonManagerRequestCallback: (error: Error | null, content: Object | null) => void

    Type declaration

      • (error: Error | null, content: Object | null): void
      • +

    BitmapTextObjectNetworkSyncData

    BitmapTextObjectNetworkSyncData: ObjectNetworkSyncData & BitmapTextObjectNetworkSyncDataType

    BitmapTextObjectNetworkSyncDataType

    BitmapTextObjectNetworkSyncDataType: { align: string; bfrn: string; opa: float; scale: number; tarn: string; text: string; tint: number[]; wwidth: float; wwrap: boolean }

    Type declaration

    • align: string
    • bfrn: string
    • opa: float
    • scale: number
    • tarn: string
    • text: string
    • tint: number[]
    • wwidth: float
    • wwrap: boolean

    ChangedRuntimeBehavior

    ChangedRuntimeBehavior: { behaviorTypeName: string; newBehaviorConstructor: Function; oldBehaviorConstructor: Function }

    Type declaration

    • behaviorTypeName: string
    • newBehaviorConstructor: Function
    • oldBehaviorConstructor: Function

    CollisionTestResult

    CollisionTestResult: { collision: boolean; move_axis: FloatPoint }

    Type declaration

    • collision: boolean
    • move_axis: FloatPoint

    Cube3DRuntimeObjectRenderer

    Cube3DRuntimeObjectRenderer: Cube3DRuntimeObjectPixiRenderer

    CustomObjectConfiguration

    CustomObjectConfiguration: ObjectConfiguration & { animatable?: SpriteAnimationData[]; childrenContent: {} }

    CustomRuntimeObject2DRenderer

    CustomRuntimeObject2DRenderer: CustomRuntimeObject2DPixiRenderer

    DebuggerRenderer

    DebuggerRenderer: DebuggerPixiRenderer

    DummyRuntimeObjectRenderer

    DummyRuntimeObjectRenderer: DummyRuntimeObjectPixiRenderer

    EffectsManager

    EffectsManager: PixiEffectsManager

    FontManager

    FontManager: FontFaceObserverFontManager

    FrameMeasure

    FrameMeasure: { lastStartTime: float; parent: FrameMeasure | null; subsections: Record<string, FrameMeasure>; time: float }

    Type declaration

    HotReloaderLog

    HotReloaderLog: { kind: "fatal" | "error" | "warning" | "info"; message: string }

    Type declaration

    • kind: "fatal" | "error" | "warning" | "info"
    • message: string

    ImageManager

    ImageManager: PixiImageManager

    JsonManagerRequestCallback

    JsonManagerRequestCallback: (error: Error | null, content: Object | null) => void

    Type declaration

      • (error: Error | null, content: Object | null): void

      • The callback called when a json that was requested is loaded (or an error occurred).

        -

        Parameters

        • error: Error | null
        • content: Object | null

        Returns void

    LayerRenderer

    LayerRenderer: LayerPixiRenderer

    LightNetworkSyncData

    LightNetworkSyncData: ObjectNetworkSyncData & LightNetworkSyncDataType

    LightNetworkSyncDataType

    LightNetworkSyncDataType: { col: string; rad: number }

    Type declaration

    • col: string
    • rad: number

    LightObjectData

    LightObjectData: ObjectData & LightObjectDataType

    LightObjectDataType

    LightObjectDataType: { content: { color: string; debugMode: boolean; radius: number; texture: string } }

    Type declaration

    • content: { color: string; debugMode: boolean; radius: number; texture: string }
      +

      Parameters

      • error: Error | null
      • content: Object | null

      Returns void

    LayerRenderer

    LayerRenderer: LayerPixiRenderer

    LightNetworkSyncData

    LightNetworkSyncData: ObjectNetworkSyncData & LightNetworkSyncDataType

    LightNetworkSyncDataType

    LightNetworkSyncDataType: { col: string; rad: number }

    Type declaration

    • col: string
    • rad: number

    LightObjectData

    LightObjectData: ObjectData & LightObjectDataType

    LightObjectDataType

    LightObjectDataType: { content: { color: string; debugMode: boolean; radius: number; texture: string } }

    Type declaration

    • content: { color: string; debugMode: boolean; radius: number; texture: string }

      The base parameters of light object.

      • color: string

        A string representing color in hexadecimal format.

        @@ -58,7 +58,7 @@

        The radius of light object.

      • texture: string

        A string representing the name of texture used for light object.

        -

    LightRuntimeObjectRenderer

    LightRuntimeObjectRenderer: LightRuntimeObjectPixiRenderer

    Model3DRuntimeObjectRenderer

    Model3DRuntimeObjectRenderer: Model3DRuntimeObject3DRenderer

    MultiplayerMessageManager

    MultiplayerMessageManager: ReturnType<typeof makeMultiplayerMessageManager>

    MultiplayerVariablesManager

    MultiplayerVariablesManager: ReturnType<typeof makeMultiplayerVariablesManager>

    Object3DNetworkSyncData

    Object3DNetworkSyncData: ObjectNetworkSyncData & Object3DNetworkSyncDataType

    ObjectConfiguration

    ObjectConfiguration: { content: any }

    Type declaration

    • content: any

    PanelSpriteNetworkSyncData

    PanelSpriteNetworkSyncData: ObjectNetworkSyncData & PanelSpriteNetworkSyncDataType

    PanelSpriteNetworkSyncDataType

    PanelSpriteNetworkSyncDataType: { color: string; hei: number; op: number; wid: number }

    Type declaration

    • color: string
    • hei: number
    • op: number
    • wid: number

    PanelSpriteObjectData

    PanelSpriteObjectData: ObjectData & PanelSpriteObjectDataType

    PanelSpriteObjectDataType

    PanelSpriteObjectDataType: { bottomMargin: number; height: number; leftMargin: number; rightMargin: number; texture: string; tiled: boolean; topMargin: number; width: number }

    Type declaration

    • bottomMargin: number
      +

    LightRuntimeObjectRenderer

    LightRuntimeObjectRenderer: LightRuntimeObjectPixiRenderer

    Model3DRuntimeObjectRenderer

    Model3DRuntimeObjectRenderer: Model3DRuntimeObject3DRenderer

    MultiplayerMessageManager

    MultiplayerMessageManager: ReturnType<typeof makeMultiplayerMessageManager>

    MultiplayerVariablesManager

    MultiplayerVariablesManager: ReturnType<typeof makeMultiplayerVariablesManager>

    Object3DNetworkSyncData

    Object3DNetworkSyncData: ObjectNetworkSyncData & Object3DNetworkSyncDataType

    ObjectConfiguration

    ObjectConfiguration: { content: any }

    Type declaration

    • content: any

    PanelSpriteNetworkSyncData

    PanelSpriteNetworkSyncData: ObjectNetworkSyncData & PanelSpriteNetworkSyncDataType

    PanelSpriteNetworkSyncDataType

    PanelSpriteNetworkSyncDataType: { color: string; hei: number; op: number; wid: number }

    Type declaration

    • color: string
    • hei: number
    • op: number
    • wid: number

    PanelSpriteObjectData

    PanelSpriteObjectData: ObjectData & PanelSpriteObjectDataType

    PanelSpriteObjectDataType

    PanelSpriteObjectDataType: { bottomMargin: number; height: number; leftMargin: number; rightMargin: number; texture: string; tiled: boolean; topMargin: number; width: number }

    Type declaration

    • bottomMargin: number

      The bottom margin

    • height: number

      The object height

      @@ -74,7 +74,7 @@

      The top margin

    • width: number

      The object width

      -

    PanelSpriteRuntimeObjectRenderer

    PanelSpriteRuntimeObjectRenderer: PanelSpriteRuntimeObjectPixiRenderer

    ParticleEmitterObjectData

    ParticleEmitterObjectData: ObjectData & ParticleEmitterObjectDataType

    ParticleEmitterObjectDataType

    ParticleEmitterObjectDataType: { additive: boolean; destroyWhenNoParticles: boolean; emitterAngleA: number; emitterAngleB: number; emitterForceMax: number; emitterForceMin: number; flow: number; jumpForwardInTimeOnCreation: number; maxParticleNb: number; particleAlpha1: number; particleAlpha2: number; particleAngle1: number; particleAngle2: number; particleBlue1: number; particleBlue2: number; particleGravityX: number; particleGravityY: number; particleGreen1: number; particleGreen2: number; particleLifeTimeMax: number; particleLifeTimeMin: number; particleRed1: number; particleRed2: number; particleSize1: number; particleSize2: number; particleSizeRandomness1: number; particleSizeRandomness2: number; rendererParam1: number; rendererParam2: number; rendererType: string; tank: number; textureParticleName: string; zoneRadius: number }

    Type declaration

    • additive: boolean
    • destroyWhenNoParticles: boolean
      +

    PanelSpriteRuntimeObjectRenderer

    PanelSpriteRuntimeObjectRenderer: PanelSpriteRuntimeObjectPixiRenderer

    ParticleEmitterObjectData

    ParticleEmitterObjectData: ObjectData & ParticleEmitterObjectDataType

    ParticleEmitterObjectDataType

    ParticleEmitterObjectDataType: { additive: boolean; destroyWhenNoParticles: boolean; emitterAngleA: number; emitterAngleB: number; emitterForceMax: number; emitterForceMin: number; flow: number; jumpForwardInTimeOnCreation: number; maxParticleNb: number; particleAlpha1: number; particleAlpha2: number; particleAngle1: number; particleAngle2: number; particleBlue1: number; particleBlue2: number; particleGravityX: number; particleGravityY: number; particleGreen1: number; particleGreen2: number; particleLifeTimeMax: number; particleLifeTimeMin: number; particleRed1: number; particleRed2: number; particleSize1: number; particleSize2: number; particleSizeRandomness1: number; particleSizeRandomness2: number; rendererParam1: number; rendererParam2: number; rendererType: string; tank: number; textureParticleName: string; zoneRadius: number }

    Type declaration

    • additive: boolean
    • destroyWhenNoParticles: boolean

      Destroy the object when there is no particles?

    • emitterAngleA: number
      deprecated

      Data not used

    • emitterAngleB: number
      @@ -85,7 +85,7 @@

      Particle max rotation speed (degrees/second)

    • particleBlue1: number
    • particleBlue2: number
    • particleGravityX: number
    • particleGravityY: number
    • particleGreen1: number
    • particleGreen2: number
    • particleLifeTimeMax: number
    • particleLifeTimeMin: number
    • particleRed1: number
    • particleRed2: number
    • particleSize1: number
    • particleSize2: number
    • particleSizeRandomness1: number
    • particleSizeRandomness2: number
    • rendererParam1: number
    • rendererParam2: number
    • rendererType: string
    • tank: number
    • textureParticleName: string

      Resource name for image in particle

      -
    • zoneRadius: number

    ParticleEmitterObjectNetworkSyncData

    ParticleEmitterObjectNetworkSyncData: ObjectNetworkSyncData & ParticleEmitterObjectNetworkSyncDataType

    ParticleEmitterObjectNetworkSyncDataType

    ParticleEmitterObjectNetworkSyncDataType: { addr: boolean; alp1: number; alp2: number; angb: number; colb1: number; colb2: number; colg1: number; colg2: number; colr1: number; colr2: number; flow: number; formax: number; formin: number; gravx: number; gravy: number; ltmax: number; ltmin: number; mpc: number; paused: boolean; prms: number; prmx: number; size1: number; size2: number; tank: number; text: string; zr: number }

    Type declaration

    • addr: boolean
    • alp1: number
    • alp2: number
    • angb: number
    • colb1: number
    • colb2: number
    • colg1: number
    • colg2: number
    • colr1: number
    • colr2: number
    • flow: number
    • formax: number
    • formin: number
    • gravx: number
    • gravy: number
    • ltmax: number
    • ltmin: number
    • mpc: number
    • paused: boolean
    • prms: number
    • prmx: number
    • size1: number
    • size2: number
    • tank: number
    • text: string
    • zr: number

    ParticleEmitterObjectRenderer

    ParticleEmitterObjectRenderer: ParticleEmitterObjectPixiRenderer

    ProfilerStats

    ProfilerStats: { framesCount: integer }

    Type declaration

    • framesCount: integer

    RGBColor

    RGBColor: { b: integer; g: integer; r: integer }
    +
  • zoneRadius: number

    • ParticleEmitterObjectNetworkSyncData

    ParticleEmitterObjectNetworkSyncData: ObjectNetworkSyncData & ParticleEmitterObjectNetworkSyncDataType

    ParticleEmitterObjectNetworkSyncDataType

    ParticleEmitterObjectNetworkSyncDataType: { addr: boolean; alp1: number; alp2: number; angb: number; colb1: number; colb2: number; colg1: number; colg2: number; colr1: number; colr2: number; flow: number; formax: number; formin: number; gravx: number; gravy: number; ltmax: number; ltmin: number; mpc: number; paused: boolean; prms: number; prmx: number; size1: number; size2: number; tank: number; text: string; zr: number }

    Type declaration

    • addr: boolean
    • alp1: number
    • alp2: number
    • angb: number
    • colb1: number
    • colb2: number
    • colg1: number
    • colg2: number
    • colr1: number
    • colr2: number
    • flow: number
    • formax: number
    • formin: number
    • gravx: number
    • gravy: number
    • ltmax: number
    • ltmin: number
    • mpc: number
    • paused: boolean
    • prms: number
    • prmx: number
    • size1: number
    • size2: number
    • tank: number
    • text: string
    • zr: number

    ParticleEmitterObjectRenderer

    ParticleEmitterObjectRenderer: ParticleEmitterObjectPixiRenderer

    ProfilerStats

    ProfilerStats: { framesCount: integer }

    Type declaration

    • framesCount: integer

    RGBColor

    RGBColor: { b: integer; g: integer; r: integer }

    Represents a color in RGB Format

    Type declaration

    • b: integer

      The Blue component of the color, from 0 to 255.

      @@ -93,7 +93,7 @@

      The Green component of the color, from 0 to 255.

    • r: integer

      The Red component of the color, from 0 to 255.

      -

    RaycastTestResult

    RaycastTestResult: { closeSqDist: float; closeX: float; closeY: float; collision: boolean; farSqDist: float; farX: float; farY: float }

    Type declaration

    • closeSqDist: float
    • closeX: float
    • closeY: float
    • collision: boolean
    • farSqDist: float
    • farX: float
    • farY: float

    RendererObjectInterface

    RendererObjectInterface: { visible: boolean }

    Type declaration

    • visible: boolean

    RuntimeGameOptions

    RuntimeGameOptions: { allowAuthenticationUsingIframeForPreview?: boolean; electronRemoteRequirePath?: string; environment?: "dev"; forceFullscreen?: boolean; gdevelopResourceToken?: string; injectExternalLayout?: string; isPreview?: boolean; nativeMobileApp?: boolean; playerId?: string; playerToken?: string; playerUsername?: string; projectDataOnlyExport?: boolean; scriptFiles?: RuntimeGameOptionsScriptFile[]; websocketDebuggerServerAddress?: string; websocketDebuggerServerPort?: string }
    +

    RaycastTestResult

    RaycastTestResult: { closeSqDist: float; closeX: float; closeY: float; collision: boolean; farSqDist: float; farX: float; farY: float }

    Type declaration

    • closeSqDist: float
    • closeX: float
    • closeY: float
    • collision: boolean
    • farSqDist: float
    • farX: float
    • farY: float

    RendererObjectInterface

    RendererObjectInterface: { visible: boolean }

    Type declaration

    • visible: boolean

    RuntimeGameOptions

    RuntimeGameOptions: { allowAuthenticationUsingIframeForPreview?: boolean; electronRemoteRequirePath?: string; environment?: "dev"; forceFullscreen?: boolean; gdevelopResourceToken?: string; injectExternalLayout?: string; isPreview?: boolean; nativeMobileApp?: boolean; playerId?: string; playerToken?: string; playerUsername?: string; projectDataOnlyExport?: boolean; scriptFiles?: RuntimeGameOptionsScriptFile[]; websocketDebuggerServerAddress?: string; websocketDebuggerServerPort?: string }

    Options given to the game at startup.

    Type declaration

    • Optional allowAuthenticationUsingIframeForPreview?: boolean

      Check if, in some exceptional cases, we allow authentication @@ -133,13 +133,13 @@

      The address of the debugger server, to reach out using WebSocket.

    • Optional websocketDebuggerServerPort?: string

      The port of the debugger server, to reach out using WebSocket.

      -

    RuntimeGameOptionsScriptFile

    RuntimeGameOptionsScriptFile: { hash: number; path: string }
    +

    RuntimeGameOptionsScriptFile

    RuntimeGameOptionsScriptFile: { hash: number; path: string }

    Identify a script file, with its content hash (useful for hot-reloading).

    Type declaration

    • hash: number

      The hash of the script file content.

    • path: string

      The path for this script file.

      -

    RuntimeGameRenderer

    RuntimeGameRenderer: RuntimeGamePixiRenderer

    RuntimeInstanceContainerRenderer

    RuntimeInstanceContainerRenderer: RuntimeInstanceContainerPixiRenderer

    RuntimeSceneRenderer

    RuntimeSceneRenderer: RuntimeScenePixiRenderer

    ShapePainterObjectData

    ShapePainterObjectData: ObjectData & ShapePainterObjectDataType

    ShapePainterObjectDataType

    ShapePainterObjectDataType: { absoluteCoordinates: boolean; antialiasing: Antialiasing; clearBetweenFrames: boolean; fillColor: RGBColor; fillOpacity: float; outlineColor: RGBColor; outlineOpacity: float; outlineSize: float }
    +

    RuntimeGameRenderer

    RuntimeGameRenderer: RuntimeGamePixiRenderer

    RuntimeInstanceContainerRenderer

    RuntimeInstanceContainerRenderer: RuntimeInstanceContainerPixiRenderer

    RuntimeSceneRenderer

    RuntimeSceneRenderer: RuntimeScenePixiRenderer

    ShapePainterObjectData

    ShapePainterObjectData: ObjectData & ShapePainterObjectDataType

    ShapePainterObjectDataType

    ShapePainterObjectDataType: { absoluteCoordinates: boolean; antialiasing: Antialiasing; clearBetweenFrames: boolean; fillColor: RGBColor; fillOpacity: float; outlineColor: RGBColor; outlineOpacity: float; outlineSize: float }

    Initial properties for a for gdjs.ShapePainterRuntimeObject.

    Type declaration

    • absoluteCoordinates: boolean

      Use absolute coordinates?

      @@ -157,9 +157,9 @@

      The opacity of the outline of the painted shape, from 0 to 255

    • outlineSize: float

      The size of the outline of the painted shape, in pixels.

      -

    ShapePainterRuntimeObjectRenderer

    ShapePainterRuntimeObjectRenderer: ShapePainterRuntimeObjectPixiRenderer

    SoundManager

    SoundManager: HowlerSoundManager

    SpineAtlasManagerRequestCallback

    SpineAtlasManagerRequestCallback: (error: Error | null, content?: pixi_spine.TextureAtlas) => void

    Type declaration

      • (error: Error | null, content?: pixi_spine.TextureAtlas): void
      • +

    ShapePainterRuntimeObjectRenderer

    ShapePainterRuntimeObjectRenderer: ShapePainterRuntimeObjectPixiRenderer

    SoundManager

    SoundManager: HowlerSoundManager

    SpineAtlasManagerRequestCallback

    SpineAtlasManagerRequestCallback: (error: Error | null, content?: pixi_spine.TextureAtlas) => void

    Type declaration

      • (error: Error | null, content?: pixi_spine.TextureAtlas): void

      • The callback called when a text that was requested is loaded (or an error occurred).

        -

        Parameters

        • error: Error | null
        • Optional content: pixi_spine.TextureAtlas

        Returns void

    SpineNetworkSyncData

    SpineNetworkSyncData: ObjectNetworkSyncData & SpineNetworkSyncDataType

    SpineNetworkSyncDataType

    SpineNetworkSyncDataType: { anet: number; ani: number; anmd: number; anp: boolean; anss: float; flipX: boolean; flipY: boolean; hei: float; opa: float; scaX: float; scaY: float; wid: float }

    Type declaration

    • anet: number
    • ani: number
    • anmd: number
    • anp: boolean
    • anss: float
    • flipX: boolean
    • flipY: boolean
    • hei: float
    • opa: float
    • scaX: float
    • scaY: float
    • wid: float

    SpineObjectData

    SpineObjectData: ObjectData & SpineObjectDataType

    SpineObjectDataType

    SpineObjectDataType: { content: { animations: SpineAnimation[]; opacity: float; scale: float; spineResourceName: string; timeScale: float } }

    Type declaration

    • content: { animations: SpineAnimation[]; opacity: float; scale: float; spineResourceName: string; timeScale: float }
      • animations: SpineAnimation[]
      • opacity: float
      • scale: float
      • spineResourceName: string
      • timeScale: float

    SpriteAnimationData

    SpriteAnimationData: { directions: SpriteDirectionData[]; name: string; useMultipleDirections: boolean }
    +

    Parameters

    Returns void

    SpineNetworkSyncData

    SpineNetworkSyncData: ObjectNetworkSyncData & SpineNetworkSyncDataType

    SpineNetworkSyncDataType

    SpineNetworkSyncDataType: { anet: number; ani: number; anmd: number; anp: boolean; anss: float; flipX: boolean; flipY: boolean; hei: float; opa: float; scaX: float; scaY: float; wid: float }

    Type declaration

    • anet: number
    • ani: number
    • anmd: number
    • anp: boolean
    • anss: float
    • flipX: boolean
    • flipY: boolean
    • hei: float
    • opa: float
    • scaX: float
    • scaY: float
    • wid: float

    SpineObjectData

    SpineObjectData: ObjectData & SpineObjectDataType

    SpineObjectDataType

    SpineObjectDataType: { content: { animations: SpineAnimation[]; opacity: float; scale: float; spineResourceName: string; timeScale: float } }

    Type declaration

    • content: { animations: SpineAnimation[]; opacity: float; scale: float; spineResourceName: string; timeScale: float }
      • animations: SpineAnimation[]
      • opacity: float
      • scale: float
      • spineResourceName: string
      • timeScale: float

    SpriteAnimationData

    SpriteAnimationData: { directions: SpriteDirectionData[]; name: string; useMultipleDirections: boolean }

    Represents the data of a gdjs.SpriteAnimation.

    Type declaration

    SpriteAnimatorNetworkSyncData

    SpriteAnimatorNetworkSyncData: { an: integer; di: integer; et: float; fr: integer; pa: boolean; ss: float }
    +

    SpriteAnimatorNetworkSyncData

    SpriteAnimatorNetworkSyncData: { an: integer; di: integer; et: float; fr: integer; pa: boolean; ss: float }

    Represents all the information needed to synchronize the animations of an object.

    -

    Type declaration

    • an: integer
    • di: integer
    • et: float
    • fr: integer
    • pa: boolean
    • ss: float

    SpriteCenterPointData

    SpriteCenterPointData: { automatic: boolean; name: string; x: float; y: float }
    +

    Type declaration

    • an: integer
    • di: integer
    • et: float
    • fr: integer
    • pa: boolean
    • ss: float

    SpriteCenterPointData

    SpriteCenterPointData: { automatic: boolean; name: string; x: float; y: float }

    Represents the center point in a frame.

    Type declaration

    • automatic: boolean

      Is the center automatically computed?

      @@ -179,7 +179,7 @@

      X position of the point.

    • y: float

      Y position of the point.

      -

    SpriteCustomPointData

    SpriteCustomPointData: { name: string; x: float; y: float }
    +

    SpriteCustomPointData

    SpriteCustomPointData: { name: string; x: float; y: float }

    Represents a custom point in a frame.

    Type declaration

    • name: string

      Name of the point.

      @@ -187,7 +187,7 @@

      X position of the point.

    • y: float

      Y position of the point.

      -

    SpriteDirectionData

    SpriteDirectionData: { looping: boolean; sprites: SpriteFrameData[]; timeBetweenFrames: float }
    +

    SpriteDirectionData

    SpriteDirectionData: { looping: boolean; sprites: SpriteFrameData[]; timeBetweenFrames: float }

    Represents the data of a gdjs.SpriteAnimationDirection.

    Type declaration

    • looping: boolean

      Is the animation looping?

      @@ -195,7 +195,7 @@

      The list of frames.

    • timeBetweenFrames: float

      Time between each frame, in seconds.

      -

    SpriteFrameData

    SpriteFrameData: { centerPoint: SpriteCenterPointData; customCollisionMask: SpritePoint[][]; hasCustomCollisionMask: boolean; image: string; originPoint: SpriteCustomPointData; points: SpriteCustomPointData[] }
    +

    SpriteFrameData

    SpriteFrameData: { centerPoint: SpriteCenterPointData; customCollisionMask: SpritePoint[][]; hasCustomCollisionMask: boolean; image: string; originPoint: SpriteCustomPointData; points: SpriteCustomPointData[] }

    Represents a gdjs.SpriteAnimationFrame.

    Type declaration

    SpriteNetworkSyncData

    SpriteNetworkSyncData: ObjectNetworkSyncData & SpriteNetworkSyncDataType

    SpriteNetworkSyncDataType

    SpriteNetworkSyncDataType: { anim: SpriteAnimatorNetworkSyncData; color: string; ifx: boolean; ify: boolean; op: float; sx: float; sy: float }

    Type declaration

    SpriteObjectData

    SpriteObjectData: ObjectData & SpriteObjectDataType

    SpriteObjectDataType

    SpriteObjectDataType: { animations: SpriteAnimationData[]; updateIfNotVisible: boolean }
    +

    SpriteNetworkSyncData

    SpriteNetworkSyncData: ObjectNetworkSyncData & SpriteNetworkSyncDataType

    SpriteNetworkSyncDataType

    SpriteNetworkSyncDataType: { anim: SpriteAnimatorNetworkSyncData; color: string; ifx: boolean; ify: boolean; op: float; sx: float; sy: float }

    Type declaration

    SpriteObjectData

    SpriteObjectData: ObjectData & SpriteObjectDataType

    SpriteObjectDataType

    SpriteObjectDataType: { animations: SpriteAnimationData[]; updateIfNotVisible: boolean }

    Represents the data of a gdjs.SpriteRuntimeObject.

    Type declaration

    SpritePoint

    SpritePoint: { x: float; y: float }
    +

    SpritePoint

    SpritePoint: { x: float; y: float }

    Represents a point in a coordinate system.

    Type declaration

    • x: float

      X position of the point.

    • y: float

      Y position of the point.

      -

    SpriteRuntimeObjectRenderer

    SpriteRuntimeObjectRenderer: SpriteRuntimeObjectPixiRenderer

    TextEntryRuntimeObjectRenderer

    TextEntryRuntimeObjectRenderer: TextEntryRuntimeObjectPixiRenderer

    TextInputNetworkSyncData

    TextInputNetworkSyncData: ObjectNetworkSyncData & TextInputNetworkSyncDataType

    TextInputNetworkSyncDataType

    TextInputNetworkSyncDataType: { bc: string; bo: float; bw: float; dis: boolean; fc: string; fo: float; frn: string; fs: number; hei: float; it: SupportedInputType; opa: float; place: string; ro: boolean; tc: string; txt: string; wid: float }

    Type declaration

    • bc: string
    • bo: float
    • bw: float
    • dis: boolean
    • fc: string
    • fo: float
    • frn: string
    • fs: number
    • hei: float
    • it: SupportedInputType
    • opa: float
    • place: string
    • ro: boolean
    • tc: string
    • txt: string
    • wid: float

    TextInputRuntimeObjectRenderer

    TextInputRuntimeObjectRenderer: TextInputRuntimeObjectPixiRenderer

    TextObjectData

    TextObjectData: ObjectData & TextObjectDataType

    TextObjectDataType

    TextObjectDataType: { content: { bold: boolean; characterSize: number; color: string; font: string; isOutlineEnabled: boolean; isShadowEnabled: boolean; italic: boolean; outlineColor: string; outlineThickness: float; shadowAngle: float; shadowBlurRadius: float; shadowColor: string; shadowDistance: float; shadowOpacity: float; text: string; textAlignment: string; underlined: boolean } }
    +

    SpriteRuntimeObjectRenderer

    SpriteRuntimeObjectRenderer: SpriteRuntimeObjectPixiRenderer

    TextEntryRuntimeObjectRenderer

    TextEntryRuntimeObjectRenderer: TextEntryRuntimeObjectPixiRenderer

    TextInputNetworkSyncData

    TextInputNetworkSyncData: ObjectNetworkSyncData & TextInputNetworkSyncDataType

    TextInputNetworkSyncDataType

    TextInputNetworkSyncDataType: { bc: string; bo: float; bw: float; dis: boolean; fc: string; fo: float; frn: string; fs: number; hei: float; it: SupportedInputType; opa: float; place: string; ro: boolean; tc: string; txt: string; wid: float }

    Type declaration

    • bc: string
    • bo: float
    • bw: float
    • dis: boolean
    • fc: string
    • fo: float
    • frn: string
    • fs: number
    • hei: float
    • it: SupportedInputType
    • opa: float
    • place: string
    • ro: boolean
    • tc: string
    • txt: string
    • wid: float

    TextInputRuntimeObjectRenderer

    TextInputRuntimeObjectRenderer: TextInputRuntimeObjectPixiRenderer

    TextObjectData

    TextObjectData: ObjectData & TextObjectDataType

    TextObjectDataType

    TextObjectDataType: { content: { bold: boolean; characterSize: number; color: string; font: string; isOutlineEnabled: boolean; isShadowEnabled: boolean; italic: boolean; outlineColor: string; outlineThickness: float; shadowAngle: float; shadowBlurRadius: float; shadowColor: string; shadowDistance: float; shadowOpacity: float; text: string; textAlignment: string; underlined: boolean } }

    Base parameters for gdjs.TextRuntimeObject

    Type declaration

    • content: { bold: boolean; characterSize: number; color: string; font: string; isOutlineEnabled: boolean; isShadowEnabled: boolean; italic: boolean; outlineColor: string; outlineThickness: float; shadowAngle: float; shadowBlurRadius: float; shadowColor: string; shadowDistance: float; shadowOpacity: float; text: string; textAlignment: string; underlined: boolean }
      • bold: boolean

        Is Bold?

        @@ -241,13 +241,13 @@

        The text of the object

      • textAlignment: string
      • underlined: boolean

        Is Underlined?

        -

    TextObjectNetworkSyncData

    TextObjectNetworkSyncData: ObjectNetworkSyncData & TextObjectNetworkSyncDataType

    TextObjectNetworkSyncDataType

    TextObjectNetworkSyncDataType: { b: boolean; c: number[]; cs: number; fn: string; i: boolean; o: float; oc: number[]; oena: boolean; ot: float; pad: integer; scale: number; sh: boolean; sha: float; shb: float; shc: number[]; shd: float; sho: float; str: string; ta: string; u: boolean; wrap: boolean; wrapw: float }

    Type declaration

    • b: boolean
    • c: number[]
    • cs: number
    • fn: string
    • i: boolean
    • o: float
    • oc: number[]
    • oena: boolean
    • ot: float
    • pad: integer
    • scale: number
    • sh: boolean
    • sha: float
    • shb: float
    • shc: number[]
    • shd: float
    • sho: float
    • str: string
    • ta: string
    • u: boolean
    • wrap: boolean
    • wrapw: float

    TextRuntimeObjectRenderer

    TextRuntimeObjectRenderer: TextRuntimeObjectPixiRenderer

    TileMapRuntimeObjectRenderer

    TileMapRuntimeObjectRenderer: TileMapRuntimeObjectPixiRenderer

    TiledSpriteNetworkSyncData

    TiledSpriteNetworkSyncData: ObjectNetworkSyncData & TiledSpriteNetworkSyncDataType

    TiledSpriteNetworkSyncDataType

    TiledSpriteNetworkSyncDataType: { color: string; hei: number; op: number; wid: number; xo: number; yo: number }

    Type declaration

    • color: string
    • hei: number
    • op: number
    • wid: number
    • xo: number
    • yo: number

    TiledSpriteObjectData

    TiledSpriteObjectData: ObjectData & TiledSpriteObjectDataType

    TiledSpriteObjectDataType

    TiledSpriteObjectDataType: { height: number; texture: string; width: number }
    +

    TextObjectNetworkSyncData

    TextObjectNetworkSyncData: ObjectNetworkSyncData & TextObjectNetworkSyncDataType

    TextObjectNetworkSyncDataType

    TextObjectNetworkSyncDataType: { b: boolean; c: number[]; cs: number; fn: string; i: boolean; o: float; oc: number[]; oena: boolean; ot: float; pad: integer; scale: number; sh: boolean; sha: float; shb: float; shc: number[]; shd: float; sho: float; str: string; ta: string; u: boolean; wrap: boolean; wrapw: float }

    Type declaration

    • b: boolean
    • c: number[]
    • cs: number
    • fn: string
    • i: boolean
    • o: float
    • oc: number[]
    • oena: boolean
    • ot: float
    • pad: integer
    • scale: number
    • sh: boolean
    • sha: float
    • shb: float
    • shc: number[]
    • shd: float
    • sho: float
    • str: string
    • ta: string
    • u: boolean
    • wrap: boolean
    • wrapw: float

    TextRuntimeObjectRenderer

    TextRuntimeObjectRenderer: TextRuntimeObjectPixiRenderer

    TileMapRuntimeObjectRenderer

    TileMapRuntimeObjectRenderer: TileMapRuntimeObjectPixiRenderer

    TiledSpriteNetworkSyncData

    TiledSpriteNetworkSyncData: ObjectNetworkSyncData & TiledSpriteNetworkSyncDataType

    TiledSpriteNetworkSyncDataType

    TiledSpriteNetworkSyncDataType: { color: string; hei: number; op: number; wid: number; xo: number; yo: number }

    Type declaration

    • color: string
    • hei: number
    • op: number
    • wid: number
    • xo: number
    • yo: number

    TiledSpriteObjectData

    TiledSpriteObjectData: ObjectData & TiledSpriteObjectDataType

    TiledSpriteObjectDataType

    TiledSpriteObjectDataType: { height: number; texture: string; width: number }

    Initial properties for a Tiled Sprite object

    Type declaration

    • height: number

      Default height of the object, if the instance has no custom height.

    • texture: string
    • width: number

      Default width of the object, if the instance has no custom width.

      -

    TiledSpriteRuntimeObjectRenderer

    TiledSpriteRuntimeObjectRenderer: TiledSpriteRuntimeObjectPixiRenderer

    TilemapCollisionMaskNetworkSyncData

    TilemapCollisionMaskNetworkSyncData: ObjectNetworkSyncData & TilemapCollisionMaskNetworkSyncDataType

    TilemapCollisionMaskNetworkSyncDataType

    TilemapCollisionMaskNetworkSyncDataType: { dm: boolean; fc: integer; fo: float; hei: float; oc: integer; oo: float; os: float; tmjf: string; tsjf: string; wid: float }

    Type declaration

    • dm: boolean
    • fc: integer
    • fo: float
    • hei: float
    • oc: integer
    • oo: float
    • os: float
    • tmjf: string
    • tsjf: string
    • wid: float

    TilemapCollisionMaskObjectData

    TilemapCollisionMaskObjectData: ObjectData & TilemapCollisionMaskObjectDataType

    TilemapCollisionMaskObjectDataType

    TilemapCollisionMaskObjectDataType: { content: { collisionMaskTag: string; debugMode: boolean; fillColor: string; outlineColor: string; tilemapJsonFile: string; tilesetJsonFile: string }; fillOpacity: float; outlineOpacity: float; outlineSize: float }

    Type declaration

    • content: { collisionMaskTag: string; debugMode: boolean; fillColor: string; outlineColor: string; tilemapJsonFile: string; tilesetJsonFile: string }
      • collisionMaskTag: string
      • debugMode: boolean
      • fillColor: string
      • outlineColor: string
      • tilemapJsonFile: string
      • tilesetJsonFile: string
    • fillOpacity: float
    • outlineOpacity: float
    • outlineSize: float

    TilemapNetworkSyncData

    TilemapNetworkSyncData: ObjectNetworkSyncData & TilemapNetworkSyncDataType

    TilemapNetworkSyncDataType

    TilemapNetworkSyncDataType: { asps: number; dm: string; hei: number; lai: number; lei: number; op: number; tmai: string; tmjf: string; tsjf: string; wid: number }

    Type declaration

    • asps: number
    • dm: string
    • hei: number
    • lai: number
    • lei: number
    • op: number
    • tmai: string
    • tmjf: string
    • tsjf: string
    • wid: number

    TilemapObjectData

    TilemapObjectData: ObjectData & TilemapObjectDataType

    TilemapObjectDataType

    TilemapObjectDataType: { content: { animationFps: number; animationSpeedScale: number; displayMode: string; layerIndex: integer; levelIndex: integer; opacity: number; tilemapAtlasImage: string; tilemapJsonFile: string; tilesetJsonFile: string } }

    Type declaration

    • content: { animationFps: number; animationSpeedScale: number; displayMode: string; layerIndex: integer; levelIndex: integer; opacity: number; tilemapAtlasImage: string; tilemapJsonFile: string; tilesetJsonFile: string }
      • animationFps: number
      • animationSpeedScale: number
      • displayMode: string
      • layerIndex: integer
      • levelIndex: integer
      • opacity: number
      • tilemapAtlasImage: string
      • tilemapJsonFile: string
      • tilesetJsonFile: string

    VideoNetworkSyncData

    VideoNetworkSyncData: ObjectNetworkSyncData & VideoNetworkSyncDataType

    VideoNetworkSyncDataType

    VideoNetworkSyncDataType: { ct: float; hei: float; loop: boolean; op: float; pla: boolean; ps: number; wid: float }

    Type declaration

    • ct: float
    • hei: float
    • loop: boolean
    • op: float
    • pla: boolean
    • ps: number
    • wid: float

    VideoObjectData

    VideoObjectData: ObjectData & VideoObjectDataType

    VideoObjectDataType

    VideoObjectDataType: { content: { loop: boolean; opacity: number; videoResource: string; volume: number } }
    +

    TiledSpriteRuntimeObjectRenderer

    TiledSpriteRuntimeObjectRenderer: TiledSpriteRuntimeObjectPixiRenderer

    TilemapCollisionMaskNetworkSyncData

    TilemapCollisionMaskNetworkSyncData: ObjectNetworkSyncData & TilemapCollisionMaskNetworkSyncDataType

    TilemapCollisionMaskNetworkSyncDataType

    TilemapCollisionMaskNetworkSyncDataType: { dm: boolean; fc: integer; fo: float; hei: float; oc: integer; oo: float; os: float; tmjf: string; tsjf: string; wid: float }

    Type declaration

    • dm: boolean
    • fc: integer
    • fo: float
    • hei: float
    • oc: integer
    • oo: float
    • os: float
    • tmjf: string
    • tsjf: string
    • wid: float

    TilemapCollisionMaskObjectData

    TilemapCollisionMaskObjectData: ObjectData & TilemapCollisionMaskObjectDataType

    TilemapCollisionMaskObjectDataType

    TilemapCollisionMaskObjectDataType: { content: { collisionMaskTag: string; debugMode: boolean; fillColor: string; outlineColor: string; tilemapJsonFile: string; tilesetJsonFile: string }; fillOpacity: float; outlineOpacity: float; outlineSize: float }

    Type declaration

    • content: { collisionMaskTag: string; debugMode: boolean; fillColor: string; outlineColor: string; tilemapJsonFile: string; tilesetJsonFile: string }
      • collisionMaskTag: string
      • debugMode: boolean
      • fillColor: string
      • outlineColor: string
      • tilemapJsonFile: string
      • tilesetJsonFile: string
    • fillOpacity: float
    • outlineOpacity: float
    • outlineSize: float

    TilemapNetworkSyncData

    TilemapNetworkSyncData: ObjectNetworkSyncData & TilemapNetworkSyncDataType

    TilemapNetworkSyncDataType

    TilemapNetworkSyncDataType: { asps: number; dm: string; hei: number; lai: number; lei: number; op: number; tmai: string; tmjf: string; tsjf: string; wid: number }

    Type declaration

    • asps: number
    • dm: string
    • hei: number
    • lai: number
    • lei: number
    • op: number
    • tmai: string
    • tmjf: string
    • tsjf: string
    • wid: number

    TilemapObjectData

    TilemapObjectData: ObjectData & TilemapObjectDataType

    TilemapObjectDataType

    TilemapObjectDataType: { content: { animationFps: number; animationSpeedScale: number; displayMode: string; layerIndex: integer; levelIndex: integer; opacity: number; tilemapAtlasImage: string; tilemapJsonFile: string; tilesetJsonFile: string } }

    Type declaration

    • content: { animationFps: number; animationSpeedScale: number; displayMode: string; layerIndex: integer; levelIndex: integer; opacity: number; tilemapAtlasImage: string; tilemapJsonFile: string; tilesetJsonFile: string }
      • animationFps: number
      • animationSpeedScale: number
      • displayMode: string
      • layerIndex: integer
      • levelIndex: integer
      • opacity: number
      • tilemapAtlasImage: string
      • tilemapJsonFile: string
      • tilesetJsonFile: string

    VideoNetworkSyncData

    VideoNetworkSyncData: ObjectNetworkSyncData & VideoNetworkSyncDataType

    VideoNetworkSyncDataType

    VideoNetworkSyncDataType: { ct: float; hei: float; loop: boolean; op: float; pla: boolean; ps: number; wid: float }

    Type declaration

    • ct: float
    • hei: float
    • loop: boolean
    • op: float
    • pla: boolean
    • ps: number
    • wid: float

    VideoObjectData

    VideoObjectData: ObjectData & VideoObjectDataType

    VideoObjectDataType

    VideoObjectDataType: { content: { loop: boolean; opacity: number; videoResource: string; volume: number } }

    The initial properties for gdjs.VideoRuntimeObject

    Type declaration

    • content: { loop: boolean; opacity: number; videoResource: string; volume: number }

      The base parameters of the video

      @@ -259,77 +259,77 @@

      Name of the resource corresponding to the video

    • volume: number

      The volume of the video

      -

    VideoRuntimeObjectRenderer

    VideoRuntimeObjectRenderer: VideoRuntimeObjectPixiRenderer

    Variables

    BBTextRuntimeObjectRenderer

    BBTextRuntimeObjectRenderer: typeof BBTextRuntimeObjectPixiRenderer = BBTextRuntimeObjectPixiRenderer

    BitmapFontManager

    BitmapFontManager: typeof PixiBitmapFontManager = gdjs.PixiBitmapFontManager

    BitmapTextRuntimeObjectRenderer

    BitmapTextRuntimeObjectRenderer: typeof BitmapTextRuntimeObjectPixiRenderer = BitmapTextRuntimeObjectPixiRenderer

    Cube3DRuntimeObjectRenderer

    Cube3DRuntimeObjectRenderer: typeof Cube3DRuntimeObjectPixiRenderer = Cube3DRuntimeObjectPixiRenderer

    CustomRuntimeObject2DRenderer

    CustomRuntimeObject2DRenderer: typeof CustomRuntimeObject2DPixiRenderer

    DebuggerClient

    DebuggerClient: typeof WebsocketDebuggerClient = WebsocketDebuggerClient

    DebuggerRenderer

    DebuggerRenderer: typeof DebuggerPixiRenderer

    DummyRuntimeObjectRenderer

    DummyRuntimeObjectRenderer: typeof DummyRuntimeObjectPixiRenderer = DummyRuntimeObjectPixiRenderer

    EffectsManager

    EffectsManager: typeof PixiEffectsManager = PixiEffectsManager

    FontManager

    FontManager: typeof FontFaceObserverFontManager

    ImageManager

    ImageManager: typeof PixiImageManager = gdjs.PixiImageManager

    LayerRenderer

    LayerRenderer: typeof LayerPixiRenderer

    LightRuntimeObjectRenderer

    LightRuntimeObjectRenderer: typeof LightRuntimeObjectPixiRenderer = LightRuntimeObjectPixiRenderer

    LoadingScreenRenderer

    LoadingScreenRenderer: typeof LoadingScreenPixiRenderer = LoadingScreenPixiRenderer

    Model3DRuntimeObjectRenderer

    Model3DRuntimeObjectRenderer: typeof Model3DRuntimeObject3DRenderer = Model3DRuntimeObject3DRenderer

    PanelSpriteRuntimeObjectRenderer

    PanelSpriteRuntimeObjectRenderer: typeof PanelSpriteRuntimeObjectPixiRenderer = PanelSpriteRuntimeObjectPixiRenderer

    ParticleEmitterObjectRenderer

    ParticleEmitterObjectRenderer: typeof ParticleEmitterObjectPixiRenderer = ParticleEmitterObjectPixiRenderer

    RuntimeGameRenderer

    RuntimeGameRenderer: typeof RuntimeGamePixiRenderer

    RuntimeSceneRenderer

    RuntimeSceneRenderer: typeof RuntimeScenePixiRenderer

    ShapePainterRuntimeObjectRenderer

    ShapePainterRuntimeObjectRenderer: typeof ShapePainterRuntimeObjectPixiRenderer = ShapePainterRuntimeObjectPixiRenderer

    SoundManager

    SoundManager: typeof HowlerSoundManager = HowlerSoundManager

    SpineRuntimeObjectRenderer

    SpineRuntimeObjectRenderer: typeof SpineRuntimeObjectPixiRenderer = SpineRuntimeObjectPixiRenderer

    SpriteRuntimeObjectRenderer

    SpriteRuntimeObjectRenderer: typeof SpriteRuntimeObjectPixiRenderer = SpriteRuntimeObjectPixiRenderer

    TextEntryRuntimeObjectRenderer

    TextEntryRuntimeObjectRenderer: typeof TextEntryRuntimeObjectPixiRenderer = TextEntryRuntimeObjectPixiRenderer

    TextInputRuntimeObjectRenderer

    TextInputRuntimeObjectRenderer: typeof TextInputRuntimeObjectPixiRenderer = TextInputRuntimeObjectPixiRenderer

    TextRuntimeObjectRenderer

    TextRuntimeObjectRenderer: typeof TextRuntimeObjectPixiRenderer = TextRuntimeObjectPixiRenderer

    TileMapRuntimeObjectRenderer

    TileMapRuntimeObjectRenderer: typeof TileMapRuntimeObjectPixiRenderer = gdjs.TileMapRuntimeObjectPixiRenderer

    TiledSpriteRuntimeObjectRenderer

    TiledSpriteRuntimeObjectRenderer: typeof TiledSpriteRuntimeObjectPixiRenderer = TiledSpriteRuntimeObjectPixiRenderer

    VideoRuntimeObjectRenderer

    VideoRuntimeObjectRenderer: typeof VideoRuntimeObjectPixiRenderer = VideoRuntimeObjectPixiRenderer

    behaviorsTypes

    behaviorsTypes: Hashtable<typeof RuntimeBehavior> = ...

    callbacksFirstRuntimeSceneLoaded

    callbacksFirstRuntimeSceneLoaded: RuntimeSceneCallback[] = []

    callbacksObjectDeletedFromScene

    callbacksObjectDeletedFromScene: RuntimeSceneRuntimeObjectCallback[] = []

    callbacksRuntimeSceneLoaded

    callbacksRuntimeSceneLoaded: RuntimeSceneCallback[] = []

    callbacksRuntimeScenePaused

    callbacksRuntimeScenePaused: RuntimeSceneCallback[] = []

    callbacksRuntimeScenePostEvents

    callbacksRuntimeScenePostEvents: RuntimeSceneCallback[] = []

    callbacksRuntimeScenePreEvents

    callbacksRuntimeScenePreEvents: RuntimeSceneCallback[] = []

    callbacksRuntimeSceneResumed

    callbacksRuntimeSceneResumed: RuntimeSceneCallback[] = []

    callbacksRuntimeSceneUnloaded

    callbacksRuntimeSceneUnloaded: RuntimeSceneCallback[] = []

    callbacksRuntimeSceneUnloading

    callbacksRuntimeSceneUnloading: RuntimeSceneCallback[] = []

    gdevelopLogo

    gdevelopLogo: string = ''
    +

    VideoRuntimeObjectRenderer

    VideoRuntimeObjectRenderer: VideoRuntimeObjectPixiRenderer

    Variables

    BBTextRuntimeObjectRenderer

    BBTextRuntimeObjectRenderer: typeof BBTextRuntimeObjectPixiRenderer = BBTextRuntimeObjectPixiRenderer

    BitmapFontManager

    BitmapFontManager: typeof PixiBitmapFontManager = gdjs.PixiBitmapFontManager

    BitmapTextRuntimeObjectRenderer

    BitmapTextRuntimeObjectRenderer: typeof BitmapTextRuntimeObjectPixiRenderer = BitmapTextRuntimeObjectPixiRenderer

    Cube3DRuntimeObjectRenderer

    Cube3DRuntimeObjectRenderer: typeof Cube3DRuntimeObjectPixiRenderer = Cube3DRuntimeObjectPixiRenderer

    CustomRuntimeObject2DRenderer

    CustomRuntimeObject2DRenderer: typeof CustomRuntimeObject2DPixiRenderer

    DebuggerClient

    DebuggerClient: typeof WebsocketDebuggerClient = WebsocketDebuggerClient

    DebuggerRenderer

    DebuggerRenderer: typeof DebuggerPixiRenderer

    DummyRuntimeObjectRenderer

    DummyRuntimeObjectRenderer: typeof DummyRuntimeObjectPixiRenderer = DummyRuntimeObjectPixiRenderer

    EffectsManager

    EffectsManager: typeof PixiEffectsManager = PixiEffectsManager

    FontManager

    FontManager: typeof FontFaceObserverFontManager

    ImageManager

    ImageManager: typeof PixiImageManager = gdjs.PixiImageManager

    LayerRenderer

    LayerRenderer: typeof LayerPixiRenderer

    LightRuntimeObjectRenderer

    LightRuntimeObjectRenderer: typeof LightRuntimeObjectPixiRenderer = LightRuntimeObjectPixiRenderer

    LoadingScreenRenderer

    LoadingScreenRenderer: typeof LoadingScreenPixiRenderer = LoadingScreenPixiRenderer

    Model3DRuntimeObjectRenderer

    Model3DRuntimeObjectRenderer: typeof Model3DRuntimeObject3DRenderer = Model3DRuntimeObject3DRenderer

    PanelSpriteRuntimeObjectRenderer

    PanelSpriteRuntimeObjectRenderer: typeof PanelSpriteRuntimeObjectPixiRenderer = PanelSpriteRuntimeObjectPixiRenderer

    ParticleEmitterObjectRenderer

    ParticleEmitterObjectRenderer: typeof ParticleEmitterObjectPixiRenderer = ParticleEmitterObjectPixiRenderer

    RuntimeGameRenderer

    RuntimeGameRenderer: typeof RuntimeGamePixiRenderer

    RuntimeSceneRenderer

    RuntimeSceneRenderer: typeof RuntimeScenePixiRenderer

    ShapePainterRuntimeObjectRenderer

    ShapePainterRuntimeObjectRenderer: typeof ShapePainterRuntimeObjectPixiRenderer = ShapePainterRuntimeObjectPixiRenderer

    SoundManager

    SoundManager: typeof HowlerSoundManager = HowlerSoundManager

    SpineRuntimeObjectRenderer

    SpineRuntimeObjectRenderer: typeof SpineRuntimeObjectPixiRenderer = SpineRuntimeObjectPixiRenderer

    SpriteRuntimeObjectRenderer

    SpriteRuntimeObjectRenderer: typeof SpriteRuntimeObjectPixiRenderer = SpriteRuntimeObjectPixiRenderer

    TextEntryRuntimeObjectRenderer

    TextEntryRuntimeObjectRenderer: typeof TextEntryRuntimeObjectPixiRenderer = TextEntryRuntimeObjectPixiRenderer

    TextInputRuntimeObjectRenderer

    TextInputRuntimeObjectRenderer: typeof TextInputRuntimeObjectPixiRenderer = TextInputRuntimeObjectPixiRenderer

    TextRuntimeObjectRenderer

    TextRuntimeObjectRenderer: typeof TextRuntimeObjectPixiRenderer = TextRuntimeObjectPixiRenderer

    TileMapRuntimeObjectRenderer

    TileMapRuntimeObjectRenderer: typeof TileMapRuntimeObjectPixiRenderer = gdjs.TileMapRuntimeObjectPixiRenderer

    TiledSpriteRuntimeObjectRenderer

    TiledSpriteRuntimeObjectRenderer: typeof TiledSpriteRuntimeObjectPixiRenderer = TiledSpriteRuntimeObjectPixiRenderer

    VideoRuntimeObjectRenderer

    VideoRuntimeObjectRenderer: typeof VideoRuntimeObjectPixiRenderer = VideoRuntimeObjectPixiRenderer

    behaviorsTypes

    behaviorsTypes: Hashtable<typeof RuntimeBehavior> = ...

    callbacksFirstRuntimeSceneLoaded

    callbacksFirstRuntimeSceneLoaded: RuntimeSceneCallback[] = []

    callbacksObjectDeletedFromScene

    callbacksObjectDeletedFromScene: RuntimeSceneRuntimeObjectCallback[] = []

    callbacksRuntimeSceneLoaded

    callbacksRuntimeSceneLoaded: RuntimeSceneCallback[] = []

    callbacksRuntimeScenePaused

    callbacksRuntimeScenePaused: RuntimeSceneCallback[] = []

    callbacksRuntimeScenePostEvents

    callbacksRuntimeScenePostEvents: RuntimeSceneCallback[] = []

    callbacksRuntimeScenePreEvents

    callbacksRuntimeScenePreEvents: RuntimeSceneCallback[] = []

    callbacksRuntimeSceneResumed

    callbacksRuntimeSceneResumed: RuntimeSceneCallback[] = []

    callbacksRuntimeSceneUnloaded

    callbacksRuntimeSceneUnloaded: RuntimeSceneCallback[] = []

    callbacksRuntimeSceneUnloading

    callbacksRuntimeSceneUnloading: RuntimeSceneCallback[] = []

    gdevelopLogo

    gdevelopLogo: string = ''

    Base64 encoded logo of GDevelop for the splash screen.

    -

    makeUuid

    makeUuid: MakeUUID = ...
    +

    makeUuid

    makeUuid: MakeUUID = ...

    Generate a UUID v4.

    returns

    The generated UUID.

    -

    multiplayerMessageManager

    multiplayerMessageManager: { addExpectedMessageAcknowledgement: (__namedParameters: { expectedMessageName: string; maxNumberOfRetries?: number; messageRetryTime?: number; originalData: any; originalMessageName: string; otherPeerIds: string[]; shouldCancelMessageIfTimesOut: boolean }) => void; clearDisconnectedPeers: () => void; clearExpectedMessageAcknowledgements: () => void; createChangeInstanceOwnerMessage: (__namedParameters: { instanceNetworkId: string; instanceX: number; instanceY: number; newObjectOwner: number; objectName: string; objectOwner: number; sceneNetworkId: string }) => { messageData: { instanceX: number; instanceY: number; newOwner: number; previousOwner: number; sceneNetworkId: string }; messageName: string }; createChangeVariableOwnerMessage: (__namedParameters: { newVariableOwner: number; variableNetworkId: string; variableOwner: number }) => { messageData: { newOwner: number; previousOwner: number }; messageName: string }; createDestroyInstanceMessage: (__namedParameters: { instanceNetworkId: string; objectName: string; objectOwner: number; sceneNetworkId: string }) => { messageData: any; messageName: string }; createInstanceDestroyedMessageNameFromDestroyInstanceMessage: (messageName: string) => string; createInstanceOwnerChangedMessageNameFromChangeInstanceOwnerMessage: (messageName: string) => string; createUpdateGameMessage: (__namedParameters: { gameNetworkSyncData: GameNetworkSyncData }) => { messageData: any; messageName: string }; createUpdateInstanceMessage: (__namedParameters: { instanceNetworkId: string; objectName: string; objectNetworkSyncData: ObjectNetworkSyncData; objectOwner: number; sceneNetworkId: string }) => { messageData: any; messageName: string }; createUpdateSceneMessage: (__namedParameters: { sceneNetworkSyncData: LayoutNetworkSyncData }) => { messageData: LayoutNetworkSyncData; messageName: string }; createVariableOwnerChangedMessageNameFromChangeVariableOwnerMessage: (messageName: string) => string; getCurrentPlayerPing: () => number; getCustomMessageData: (userMessageName: string) => any; getCustomMessageSender: (userMessageName: string) => number; getDisconnectedPlayers: () => number[]; getNumberOfConnectedPlayers: () => number; getPlayerPing: (playerNumber: number) => number; getVariableCustomMessageData: (userMessageName: string, variable: Variable) => void; handleAcknowledgeMessagesReceived: () => void; handleChangeInstanceOwnerMessagesReceived: (runtimeScene: RuntimeScene) => void; handleChangeVariableOwnerMessagesReceived: (runtimeScene: RuntimeScene) => void; handleCustomMessagesReceived: () => void; handleDestroyInstanceMessagesReceived: (runtimeScene: RuntimeScene) => void; handleDisconnectedPeers: (runtimeScene: RuntimeScene) => void; handleEndGameMessages: () => void; handleHeartbeatsReceived: () => void; handleHeartbeatsToSend: () => void; handleUpdateGameMessagesReceived: (runtimeScene: RuntimeScene) => void; handleUpdateGameMessagesToSend: (runtimeScene: RuntimeScene) => void; handleUpdateInstanceMessagesReceived: (runtimeScene: RuntimeScene) => void; handleUpdateSceneMessagesReceived: (runtimeScene: RuntimeScene) => void; handleUpdateSceneMessagesToSend: (runtimeScene: RuntimeScene) => void; hasAnyPlayerLeft: () => boolean; hasCustomMessageBeenReceived: (userMessageName: string) => undefined | false; hasPlayerLeft: (playerNumber: number) => boolean; isPlayerConnected: (playerNumber: number) => boolean; resendClearOrCancelAcknowledgedMessages: (runtimeScene: RuntimeScene) => void; sendCustomMessage: (userMessageName: string, userMessageData: any) => void; sendDataTo: (peerIds: string[], messageName: string, data: object) => void; sendEndGameMessage: () => void; sendVariableCustomMessage: (userMessageName: string, variable: Variable) => void; updatePlayersPingsForTests: (playersPings: any) => void } = ...
    +

    multiplayerMessageManager

    multiplayerMessageManager: { addExpectedMessageAcknowledgement: (__namedParameters: { expectedMessageName: string; maxNumberOfRetries?: number; messageRetryTime?: number; originalData: any; originalMessageName: string; otherPeerIds: string[]; shouldCancelMessageIfTimesOut: boolean }) => void; clearDisconnectedPeers: () => void; clearExpectedMessageAcknowledgements: () => void; createChangeInstanceOwnerMessage: (__namedParameters: { instanceNetworkId: string; instanceX: number; instanceY: number; newObjectOwner: number; objectName: string; objectOwner: number; sceneNetworkId: string }) => { messageData: { instanceX: number; instanceY: number; newOwner: number; previousOwner: number; sceneNetworkId: string }; messageName: string }; createChangeVariableOwnerMessage: (__namedParameters: { newVariableOwner: number; variableNetworkId: string; variableOwner: number }) => { messageData: { newOwner: number; previousOwner: number }; messageName: string }; createDestroyInstanceMessage: (__namedParameters: { instanceNetworkId: string; objectName: string; objectOwner: number; sceneNetworkId: string }) => { messageData: any; messageName: string }; createInstanceDestroyedMessageNameFromDestroyInstanceMessage: (messageName: string) => string; createInstanceOwnerChangedMessageNameFromChangeInstanceOwnerMessage: (messageName: string) => string; createUpdateGameMessage: (__namedParameters: { gameNetworkSyncData: GameNetworkSyncData }) => { messageData: any; messageName: string }; createUpdateInstanceMessage: (__namedParameters: { instanceNetworkId: string; objectName: string; objectNetworkSyncData: ObjectNetworkSyncData; objectOwner: number; sceneNetworkId: string }) => { messageData: any; messageName: string }; createUpdateSceneMessage: (__namedParameters: { sceneNetworkSyncData: LayoutNetworkSyncData }) => { messageData: LayoutNetworkSyncData; messageName: string }; createVariableOwnerChangedMessageNameFromChangeVariableOwnerMessage: (messageName: string) => string; getCurrentPlayerPing: () => number; getCustomMessageData: (userMessageName: string) => any; getCustomMessageSender: (userMessageName: string) => number; getDisconnectedPlayers: () => number[]; getNumberOfConnectedPlayers: () => number; getPlayerPing: (playerNumber: number) => number; getVariableCustomMessageData: (userMessageName: string, variable: Variable) => void; handleAcknowledgeMessagesReceived: () => void; handleChangeInstanceOwnerMessagesReceived: (runtimeScene: RuntimeScene) => void; handleChangeVariableOwnerMessagesReceived: (runtimeScene: RuntimeScene) => void; handleCustomMessagesReceived: () => void; handleDestroyInstanceMessagesReceived: (runtimeScene: RuntimeScene) => void; handleDisconnectedPeers: (runtimeScene: RuntimeScene) => void; handleEndGameMessages: () => void; handleHeartbeatsReceived: () => void; handleHeartbeatsToSend: () => void; handleUpdateGameMessagesReceived: (runtimeScene: RuntimeScene) => void; handleUpdateGameMessagesToSend: (runtimeScene: RuntimeScene) => void; handleUpdateInstanceMessagesReceived: (runtimeScene: RuntimeScene) => void; handleUpdateSceneMessagesReceived: (runtimeScene: RuntimeScene) => void; handleUpdateSceneMessagesToSend: (runtimeScene: RuntimeScene) => void; hasAnyPlayerLeft: () => boolean; hasCustomMessageBeenReceived: (userMessageName: string) => undefined | false; hasPlayerLeft: (playerNumber: number) => boolean; isPlayerConnected: (playerNumber: number) => boolean; resendClearOrCancelAcknowledgedMessages: (runtimeScene: RuntimeScene) => void; sendCustomMessage: (userMessageName: string, userMessageData: any) => void; sendDataTo: (peerIds: string[], messageName: string, data: object) => void; sendEndGameMessage: () => void; sendVariableCustomMessage: (userMessageName: string, variable: Variable) => void; updatePlayersPingsForTests: (playersPings: any) => void } = ...

    The MultiplayerMessageManager used by the game.

    Type declaration

    • addExpectedMessageAcknowledgement: (__namedParameters: { expectedMessageName: string; maxNumberOfRetries?: number; messageRetryTime?: number; originalData: any; originalMessageName: string; otherPeerIds: string[]; shouldCancelMessageIfTimesOut: boolean }) => void
        • (__namedParameters: { expectedMessageName: string; maxNumberOfRetries?: number; messageRetryTime?: number; originalData: any; originalMessageName: string; otherPeerIds: string[]; shouldCancelMessageIfTimesOut: boolean }): void

        • Parameters

          • __namedParameters: { expectedMessageName: string; maxNumberOfRetries?: number; messageRetryTime?: number; originalData: any; originalMessageName: string; otherPeerIds: string[]; shouldCancelMessageIfTimesOut: boolean }
            • expectedMessageName: string
            • Optional maxNumberOfRetries?: number
            • Optional messageRetryTime?: number
            • originalData: any
            • originalMessageName: string
            • otherPeerIds: string[]
            • shouldCancelMessageIfTimesOut: boolean

          Returns void

    • clearDisconnectedPeers: () => void
        • (): void

        • Returns void

    • clearExpectedMessageAcknowledgements: () => void
        • (): void

        • Returns void

    • createChangeInstanceOwnerMessage: (__namedParameters: { instanceNetworkId: string; instanceX: number; instanceY: number; newObjectOwner: number; objectName: string; objectOwner: number; sceneNetworkId: string }) => { messageData: { instanceX: number; instanceY: number; newOwner: number; previousOwner: number; sceneNetworkId: string }; messageName: string }
        • (__namedParameters: { instanceNetworkId: string; instanceX: number; instanceY: number; newObjectOwner: number; objectName: string; objectOwner: number; sceneNetworkId: string }): { messageData: { instanceX: number; instanceY: number; newOwner: number; previousOwner: number; sceneNetworkId: string }; messageName: string }

        • Parameters

          • __namedParameters: { instanceNetworkId: string; instanceX: number; instanceY: number; newObjectOwner: number; objectName: string; objectOwner: number; sceneNetworkId: string }
            • instanceNetworkId: string
            • instanceX: number
            • instanceY: number
            • newObjectOwner: number
            • objectName: string
            • objectOwner: number
            • sceneNetworkId: string

          Returns { messageData: { instanceX: number; instanceY: number; newOwner: number; previousOwner: number; sceneNetworkId: string }; messageName: string }

          • messageData: { instanceX: number; instanceY: number; newOwner: number; previousOwner: number; sceneNetworkId: string }
            • instanceX: number
            • instanceY: number
            • newOwner: number
            • previousOwner: number
            • sceneNetworkId: string
          • messageName: string
    • createChangeVariableOwnerMessage: (__namedParameters: { newVariableOwner: number; variableNetworkId: string; variableOwner: number }) => { messageData: { newOwner: number; previousOwner: number }; messageName: string }
        • (__namedParameters: { newVariableOwner: number; variableNetworkId: string; variableOwner: number }): { messageData: { newOwner: number; previousOwner: number }; messageName: string }

        • Parameters

          • __namedParameters: { newVariableOwner: number; variableNetworkId: string; variableOwner: number }
            • newVariableOwner: number
            • variableNetworkId: string
            • variableOwner: number

          Returns { messageData: { newOwner: number; previousOwner: number }; messageName: string }

          • messageData: { newOwner: number; previousOwner: number }
            • newOwner: number
            • previousOwner: number
          • messageName: string
    • createDestroyInstanceMessage: (__namedParameters: { instanceNetworkId: string; objectName: string; objectOwner: number; sceneNetworkId: string }) => { messageData: any; messageName: string }
        • (__namedParameters: { instanceNetworkId: string; objectName: string; objectOwner: number; sceneNetworkId: string }): { messageData: any; messageName: string }

        • Parameters

          • __namedParameters: { instanceNetworkId: string; objectName: string; objectOwner: number; sceneNetworkId: string }
            • instanceNetworkId: string
            • objectName: string
            • objectOwner: number
            • sceneNetworkId: string

          Returns { messageData: any; messageName: string }

          • messageData: any
          • messageName: string
    • createInstanceDestroyedMessageNameFromDestroyInstanceMessage: (messageName: string) => string
        • (messageName: string): string

        • Parameters

          • messageName: string

          Returns string

    • createInstanceOwnerChangedMessageNameFromChangeInstanceOwnerMessage: (messageName: string) => string
        • (messageName: string): string

        • Parameters

          • messageName: string

          Returns string

    • createUpdateGameMessage: (__namedParameters: { gameNetworkSyncData: GameNetworkSyncData }) => { messageData: any; messageName: string }
        • (__namedParameters: { gameNetworkSyncData: GameNetworkSyncData }): { messageData: any; messageName: string }

        • Parameters

          • __namedParameters: { gameNetworkSyncData: GameNetworkSyncData }
            • gameNetworkSyncData: GameNetworkSyncData

          Returns { messageData: any; messageName: string }

          • messageData: any
          • messageName: string
    • createUpdateInstanceMessage: (__namedParameters: { instanceNetworkId: string; objectName: string; objectNetworkSyncData: ObjectNetworkSyncData; objectOwner: number; sceneNetworkId: string }) => { messageData: any; messageName: string }
        • (__namedParameters: { instanceNetworkId: string; objectName: string; objectNetworkSyncData: ObjectNetworkSyncData; objectOwner: number; sceneNetworkId: string }): { messageData: any; messageName: string }

        • Parameters

          • __namedParameters: { instanceNetworkId: string; objectName: string; objectNetworkSyncData: ObjectNetworkSyncData; objectOwner: number; sceneNetworkId: string }
            • instanceNetworkId: string
            • objectName: string
            • objectNetworkSyncData: ObjectNetworkSyncData
            • objectOwner: number
            • sceneNetworkId: string

          Returns { messageData: any; messageName: string }

          • messageData: any
          • messageName: string
    • createUpdateSceneMessage: (__namedParameters: { sceneNetworkSyncData: LayoutNetworkSyncData }) => { messageData: LayoutNetworkSyncData; messageName: string }
        • (__namedParameters: { sceneNetworkSyncData: LayoutNetworkSyncData }): { messageData: LayoutNetworkSyncData; messageName: string }

        • Parameters

          • __namedParameters: { sceneNetworkSyncData: LayoutNetworkSyncData }
            • sceneNetworkSyncData: LayoutNetworkSyncData

          Returns { messageData: LayoutNetworkSyncData; messageName: string }

          • messageData: LayoutNetworkSyncData
          • messageName: string
    • createVariableOwnerChangedMessageNameFromChangeVariableOwnerMessage: (messageName: string) => string
        • (messageName: string): string

        • Parameters

          • messageName: string

          Returns string

    • getCurrentPlayerPing: () => number
        • (): number

        • Returns number

    • getCustomMessageData: (userMessageName: string) => any
        • (userMessageName: string): any

        • Parameters

          • userMessageName: string

          Returns any

    • getCustomMessageSender: (userMessageName: string) => number
        • (userMessageName: string): number

        • Parameters

          • userMessageName: string

          Returns number

    • getDisconnectedPlayers: () => number[]
        • (): number[]

        • Returns number[]

    • getNumberOfConnectedPlayers: () => number
        • (): number

        • Returns number

    • getPlayerPing: (playerNumber: number) => number
        • (playerNumber: number): number

        • Parameters

          • playerNumber: number

          Returns number

    • getVariableCustomMessageData: (userMessageName: string, variable: Variable) => void
        • (userMessageName: string, variable: Variable): void

        • Parameters

          • userMessageName: string
          • variable: Variable

          Returns void

    • handleAcknowledgeMessagesReceived: () => void
        • (): void

        • Returns void

    • handleChangeInstanceOwnerMessagesReceived: (runtimeScene: RuntimeScene) => void
    • handleChangeVariableOwnerMessagesReceived: (runtimeScene: RuntimeScene) => void
    • handleCustomMessagesReceived: () => void
        • (): void

        • Returns void

    • handleDestroyInstanceMessagesReceived: (runtimeScene: RuntimeScene) => void
    • handleDisconnectedPeers: (runtimeScene: RuntimeScene) => void
    • handleEndGameMessages: () => void
        • (): void

        • Returns void

    • handleHeartbeatsReceived: () => void
        • (): void

        • Returns void

    • handleHeartbeatsToSend: () => void
        • (): void

        • Returns void

    • handleUpdateGameMessagesReceived: (runtimeScene: RuntimeScene) => void
    • handleUpdateGameMessagesToSend: (runtimeScene: RuntimeScene) => void
    • handleUpdateInstanceMessagesReceived: (runtimeScene: RuntimeScene) => void
    • handleUpdateSceneMessagesReceived: (runtimeScene: RuntimeScene) => void
    • handleUpdateSceneMessagesToSend: (runtimeScene: RuntimeScene) => void
    • hasAnyPlayerLeft: () => boolean
        • (): boolean

        • Returns boolean

    • hasCustomMessageBeenReceived: (userMessageName: string) => undefined | false
        • (userMessageName: string): undefined | false

        • Parameters

          • userMessageName: string

          Returns undefined | false

    • hasPlayerLeft: (playerNumber: number) => boolean
        • (playerNumber: number): boolean

        • Parameters

          • playerNumber: number

          Returns boolean

    • isPlayerConnected: (playerNumber: number) => boolean
        • (playerNumber: number): boolean

        • Parameters

          • playerNumber: number

          Returns boolean

    • resendClearOrCancelAcknowledgedMessages: (runtimeScene: RuntimeScene) => void
    • sendCustomMessage: (userMessageName: string, userMessageData: any) => void
        • (userMessageName: string, userMessageData: any): void

        • Parameters

          • userMessageName: string
          • userMessageData: any

          Returns void

    • sendDataTo: (peerIds: string[], messageName: string, data: object) => void
        • (peerIds: string[], messageName: string, data: object): void

        • Main function to send messages to other players, via P2P. Takes into account the simulation of network latency and packet loss.

          -

          Parameters

          • peerIds: string[]
          • messageName: string
          • data: object

          Returns void

    • sendEndGameMessage: () => void
        • (): void

        • Returns void

    • sendVariableCustomMessage: (userMessageName: string, variable: Variable) => void
        • (userMessageName: string, variable: Variable): void

        • Parameters

          • userMessageName: string
          • variable: Variable

          Returns void

    • updatePlayersPingsForTests: (playersPings: any) => void
        • (playersPings: any): void

        • Parameters

          • playersPings: any

          Returns void

    multiplayerVariablesManager

    multiplayerVariablesManager: { disableVariableSynchronization: (runtimeScene: RuntimeScene, variable: Variable) => void; getPlayerVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable) => null | number; getVariableTypeAndNameFromNetworkId: (variableNetworkId: string) => { containerId: string; name: string; type: string }; handleChangeVariableOwnerMessagesToSend: () => void; removeVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable) => void; setPlayerVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable, newVariablePlayerNumber: number) => void; takeVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable) => void } = ...
    +

    Parameters

    • peerIds: string[]
    • messageName: string
    • data: object

    Returns void

  • sendEndGameMessage: () => void
      • (): void

      • Returns void

  • sendVariableCustomMessage: (userMessageName: string, variable: Variable) => void
      • (userMessageName: string, variable: Variable): void

      • Parameters

        • userMessageName: string
        • variable: Variable

        Returns void

  • updatePlayersPingsForTests: (playersPings: any) => void
      • (playersPings: any): void

      • Parameters

        • playersPings: any

        Returns void

    • multiplayerVariablesManager

    multiplayerVariablesManager: { disableVariableSynchronization: (runtimeScene: RuntimeScene, variable: Variable) => void; getPlayerVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable) => null | number; getVariableTypeAndNameFromNetworkId: (variableNetworkId: string) => { containerId: string; name: string; type: string }; handleChangeVariableOwnerMessagesToSend: () => void; removeVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable) => void; setPlayerVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable, newVariablePlayerNumber: number) => void; takeVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable) => void } = ...

    The MultiplayerVariablesManager used by the game.

    -

    Type declaration

    • disableVariableSynchronization: (runtimeScene: RuntimeScene, variable: Variable) => void
    • getPlayerVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable) => null | number
    • getVariableTypeAndNameFromNetworkId: (variableNetworkId: string) => { containerId: string; name: string; type: string }
        • (variableNetworkId: string): { containerId: string; name: string; type: string }

        • Parameters

          • variableNetworkId: string

          Returns { containerId: string; name: string; type: string }

          • containerId: string
          • name: string
          • type: string
    • handleChangeVariableOwnerMessagesToSend: () => void
        • (): void

        • Returns void

    • removeVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable) => void
    • setPlayerVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable, newVariablePlayerNumber: number) => void
    • takeVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable) => void

    objectsTypes

    objectsTypes: Hashtable<typeof RuntimeObject> = ...

    projectData

    projectData: ProjectData

    runtimeGameOptions

    runtimeGameOptions: RuntimeGameOptions

    Functions

    Const copyArray

    • copyArray<T>(src: T[], dst: T[]): void

    objectsTypes

    objectsTypes: Hashtable<typeof RuntimeObject> = ...

    projectData

    projectData: ProjectData

    runtimeGameOptions

    runtimeGameOptions: RuntimeGameOptions

    Functions

    Const copyArray

    • copyArray<T>(src: T[], dst: T[]): void

    • Copy the element for the first array into the second array, so that both array contains the same elements.

      Type parameters

      • T

      Parameters

      • src: T[]

        The source array

      • dst: T[]

        The destination array

        -

      Returns void

    Const getAllAsynchronouslyLoadingLibraryPromise

    • getAllAsynchronouslyLoadingLibraryPromise(): Promise<any[]>

    • Returns Promise<any[]>

      a promise resolved when all all third party libraries, which need +

    Returns void

    Const getAllAsynchronouslyLoadingLibraryPromise

    • getAllAsynchronouslyLoadingLibraryPromise(): Promise<any[]>

    • Returns Promise<any[]>

      a promise resolved when all all third party libraries, which need to be loaded before the game startup, are loaded. If a library fails loading, this will be rejected.

      -

    Const getBehaviorConstructor

    Const getBehaviorConstructor

    Const getObjectConstructor

    Returns typeof RuntimeBehavior

    Const getObjectConstructor

    Const hexNumberToRGB

    • hexNumberToRGB(hexNumber: number): { a: number; b: number; g: number; r: number }

    Returns typeof RuntimeObject

    Const hexNumberToRGB

    • hexNumberToRGB(hexNumber: number): { a: number; b: number; g: number; r: number }

    • Convert a Hex number to a RGB color object ({r,g,b,a} with each component going from 0 to 255 and alpha set to 255).

      -

      Parameters

      • hexNumber: number

      Returns { a: number; b: number; g: number; r: number }

      • a: number
      • b: number
      • g: number
      • r: number

    Const hexNumberToRGBArray

    • hexNumberToRGBArray(hexNumber: number): [number, number, number]
    • +

      Parameters

      • hexNumber: number

      Returns { a: number; b: number; g: number; r: number }

      • a: number
      • b: number
      • g: number
      • r: number

    Const hexNumberToRGBArray

    • hexNumberToRGBArray(hexNumber: number): [number, number, number]

    • Convert a Hex number to a RGB color array([r,g,b] with each component going from 0 to 255).

      -

      Parameters

      • hexNumber: number

      Returns [number, number, number]

    Const hexToRGBColor

    • hexToRGBColor(hexString: string): [number, number, number]

    Const hexToRGBColor

    • hexToRGBColor(hexString: string): [number, number, number]

    • Convert a Hex string to an RGB color array [r, g, b], where each component is in the range [0, 255].

      -

      Parameters

      • hexString: string

      Returns [number, number, number]

    Const makeMultiplayerMessageManager

    • makeMultiplayerMessageManager(): { addExpectedMessageAcknowledgement: (__namedParameters: { expectedMessageName: string; maxNumberOfRetries?: number; messageRetryTime?: number; originalData: any; originalMessageName: string; otherPeerIds: string[]; shouldCancelMessageIfTimesOut: boolean }) => void; clearDisconnectedPeers: () => void; clearExpectedMessageAcknowledgements: () => void; createChangeInstanceOwnerMessage: (__namedParameters: { instanceNetworkId: string; instanceX: number; instanceY: number; newObjectOwner: number; objectName: string; objectOwner: number; sceneNetworkId: string }) => { messageData: { instanceX: number; instanceY: number; newOwner: number; previousOwner: number; sceneNetworkId: string }; messageName: string }; createChangeVariableOwnerMessage: (__namedParameters: { newVariableOwner: number; variableNetworkId: string; variableOwner: number }) => { messageData: { newOwner: number; previousOwner: number }; messageName: string }; createDestroyInstanceMessage: (__namedParameters: { instanceNetworkId: string; objectName: string; objectOwner: number; sceneNetworkId: string }) => { messageData: any; messageName: string }; createInstanceDestroyedMessageNameFromDestroyInstanceMessage: (messageName: string) => string; createInstanceOwnerChangedMessageNameFromChangeInstanceOwnerMessage: (messageName: string) => string; createUpdateGameMessage: (__namedParameters: { gameNetworkSyncData: GameNetworkSyncData }) => { messageData: any; messageName: string }; createUpdateInstanceMessage: (__namedParameters: { instanceNetworkId: string; objectName: string; objectNetworkSyncData: ObjectNetworkSyncData; objectOwner: number; sceneNetworkId: string }) => { messageData: any; messageName: string }; createUpdateSceneMessage: (__namedParameters: { sceneNetworkSyncData: LayoutNetworkSyncData }) => { messageData: LayoutNetworkSyncData; messageName: string }; createVariableOwnerChangedMessageNameFromChangeVariableOwnerMessage: (messageName: string) => string; getCurrentPlayerPing: () => number; getCustomMessageData: (userMessageName: string) => any; getCustomMessageSender: (userMessageName: string) => number; getDisconnectedPlayers: () => number[]; getNumberOfConnectedPlayers: () => number; getPlayerPing: (playerNumber: number) => number; getVariableCustomMessageData: (userMessageName: string, variable: Variable) => void; handleAcknowledgeMessagesReceived: () => void; handleChangeInstanceOwnerMessagesReceived: (runtimeScene: RuntimeScene) => void; handleChangeVariableOwnerMessagesReceived: (runtimeScene: RuntimeScene) => void; handleCustomMessagesReceived: () => void; handleDestroyInstanceMessagesReceived: (runtimeScene: RuntimeScene) => void; handleDisconnectedPeers: (runtimeScene: RuntimeScene) => void; handleEndGameMessages: () => void; handleHeartbeatsReceived: () => void; handleHeartbeatsToSend: () => void; handleUpdateGameMessagesReceived: (runtimeScene: RuntimeScene) => void; handleUpdateGameMessagesToSend: (runtimeScene: RuntimeScene) => void; handleUpdateInstanceMessagesReceived: (runtimeScene: RuntimeScene) => void; handleUpdateSceneMessagesReceived: (runtimeScene: RuntimeScene) => void; handleUpdateSceneMessagesToSend: (runtimeScene: RuntimeScene) => void; hasAnyPlayerLeft: () => boolean; hasCustomMessageBeenReceived: (userMessageName: string) => undefined | false; hasPlayerLeft: (playerNumber: number) => boolean; isPlayerConnected: (playerNumber: number) => boolean; resendClearOrCancelAcknowledgedMessages: (runtimeScene: RuntimeScene) => void; sendCustomMessage: (userMessageName: string, userMessageData: any) => void; sendDataTo: (peerIds: string[], messageName: string, data: object) => void; sendEndGameMessage: () => void; sendVariableCustomMessage: (userMessageName: string, variable: Variable) => void; updatePlayersPingsForTests: (playersPings: any) => void }

    Const makeMultiplayerMessageManager

    • makeMultiplayerMessageManager(): { addExpectedMessageAcknowledgement: (__namedParameters: { expectedMessageName: string; maxNumberOfRetries?: number; messageRetryTime?: number; originalData: any; originalMessageName: string; otherPeerIds: string[]; shouldCancelMessageIfTimesOut: boolean }) => void; clearDisconnectedPeers: () => void; clearExpectedMessageAcknowledgements: () => void; createChangeInstanceOwnerMessage: (__namedParameters: { instanceNetworkId: string; instanceX: number; instanceY: number; newObjectOwner: number; objectName: string; objectOwner: number; sceneNetworkId: string }) => { messageData: { instanceX: number; instanceY: number; newOwner: number; previousOwner: number; sceneNetworkId: string }; messageName: string }; createChangeVariableOwnerMessage: (__namedParameters: { newVariableOwner: number; variableNetworkId: string; variableOwner: number }) => { messageData: { newOwner: number; previousOwner: number }; messageName: string }; createDestroyInstanceMessage: (__namedParameters: { instanceNetworkId: string; objectName: string; objectOwner: number; sceneNetworkId: string }) => { messageData: any; messageName: string }; createInstanceDestroyedMessageNameFromDestroyInstanceMessage: (messageName: string) => string; createInstanceOwnerChangedMessageNameFromChangeInstanceOwnerMessage: (messageName: string) => string; createUpdateGameMessage: (__namedParameters: { gameNetworkSyncData: GameNetworkSyncData }) => { messageData: any; messageName: string }; createUpdateInstanceMessage: (__namedParameters: { instanceNetworkId: string; objectName: string; objectNetworkSyncData: ObjectNetworkSyncData; objectOwner: number; sceneNetworkId: string }) => { messageData: any; messageName: string }; createUpdateSceneMessage: (__namedParameters: { sceneNetworkSyncData: LayoutNetworkSyncData }) => { messageData: LayoutNetworkSyncData; messageName: string }; createVariableOwnerChangedMessageNameFromChangeVariableOwnerMessage: (messageName: string) => string; getCurrentPlayerPing: () => number; getCustomMessageData: (userMessageName: string) => any; getCustomMessageSender: (userMessageName: string) => number; getDisconnectedPlayers: () => number[]; getNumberOfConnectedPlayers: () => number; getPlayerPing: (playerNumber: number) => number; getVariableCustomMessageData: (userMessageName: string, variable: Variable) => void; handleAcknowledgeMessagesReceived: () => void; handleChangeInstanceOwnerMessagesReceived: (runtimeScene: RuntimeScene) => void; handleChangeVariableOwnerMessagesReceived: (runtimeScene: RuntimeScene) => void; handleCustomMessagesReceived: () => void; handleDestroyInstanceMessagesReceived: (runtimeScene: RuntimeScene) => void; handleDisconnectedPeers: (runtimeScene: RuntimeScene) => void; handleEndGameMessages: () => void; handleHeartbeatsReceived: () => void; handleHeartbeatsToSend: () => void; handleUpdateGameMessagesReceived: (runtimeScene: RuntimeScene) => void; handleUpdateGameMessagesToSend: (runtimeScene: RuntimeScene) => void; handleUpdateInstanceMessagesReceived: (runtimeScene: RuntimeScene) => void; handleUpdateSceneMessagesReceived: (runtimeScene: RuntimeScene) => void; handleUpdateSceneMessagesToSend: (runtimeScene: RuntimeScene) => void; hasAnyPlayerLeft: () => boolean; hasCustomMessageBeenReceived: (userMessageName: string) => undefined | false; hasPlayerLeft: (playerNumber: number) => boolean; isPlayerConnected: (playerNumber: number) => boolean; resendClearOrCancelAcknowledgedMessages: (runtimeScene: RuntimeScene) => void; sendCustomMessage: (userMessageName: string, userMessageData: any) => void; sendDataTo: (peerIds: string[], messageName: string, data: object) => void; sendEndGameMessage: () => void; sendVariableCustomMessage: (userMessageName: string, variable: Variable) => void; updatePlayersPingsForTests: (playersPings: any) => void }

    • Create a new MultiplayerMessageManager.

      In most cases, you should use the default gdjs.multiplayerMessageManager instead.

      Returns { addExpectedMessageAcknowledgement: (__namedParameters: { expectedMessageName: string; maxNumberOfRetries?: number; messageRetryTime?: number; originalData: any; originalMessageName: string; otherPeerIds: string[]; shouldCancelMessageIfTimesOut: boolean }) => void; clearDisconnectedPeers: () => void; clearExpectedMessageAcknowledgements: () => void; createChangeInstanceOwnerMessage: (__namedParameters: { instanceNetworkId: string; instanceX: number; instanceY: number; newObjectOwner: number; objectName: string; objectOwner: number; sceneNetworkId: string }) => { messageData: { instanceX: number; instanceY: number; newOwner: number; previousOwner: number; sceneNetworkId: string }; messageName: string }; createChangeVariableOwnerMessage: (__namedParameters: { newVariableOwner: number; variableNetworkId: string; variableOwner: number }) => { messageData: { newOwner: number; previousOwner: number }; messageName: string }; createDestroyInstanceMessage: (__namedParameters: { instanceNetworkId: string; objectName: string; objectOwner: number; sceneNetworkId: string }) => { messageData: any; messageName: string }; createInstanceDestroyedMessageNameFromDestroyInstanceMessage: (messageName: string) => string; createInstanceOwnerChangedMessageNameFromChangeInstanceOwnerMessage: (messageName: string) => string; createUpdateGameMessage: (__namedParameters: { gameNetworkSyncData: GameNetworkSyncData }) => { messageData: any; messageName: string }; createUpdateInstanceMessage: (__namedParameters: { instanceNetworkId: string; objectName: string; objectNetworkSyncData: ObjectNetworkSyncData; objectOwner: number; sceneNetworkId: string }) => { messageData: any; messageName: string }; createUpdateSceneMessage: (__namedParameters: { sceneNetworkSyncData: LayoutNetworkSyncData }) => { messageData: LayoutNetworkSyncData; messageName: string }; createVariableOwnerChangedMessageNameFromChangeVariableOwnerMessage: (messageName: string) => string; getCurrentPlayerPing: () => number; getCustomMessageData: (userMessageName: string) => any; getCustomMessageSender: (userMessageName: string) => number; getDisconnectedPlayers: () => number[]; getNumberOfConnectedPlayers: () => number; getPlayerPing: (playerNumber: number) => number; getVariableCustomMessageData: (userMessageName: string, variable: Variable) => void; handleAcknowledgeMessagesReceived: () => void; handleChangeInstanceOwnerMessagesReceived: (runtimeScene: RuntimeScene) => void; handleChangeVariableOwnerMessagesReceived: (runtimeScene: RuntimeScene) => void; handleCustomMessagesReceived: () => void; handleDestroyInstanceMessagesReceived: (runtimeScene: RuntimeScene) => void; handleDisconnectedPeers: (runtimeScene: RuntimeScene) => void; handleEndGameMessages: () => void; handleHeartbeatsReceived: () => void; handleHeartbeatsToSend: () => void; handleUpdateGameMessagesReceived: (runtimeScene: RuntimeScene) => void; handleUpdateGameMessagesToSend: (runtimeScene: RuntimeScene) => void; handleUpdateInstanceMessagesReceived: (runtimeScene: RuntimeScene) => void; handleUpdateSceneMessagesReceived: (runtimeScene: RuntimeScene) => void; handleUpdateSceneMessagesToSend: (runtimeScene: RuntimeScene) => void; hasAnyPlayerLeft: () => boolean; hasCustomMessageBeenReceived: (userMessageName: string) => undefined | false; hasPlayerLeft: (playerNumber: number) => boolean; isPlayerConnected: (playerNumber: number) => boolean; resendClearOrCancelAcknowledgedMessages: (runtimeScene: RuntimeScene) => void; sendCustomMessage: (userMessageName: string, userMessageData: any) => void; sendDataTo: (peerIds: string[], messageName: string, data: object) => void; sendEndGameMessage: () => void; sendVariableCustomMessage: (userMessageName: string, variable: Variable) => void; updatePlayersPingsForTests: (playersPings: any) => void }

      • addExpectedMessageAcknowledgement: (__namedParameters: { expectedMessageName: string; maxNumberOfRetries?: number; messageRetryTime?: number; originalData: any; originalMessageName: string; otherPeerIds: string[]; shouldCancelMessageIfTimesOut: boolean }) => void
          • (__namedParameters: { expectedMessageName: string; maxNumberOfRetries?: number; messageRetryTime?: number; originalData: any; originalMessageName: string; otherPeerIds: string[]; shouldCancelMessageIfTimesOut: boolean }): void

          • Parameters

            • __namedParameters: { expectedMessageName: string; maxNumberOfRetries?: number; messageRetryTime?: number; originalData: any; originalMessageName: string; otherPeerIds: string[]; shouldCancelMessageIfTimesOut: boolean }
              • expectedMessageName: string
              • Optional maxNumberOfRetries?: number
              • Optional messageRetryTime?: number
              • originalData: any
              • originalMessageName: string
              • otherPeerIds: string[]
              • shouldCancelMessageIfTimesOut: boolean

            Returns void

      • clearDisconnectedPeers: () => void
          • (): void

          • Returns void

      • clearExpectedMessageAcknowledgements: () => void
          • (): void

          • Returns void

      • createChangeInstanceOwnerMessage: (__namedParameters: { instanceNetworkId: string; instanceX: number; instanceY: number; newObjectOwner: number; objectName: string; objectOwner: number; sceneNetworkId: string }) => { messageData: { instanceX: number; instanceY: number; newOwner: number; previousOwner: number; sceneNetworkId: string }; messageName: string }
          • (__namedParameters: { instanceNetworkId: string; instanceX: number; instanceY: number; newObjectOwner: number; objectName: string; objectOwner: number; sceneNetworkId: string }): { messageData: { instanceX: number; instanceY: number; newOwner: number; previousOwner: number; sceneNetworkId: string }; messageName: string }

          • Parameters

            • __namedParameters: { instanceNetworkId: string; instanceX: number; instanceY: number; newObjectOwner: number; objectName: string; objectOwner: number; sceneNetworkId: string }
              • instanceNetworkId: string
              • instanceX: number
              • instanceY: number
              • newObjectOwner: number
              • objectName: string
              • objectOwner: number
              • sceneNetworkId: string

            Returns { messageData: { instanceX: number; instanceY: number; newOwner: number; previousOwner: number; sceneNetworkId: string }; messageName: string }

            • messageData: { instanceX: number; instanceY: number; newOwner: number; previousOwner: number; sceneNetworkId: string }
              • instanceX: number
              • instanceY: number
              • newOwner: number
              • previousOwner: number
              • sceneNetworkId: string
            • messageName: string
      • createChangeVariableOwnerMessage: (__namedParameters: { newVariableOwner: number; variableNetworkId: string; variableOwner: number }) => { messageData: { newOwner: number; previousOwner: number }; messageName: string }
          • (__namedParameters: { newVariableOwner: number; variableNetworkId: string; variableOwner: number }): { messageData: { newOwner: number; previousOwner: number }; messageName: string }

          • Parameters

            • __namedParameters: { newVariableOwner: number; variableNetworkId: string; variableOwner: number }
              • newVariableOwner: number
              • variableNetworkId: string
              • variableOwner: number

            Returns { messageData: { newOwner: number; previousOwner: number }; messageName: string }

            • messageData: { newOwner: number; previousOwner: number }
              • newOwner: number
              • previousOwner: number
            • messageName: string
      • createDestroyInstanceMessage: (__namedParameters: { instanceNetworkId: string; objectName: string; objectOwner: number; sceneNetworkId: string }) => { messageData: any; messageName: string }
          • (__namedParameters: { instanceNetworkId: string; objectName: string; objectOwner: number; sceneNetworkId: string }): { messageData: any; messageName: string }

          • Parameters

            • __namedParameters: { instanceNetworkId: string; objectName: string; objectOwner: number; sceneNetworkId: string }
              • instanceNetworkId: string
              • objectName: string
              • objectOwner: number
              • sceneNetworkId: string

            Returns { messageData: any; messageName: string }

            • messageData: any
            • messageName: string
      • createInstanceDestroyedMessageNameFromDestroyInstanceMessage: (messageName: string) => string
          • (messageName: string): string

          • Parameters

            • messageName: string

            Returns string

      • createInstanceOwnerChangedMessageNameFromChangeInstanceOwnerMessage: (messageName: string) => string
          • (messageName: string): string

          • Parameters

            • messageName: string

            Returns string

      • createUpdateGameMessage: (__namedParameters: { gameNetworkSyncData: GameNetworkSyncData }) => { messageData: any; messageName: string }
          • (__namedParameters: { gameNetworkSyncData: GameNetworkSyncData }): { messageData: any; messageName: string }

          • Parameters

            • __namedParameters: { gameNetworkSyncData: GameNetworkSyncData }
              • gameNetworkSyncData: GameNetworkSyncData

            Returns { messageData: any; messageName: string }

            • messageData: any
            • messageName: string
      • createUpdateInstanceMessage: (__namedParameters: { instanceNetworkId: string; objectName: string; objectNetworkSyncData: ObjectNetworkSyncData; objectOwner: number; sceneNetworkId: string }) => { messageData: any; messageName: string }
          • (__namedParameters: { instanceNetworkId: string; objectName: string; objectNetworkSyncData: ObjectNetworkSyncData; objectOwner: number; sceneNetworkId: string }): { messageData: any; messageName: string }

          • Parameters

            • __namedParameters: { instanceNetworkId: string; objectName: string; objectNetworkSyncData: ObjectNetworkSyncData; objectOwner: number; sceneNetworkId: string }
              • instanceNetworkId: string
              • objectName: string
              • objectNetworkSyncData: ObjectNetworkSyncData
              • objectOwner: number
              • sceneNetworkId: string

            Returns { messageData: any; messageName: string }

            • messageData: any
            • messageName: string
      • createUpdateSceneMessage: (__namedParameters: { sceneNetworkSyncData: LayoutNetworkSyncData }) => { messageData: LayoutNetworkSyncData; messageName: string }
          • (__namedParameters: { sceneNetworkSyncData: LayoutNetworkSyncData }): { messageData: LayoutNetworkSyncData; messageName: string }

          • Parameters

            • __namedParameters: { sceneNetworkSyncData: LayoutNetworkSyncData }
              • sceneNetworkSyncData: LayoutNetworkSyncData

            Returns { messageData: LayoutNetworkSyncData; messageName: string }

            • messageData: LayoutNetworkSyncData
            • messageName: string
      • createVariableOwnerChangedMessageNameFromChangeVariableOwnerMessage: (messageName: string) => string
          • (messageName: string): string

          • Parameters

            • messageName: string

            Returns string

      • getCurrentPlayerPing: () => number
          • (): number

          • Returns number

      • getCustomMessageData: (userMessageName: string) => any
          • (userMessageName: string): any

          • Parameters

            • userMessageName: string

            Returns any

      • getCustomMessageSender: (userMessageName: string) => number
          • (userMessageName: string): number

          • Parameters

            • userMessageName: string

            Returns number

      • getDisconnectedPlayers: () => number[]
          • (): number[]

          • Returns number[]

      • getNumberOfConnectedPlayers: () => number
          • (): number

          • Returns number

      • getPlayerPing: (playerNumber: number) => number
          • (playerNumber: number): number

          • Parameters

            • playerNumber: number

            Returns number

      • getVariableCustomMessageData: (userMessageName: string, variable: Variable) => void
          • (userMessageName: string, variable: Variable): void

          • Parameters

            • userMessageName: string
            • variable: Variable

            Returns void

      • handleAcknowledgeMessagesReceived: () => void
          • (): void

          • Returns void

      • handleChangeInstanceOwnerMessagesReceived: (runtimeScene: RuntimeScene) => void
      • handleChangeVariableOwnerMessagesReceived: (runtimeScene: RuntimeScene) => void
      • handleCustomMessagesReceived: () => void
          • (): void

          • Returns void

      • handleDestroyInstanceMessagesReceived: (runtimeScene: RuntimeScene) => void
      • handleDisconnectedPeers: (runtimeScene: RuntimeScene) => void
      • handleEndGameMessages: () => void
          • (): void

          • Returns void

      • handleHeartbeatsReceived: () => void
          • (): void

          • Returns void

      • handleHeartbeatsToSend: () => void
          • (): void

          • Returns void

      • handleUpdateGameMessagesReceived: (runtimeScene: RuntimeScene) => void
      • handleUpdateGameMessagesToSend: (runtimeScene: RuntimeScene) => void
      • handleUpdateInstanceMessagesReceived: (runtimeScene: RuntimeScene) => void
      • handleUpdateSceneMessagesReceived: (runtimeScene: RuntimeScene) => void
      • handleUpdateSceneMessagesToSend: (runtimeScene: RuntimeScene) => void
      • hasAnyPlayerLeft: () => boolean
          • (): boolean

          • Returns boolean

      • hasCustomMessageBeenReceived: (userMessageName: string) => undefined | false
          • (userMessageName: string): undefined | false

          • Parameters

            • userMessageName: string

            Returns undefined | false

      • hasPlayerLeft: (playerNumber: number) => boolean
          • (playerNumber: number): boolean

          • Parameters

            • playerNumber: number

            Returns boolean

      • isPlayerConnected: (playerNumber: number) => boolean
          • (playerNumber: number): boolean

          • Parameters

            • playerNumber: number

            Returns boolean

      • resendClearOrCancelAcknowledgedMessages: (runtimeScene: RuntimeScene) => void
      • sendCustomMessage: (userMessageName: string, userMessageData: any) => void
          • (userMessageName: string, userMessageData: any): void

          • Parameters

            • userMessageName: string
            • userMessageData: any

            Returns void

      • sendDataTo: (peerIds: string[], messageName: string, data: object) => void
          • (peerIds: string[], messageName: string, data: object): void

          • Main function to send messages to other players, via P2P. Takes into account the simulation of network latency and packet loss.

            -

            Parameters

            • peerIds: string[]
            • messageName: string
            • data: object

            Returns void

      • sendEndGameMessage: () => void
          • (): void

          • Returns void

      • sendVariableCustomMessage: (userMessageName: string, variable: Variable) => void
          • (userMessageName: string, variable: Variable): void

          • Parameters

            • userMessageName: string
            • variable: Variable

            Returns void

      • updatePlayersPingsForTests: (playersPings: any) => void
          • (playersPings: any): void

          • Parameters

            • playersPings: any

            Returns void

    Const makeMultiplayerVariablesManager

    • makeMultiplayerVariablesManager(): { disableVariableSynchronization: (runtimeScene: RuntimeScene, variable: Variable) => void; getPlayerVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable) => null | number; getVariableTypeAndNameFromNetworkId: (variableNetworkId: string) => { containerId: string; name: string; type: string }; handleChangeVariableOwnerMessagesToSend: () => void; removeVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable) => void; setPlayerVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable, newVariablePlayerNumber: number) => void; takeVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable) => void }

    Const nearlyEqual

    • nearlyEqual(a: number, b: number, epsilon: number): boolean
  • sendEndGameMessage: () => void
      • (): void

      • Returns void

  • sendVariableCustomMessage: (userMessageName: string, variable: Variable) => void
      • (userMessageName: string, variable: Variable): void

      • Parameters

        • userMessageName: string
        • variable: Variable

        Returns void

  • updatePlayersPingsForTests: (playersPings: any) => void
      • (playersPings: any): void

      • Parameters

        • playersPings: any

        Returns void

    • Const makeMultiplayerVariablesManager

    • makeMultiplayerVariablesManager(): { disableVariableSynchronization: (runtimeScene: RuntimeScene, variable: Variable) => void; getPlayerVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable) => null | number; getVariableTypeAndNameFromNetworkId: (variableNetworkId: string) => { containerId: string; name: string; type: string }; handleChangeVariableOwnerMessagesToSend: () => void; removeVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable) => void; setPlayerVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable, newVariablePlayerNumber: number) => void; takeVariableOwnership: (runtimeScene: RuntimeScene, variable: Variable) => void }

    Const nearlyEqual

    • nearlyEqual(a: number, b: number, epsilon: number): boolean

    Const objectsListsToArray

    Const objectsListsToArray

    Const random

    • random(max: number): number

    Const random

    • random(max: number): number

    • Get a random integer between 0 and max.

      Parameters

      • max: number

        The maximum value (inclusive).

        -

      Returns number

    Const randomFloat

    • randomFloat(max: number): number

    Returns number

    Const randomFloat

    • randomFloat(max: number): number

    • Get a random float in the range 0 to less than max (inclusive of 0, but not max).

      Parameters

      • max: number

        The maximum value (exclusive).

        -

      Returns number

    Const randomFloatInRange

    • randomFloatInRange(min: number, max: number): number

    Returns number

    Const randomFloatInRange

    • randomFloatInRange(min: number, max: number): number

    • Get a random float between min and max

      Parameters

      • min: number

        The minimum value (inclusive).

      • max: number

        The maximum value (exclusive).

        -

      Returns number

    Const randomInRange

    • randomInRange(min: number, max: number): number

    Returns number

    Const randomInRange

    • randomInRange(min: number, max: number): number

    • Get a random integer between min and max.

      Parameters

      • min: number

        The minimum value (inclusive).

      • max: number

        The maximum value (inclusive).

        -

      Returns number

    Const randomWithStep

    • randomWithStep(min: number, max: number, step: number): number

    Returns number

    Const randomWithStep

    • randomWithStep(min: number, max: number, step: number): number

    • Get a random number between min and max in steps

      Parameters

      • min: number

        The minimum value (inclusive).

        @@ -337,11 +337,11 @@

        The maximum value (inclusive).

      • step: number

        The interval between each value.

        -

      Returns number

    Const registerAsynchronouslyLoadingLibraryPromise

    • registerAsynchronouslyLoadingLibraryPromise(promise: Promise<any>): void

    Returns number

    Const registerAsynchronouslyLoadingLibraryPromise

    • registerAsynchronouslyLoadingLibraryPromise(promise: Promise<any>): void

    • Register a promise which will be resolved when a third party library has finished loading (and is required to load before launching the game).

      This method must be called by any library that loads asynchronously.

      -

      Parameters

      • promise: Promise<any>

      Returns void

    Const registerBehavior

    • registerBehavior(behaviorTypeName: string, Ctor: typeof RuntimeBehavior): void

    Const registerBehavior

    • registerBehavior(behaviorTypeName: string, Ctor: typeof RuntimeBehavior): void

    Returns void

    Const registerFirstRuntimeSceneLoadedCallback

    • registerFirstRuntimeSceneLoadedCallback(callback: RuntimeSceneCallback): void

    Returns void

    Const registerFirstRuntimeSceneLoadedCallback

    • registerFirstRuntimeSceneLoadedCallback(callback: RuntimeSceneCallback): void

    • Register a function to be called when the first gdjs.RuntimeScene is loaded, after resources loading is done. This can be considered as the "start of the game".

      Parameters

      • callback: RuntimeSceneCallback

        The function to be called.

        -

      Returns void

    Const registerObject

    • registerObject(objectTypeName: string, Ctor: typeof RuntimeObject): void

    Returns void

    Const registerObject

    • registerObject(objectTypeName: string, Ctor: typeof RuntimeObject): void

    • Register a runtime object (class extending gdjs.RuntimeObject) that can be used in a scene.

      The name of the type of the object must be complete, with the namespace if any. For example, if you are providing a Text object in the TextObject extension, the full name @@ -365,54 +365,54 @@

      The name of the type of the Object.

    • Ctor: typeof RuntimeObject

      The constructor of the Object.

      -

    Returns void

    Const registerObjectDeletedFromSceneCallback

    • registerObjectDeletedFromSceneCallback(callback: RuntimeSceneRuntimeObjectCallback): void

    Returns void

    Const registerObjectDeletedFromSceneCallback

    • registerObjectDeletedFromSceneCallback(callback: RuntimeSceneRuntimeObjectCallback): void

    • Register a function to be called when an object is deleted from a scene.

      Parameters

      • callback: RuntimeSceneRuntimeObjectCallback

        The function to be called.

        -

      Returns void

    Const registerRuntimeSceneLoadedCallback

    • registerRuntimeSceneLoadedCallback(callback: RuntimeSceneCallback): void

    Returns void

    Const registerRuntimeSceneLoadedCallback

    • registerRuntimeSceneLoadedCallback(callback: RuntimeSceneCallback): void

    • Register a function to be called when a scene is loaded.

      Parameters

      • callback: RuntimeSceneCallback

        The function to be called.

        -

      Returns void

    Const registerRuntimeScenePausedCallback

    • registerRuntimeScenePausedCallback(callback: RuntimeSceneCallback): void

    Returns void

    Const registerRuntimeScenePausedCallback

    • registerRuntimeScenePausedCallback(callback: RuntimeSceneCallback): void

    • Register a function to be called when a scene is paused.

      Parameters

      • callback: RuntimeSceneCallback

        The function to be called.

        -

      Returns void

    Const registerRuntimeScenePostEventsCallback

    • registerRuntimeScenePostEventsCallback(callback: RuntimeSceneCallback): void

    Returns void

    Const registerRuntimeScenePostEventsCallback

    • registerRuntimeScenePostEventsCallback(callback: RuntimeSceneCallback): void

    • Register a function to be called each time a scene is stepped (i.e: at every frame), after events are run and before rendering.

      Parameters

      • callback: RuntimeSceneCallback

        The function to be called.

        -

      Returns void

    Const registerRuntimeScenePreEventsCallback

    • registerRuntimeScenePreEventsCallback(callback: RuntimeSceneCallback): void

    Returns void

    Const registerRuntimeScenePreEventsCallback

    • registerRuntimeScenePreEventsCallback(callback: RuntimeSceneCallback): void

    • Register a function to be called each time a scene is stepped (i.e: at every frame), before events are run.

      Parameters

      • callback: RuntimeSceneCallback

        The function to be called.

        -

      Returns void

    Const registerRuntimeSceneResumedCallback

    • registerRuntimeSceneResumedCallback(callback: RuntimeSceneCallback): void

    Returns void

    Const registerRuntimeSceneResumedCallback

    • registerRuntimeSceneResumedCallback(callback: RuntimeSceneCallback): void

    • Register a function to be called when a scene is resumed.

      Parameters

      • callback: RuntimeSceneCallback

        The function to be called.

        -

      Returns void

    Const registerRuntimeSceneUnloadedCallback

    • registerRuntimeSceneUnloadedCallback(callback: RuntimeSceneCallback): void

    Returns void

    Const registerRuntimeSceneUnloadedCallback

    • registerRuntimeSceneUnloadedCallback(callback: RuntimeSceneCallback): void

    • Register a function to be called when a scene is unloaded. The objects and renderer are now destroyed - it is not safe to do anything apart from releasing resources.

      Parameters

      • callback: RuntimeSceneCallback

        The function to be called.

        -

      Returns void

    Const registerRuntimeSceneUnloadingCallback

    • registerRuntimeSceneUnloadingCallback(callback: RuntimeSceneCallback): void

    Returns void

    Const registerRuntimeSceneUnloadingCallback

    • registerRuntimeSceneUnloadingCallback(callback: RuntimeSceneCallback): void

    • Register a function to be called when a scene unload started. This is before the object deletion and renderer destruction. It is safe to manipulate these. It is not be safe to release resources as other callbacks might do operations on objects or the scene.

      Parameters

      • callback: RuntimeSceneCallback

        The function to be called.

        -

      Returns void

    Const rgbOrHexStringToNumber

    • rgbOrHexStringToNumber(rgbOrHexString: string): number

    Returns void

    Const rgbOrHexStringToNumber

    • rgbOrHexStringToNumber(rgbOrHexString: string): number

    • Convert a RGB string ("rrr;ggg;bbb") or a Hex string ("#rrggbb") to a RGB color number.

      Parameters

      • rgbOrHexString: string

        The color as a RGB string or Hex string

        -

      Returns number

    Const rgbOrHexToRGBColor

    • rgbOrHexToRGBColor(value: string): [number, number, number]

    Returns number

    Const rgbOrHexToRGBColor

    • rgbOrHexToRGBColor(value: string): [number, number, number]

    • Convert a RGB string ("rrr;ggg;bbb") or a Hex string ("#rrggbb") to a RGB color array ([r,g,b] with each component going from 0 to 255).

      Parameters

      • value: string

        The color as a RGB string or Hex string

        -

      Returns [number, number, number]

    Const rgbToHex

    • rgbToHex(r: number, g: number, b: number): string

    Returns [number, number, number]

    Const rgbToHex

    • rgbToHex(r: number, g: number, b: number): string

    • Convert a RGB object to a Hex string.

      No "#" or "0x" are added.

      Parameters

      • r: number
        @@ -421,7 +421,7 @@

        Green

      • b: number

        Blue

        -

      Returns string

    Const rgbToHexNumber

    • rgbToHexNumber(r: number, g: number, b: number): number

    Returns string

    Const rgbToHexNumber

    • rgbToHexNumber(r: number, g: number, b: number): number

    • Convert a RGB object to a Hex number.

      Parameters

      • r: number

        Red

        @@ -429,27 +429,27 @@

        Green

      • b: number

        Blue

        -

      Returns number

    Const staticArray

    • staticArray(owner: any): any[]

    Returns number

    Const staticArray

    • staticArray(owner: any): any[]

    • Create a static array that won't need a new allocation each time it's used.

      Parameters

      • owner: any

        The owner of the Array.

        -

      Returns any[]

    Const staticArray2

    • staticArray2(owner: any): any[]

    Returns any[]

    Const staticArray2

    • staticArray2(owner: any): any[]

    • Create a second static array that won't need a new allocation each time it's used.

      Parameters

      • owner: any

        The owner of the Array.

        -

      Returns any[]

    Const staticObject

    • staticObject(owner: any): Object

    Returns any[]

    Const staticObject

    • staticObject(owner: any): Object

    • Create a static object that won't need a new allocation each time it's used.

      Parameters

      • owner: any

        The owner of the Array.

        -

      Returns Object

    Const toDegrees

    • toDegrees(angleInRadians: number): number

    Returns Object

    Const toDegrees

    • toDegrees(angleInRadians: number): number

    • Convert an angle in radians to degrees.

      Parameters

      • angleInRadians: number

        The angle in radians.

        -

      Returns number

    Const toRad

    • toRad(angleInDegrees: number): number

    Returns number

    Const toRad

    • toRad(angleInDegrees: number): number

    • Convert an angle in degrees to radians.

      Parameters

      • angleInDegrees: number

        The angle in degrees.

        -

      Returns number

    Const Private registerGlobalCallbacks

    • registerGlobalCallbacks(): void

    Returns number

    Const Private registerGlobalCallbacks

    • registerGlobalCallbacks(): void

    • Keep this function until we're sure now client is using it anymore.

      deprecated

      Returns void

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace multiplayer

    Index

    Variables

    Functions

    Variables

    disableMultiplayerForTesting

    disableMultiplayerForTesting: boolean = false
    +multiplayer | GDevelop JavaScript game engine
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace multiplayer

    Index

    Variables

    Functions

    Variables

    disableMultiplayerForTesting

    disableMultiplayerForTesting: boolean = false

    Set to true in testing to avoid relying on the multiplayer extension.

    -

    playerNumber

    playerNumber: number | null = null

    Functions

    Const endLobbyGame

    • endLobbyGame(): Promise<void>

    playerNumber

    playerNumber: number | null = null

    Functions

    Const endLobbyGame

    • endLobbyGame(): Promise<void>

    Const getCurrentPlayerNumber

    • getCurrentPlayerNumber(): number

    Const getCurrentPlayerNumber

    • getCurrentPlayerNumber(): number

    Const getCurrentPlayerUsername

    • getCurrentPlayerUsername(): undefined | string

    Const getCurrentPlayerUsername

    • getCurrentPlayerUsername(): undefined | string

    Const getPlayerUsername

    • getPlayerUsername(playerNumber: number): undefined | string

    Const getPlayerUsername

    • getPlayerUsername(playerNumber: number): undefined | string

    • Returns the player username at the given number in the lobby. The number is shifted by one, so that the first player has number 1.

      -

      Parameters

      • playerNumber: number

      Returns undefined | string

    Const getPlayersInLobbyCount

    • getPlayersInLobbyCount(): number

    Const getPlayersInLobbyCount

    • getPlayersInLobbyCount(): number

    Const handleLobbyGameEnded

    • handleLobbyGameEnded(): void

    Const handleLobbyGameEnded

    • handleLobbyGameEnded(): void

    Const hasLobbyGameJustEnded

    • hasLobbyGameJustEnded(): boolean

    Const hasLobbyGameJustEnded

    • hasLobbyGameJustEnded(): boolean

    Const hasLobbyGameJustStarted

    • hasLobbyGameJustStarted(): boolean

    Const hasLobbyGameJustStarted

    • hasLobbyGameJustStarted(): boolean

    Const isLobbiesWindowOpen

    Const isLobbiesWindowOpen

    Const isLobbyGameRunning

    • isLobbyGameRunning(): boolean

    Const isPlayerHost

    • isPlayerHost(): boolean

    Const isLobbyGameRunning

    • isLobbyGameRunning(): boolean

    Const isPlayerHost

    • isPlayerHost(): boolean

    Const leaveGameLobby

    Const leaveGameLobby

    Const openLobbiesWindow

    • openLobbiesWindow(runtimeScene: RuntimeScene): Promise<void>

    Const openLobbiesWindow

    • openLobbiesWindow(runtimeScene: RuntimeScene): Promise<void>

    Const removeLobbiesContainer

    Const removeLobbiesContainer

    Const showLobbiesCloseButton

    • showLobbiesCloseButton(runtimeScene: RuntimeScene, visible: boolean): void

    Settings

    Theme

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace multiplayerComponents

    Index

    Functions

    Functions

    Const addReloadUrlToTextsContainer

    • addReloadUrlToTextsContainer(onClick: () => void, textContainer: HTMLDivElement): void

    Const getAllMessagesMap

    Const getAllPeers

    • getAllPeers(): string[]

    Const getCurrentId

    • getCurrentId(): string

    Const getCurrentId

    • getCurrentId(): string

    Const getJustDisconnectedPeers

    • getJustDisconnectedPeers(): string[]

    Const getJustDisconnectedPeers

    • getJustDisconnectedPeers(): string[]

    Const getOrCreateMessagesList

    Const getOrCreateMessagesList

    Const isReady

    • isReady(): boolean

    Const isReady

    • isReady(): boolean

    Const sendDataTo

    • sendDataTo(ids: string[], messageName: string, messageData: object): Promise<void>

    Const sendDataTo

    • sendDataTo(ids: string[], messageName: string, messageData: object): Promise<void>

    • Send a message to a specific peer.

      Parameters

      • ids: string[]

        The IDs of the clients to send the event to.

      • messageName: string

        The event to trigger.

        -
      • messageData: object

      Returns Promise<void>

    Const setCompressionMethod

    Const useCustomBrokerServer

    • useCustomBrokerServer(host: string, port: number, path: string, key: string, ssl: boolean): void

    Returns Promise<void>

    Const setCompressionMethod

    Const useCustomBrokerServer

    • useCustomBrokerServer(host: string, port: number, path: string, key: string, ssl: boolean): void

    • Connects to a custom broker server.

      Parameters

      • host: string

        The host of the broker server.

        @@ -38,7 +38,7 @@

        Optional password to connect to the broker server.

      • ssl: boolean

        Use ssl?

        -

      Returns void

    Const useCustomICECandidate

    • useCustomICECandidate(urls: string, username?: string, credential?: string): void

    Returns void

    Const useCustomICECandidate

    • useCustomICECandidate(urls: string, username?: string, credential?: string): void

    • Adds an ICE server candidate, and removes the default ones provided by PeerJs. Must be called before connecting to a broker.

      Parameters

      • urls: string

        The URL of the STUN/TURN server.

        @@ -46,7 +46,7 @@

        An optional username to send to the server.

      • Optional credential: string

        An optional password to send to the server.

        -

      Returns void

    Const useDefaultBrokerServer

    • useDefaultBrokerServer(): void

    Settings

    Theme

    Generated using TypeDoc

    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Namespace pathfinding

    Index

    Functions

    Functions

    Const getPointSegmentDistanceSq

    • getPointSegmentDistanceSq(px: number, py: number, ax: number, ay: number, bx: number, by: number): number

    Const simplifyPath

    • simplifyPath(sourceVertices: FloatPoint[], maxGap: number, simplifiedVertices?: FloatPoint[], workingVertices?: FloatPoint[]): FloatPoint[]

    Const simplifyPath

    • simplifyPath(sourceVertices: FloatPoint[], maxGap: number, simplifiedVertices?: FloatPoint[], workingVertices?: FloatPoint[]): FloatPoint[]