Interface ContainerConfiguration

interface ContainerConfiguration {
    active: boolean;
    alpha: number;
    angle: number;
    blendMode: string | number | BlendModes;
    children?: GameObject[];
    depth: number;
    displayHeight: number;
    displayWidth: number;
    hasTransformComponent: boolean;
    height: number;
    mask: GeometryMask;
    rotation: number;
    scale: number;
    scaleX: number;
    scaleY: number;
    scrollFactor: number;
    scrollFactorX: number;
    scrollFactorY: number;
    tween: {
        callbackScope?: any;
        completeDelay?: string | number | object | Function | any[];
        delay?: number | Function;
        duration?: number;
        ease?: string | Function;
        easeParams?: any[];
        flipX?: boolean;
        flipY?: boolean;
        hold?: number;
        interpolation?: string | Function;
        loop?: string | number | object | Function | any[];
        loopDelay?: string | number | object | Function | any[];
        onActive?: TweenOnActiveCallback;
        onActiveParams?: any[];
        onComplete?: TweenOnCompleteCallback;
        onCompleteParams?: any[];
        onLoop?: TweenOnLoopCallback;
        onLoopParams?: any[];
        onPause?: TweenOnPauseCallback;
        onPauseParams?: any[];
        onRepeat?: TweenOnRepeatCallback;
        onRepeatParams?: any[];
        onResume?: TweenOnResumeCallback;
        onResumeParams?: any[];
        onStart?: TweenOnStartCallback;
        onStartParams?: any[];
        onStop?: TweenOnStopCallback;
        onStopParams?: any[];
        onUpdate?: TweenOnUpdateCallback;
        onUpdateParams?: any[];
        onYoyo?: TweenOnYoyoCallback;
        onYoyoParams?: any[];
        paused?: boolean;
        persist?: boolean;
        props?: {
            [key: string]: string | number | GetEndCallback | TweenPropConfig;
        };
        repeat?: number;
        repeatDelay?: number;
        yoyo?: boolean;
        [key: string]: any;
    };
    tweenchain: {
        callbackScope?: any;
        completeDelay?: string
        | number
        | object
        | Function
        | any[];
        delay?: number | Function;
        duration?: number;
        ease?: string | Function;
        easeParams?: any[];
        flipX?: boolean;
        flipY?: boolean;
        hold?: number;
        interpolation?: string | Function;
        loop?: string | number | object | Function | any[];
        loopDelay?: string | number | object | Function | any[];
        onActive?: TweenOnActiveCallback;
        onActiveParams?: any[];
        onComplete?: TweenOnCompleteCallback;
        onCompleteParams?: any[];
        onLoop?: TweenOnLoopCallback;
        onLoopParams?: any[];
        onPause?: TweenOnPauseCallback;
        onPauseParams?: any[];
        onRepeat?: TweenOnRepeatCallback;
        onRepeatParams?: any[];
        onResume?: TweenOnResumeCallback;
        onResumeParams?: any[];
        onStart?: TweenOnStartCallback;
        onStartParams?: any[];
        onStop?: TweenOnStopCallback;
        onStopParams?: any[];
        onUpdate?: TweenOnUpdateCallback;
        onUpdateParams?: any[];
        onYoyo?: TweenOnYoyoCallback;
        onYoyoParams?: any[];
        paused?: boolean;
        persist?: boolean;
        props?: {
            [key: string]: string | number | GetEndCallback | TweenPropConfig;
        };
        repeat?: number;
        repeatDelay?: number;
        yoyo?: boolean;
        [key: string]: any;
    }[];
    visible: boolean;
    w: number;
    width: number;
    x: number;
    y: number;
    z: number;
}

Hierarchy (View Summary)

AlphaSingleConfiguration
BlendModeConfiguration
ComputedSizeConfiguration
DepthConfiguration
Except<
Types.GameObjects.Container.ContainerConfig,
keyof Types.GameObjects.GameObjectConfig,
>
GlobalConfiguration
MaskConfiguration
ScrollFactorConfiguration
TransformConfiguration
VisibleConfiguration
- ContainerConfiguration

Properties

active

active: boolean

The active state of this Game Object. A Game Object with an active state of true is processed by the Scenes UpdateList, if added to it. An active object is one which is having its logic and internal systems updated.

alpha

alpha: number

The alpha value of the Game Object.

This is a global value, impacting the entire Game Object, not just a region of it.

angle

angle: number

The angle of this Game Object as expressed in degrees.

Phaser uses a right-hand clockwise rotation system, where 0 is right, 90 is down, 180/-180 is left and -90 is up.

If you prefer to work in radians, see the rotation property instead.

blendMode

blendMode: string | number | BlendModes

Sets the Blend Mode being used by this Game Object.

This can be a const, such as Phaser.BlendModes.SCREEN, or an integer, such as 4 (for Overlay)

Under WebGL only the following Blend Modes are available:

NORMAL
ADD
MULTIPLY
SCREEN
ERASE

Canvas has more available depending on browser support.

You can also create your own custom Blend Modes in WebGL.

Blend modes have different effects under Canvas and WebGL, and from browser to browser, depending on support. Blend Modes also cause a WebGL batch flush should it encounter a new blend mode. For these reasons try to be careful about the construction of your Scene and the frequency of which blend modes are used.

`Optional`children

children?: GameObject[]

An optional array of Game Objects to add to the Container.

depth

depth: number

The depth of this Game Object within the Scene. Ensure this value is only ever set to a number data-type.

The depth is also known as the 'z-index' in some environments, and allows you to change the rendering order of Game Objects, without actually moving their position in the display list.

The default depth is zero. A Game Object with a higher depth value will always render in front of one with a lower value.

Setting the depth will queue a depth sort event within the Scene.

displayHeight

displayHeight: number

The displayed height of this Game Object.

This value takes into account the scale factor.

Setting this value will adjust the Game Object's scale property.

displayWidth

displayWidth: number

The displayed width of this Game Object.

This value takes into account the scale factor.

Setting this value will adjust the Game Object's scale property.

`Readonly`hasTransformComponent

hasTransformComponent: boolean

A property indicating that a Game Object has this component.

height

height: number

The native (un-scaled) height of this Game Object.

Changing this value will not change the size that the Game Object is rendered in-game. For that you need to either set the scale of the Game Object (setScale) or use the displayHeight property.

mask

mask: GeometryMask

The Mask this Game Object is using during render.

rotation

rotation: number

The angle of this Game Object in radians.

Phaser uses a right-hand clockwise rotation system, where 0 is right, PI/2 is down, +-PI is left and -PI/2 is up.

If you prefer to work in degrees, see the angle property instead.

scale

scale: number

This is a special setter that allows you to set both the horizontal and vertical scale of this Game Object to the same value, at the same time. When reading this value the result returned is (scaleX + scaleY) / 2.

Use of this property implies you wish the horizontal and vertical scales to be equal to each other. If this isn't the case, use the scaleX or scaleY properties instead.

scaleX

scaleX: number

The horizontal scale of this Game Object.

scaleY

scaleY: number

The vertical scale of this Game Object.

scrollFactor

scrollFactor: number

scrollFactorX

scrollFactorX: number

The horizontal scroll factor of this Game Object.

The scroll factor controls the influence of the movement of a Camera upon this Game Object.

When a camera scrolls it will change the location at which this Game Object is rendered on-screen. It does not change the Game Objects actual position values.

A value of 1 means it will move exactly in sync with a camera. A value of 0 means it will not move at all, even if the camera moves. Other values control the degree to which the camera movement is mapped to this Game Object.

Please be aware that scroll factor values other than 1 are not taken in to consideration when calculating physics collisions. Bodies always collide based on their world position, but changing the scroll factor is a visual adjustment to where the textures are rendered, which can offset them from physics bodies if not accounted for in your code.

scrollFactorY

scrollFactorY: number

The vertical scroll factor of this Game Object.

The scroll factor controls the influence of the movement of a Camera upon this Game Object.

When a camera scrolls it will change the location at which this Game Object is rendered on-screen. It does not change the Game Objects actual position values.

tween

tween: {
    callbackScope?: any;
    completeDelay?: string | number | object | Function | any[];
    delay?: number | Function;
    duration?: number;
    ease?: string | Function;
    easeParams?: any[];
    flipX?: boolean;
    flipY?: boolean;
    hold?: number;
    interpolation?: string | Function;
    loop?: string | number | object | Function | any[];
    loopDelay?: string | number | object | Function | any[];
    onActive?: TweenOnActiveCallback;
    onActiveParams?: any[];
    onComplete?: TweenOnCompleteCallback;
    onCompleteParams?: any[];
    onLoop?: TweenOnLoopCallback;
    onLoopParams?: any[];
    onPause?: TweenOnPauseCallback;
    onPauseParams?: any[];
    onRepeat?: TweenOnRepeatCallback;
    onRepeatParams?: any[];
    onResume?: TweenOnResumeCallback;
    onResumeParams?: any[];
    onStart?: TweenOnStartCallback;
    onStartParams?: any[];
    onStop?: TweenOnStopCallback;
    onStopParams?: any[];
    onUpdate?: TweenOnUpdateCallback;
    onUpdateParams?: any[];
    onYoyo?: TweenOnYoyoCallback;
    onYoyoParams?: any[];
    paused?: boolean;
    persist?: boolean;
    props?: {
        [key: string]: string | number | GetEndCallback | TweenPropConfig;
    };
    repeat?: number;
    repeatDelay?: number;
    yoyo?: boolean;
    [key: string]: any;
}

Type Declaration

[key: string]: any
OptionalcallbackScope?: any
The scope (or context) for all of the callbacks. The default scope is the tween.
OptionalcompleteDelay?: string | number | object | Function | any[]
The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.
Optionaldelay?: number | Function
The number of milliseconds to delay before the tween will start.
Optionalduration?: number
The duration of the tween in milliseconds.
Optionalease?: string | Function
The easing equation to use for the tween.
OptionaleaseParams?: any[]
Optional easing parameters.
OptionalflipX?: boolean
Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the flipX property.
OptionalflipY?: boolean
Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the flipY property.
Optionalhold?: number
The number of milliseconds to hold the tween for before yoyo'ing.
Optionalinterpolation?: string | Function
The interpolation function to use if the value given is an array of numbers.
Optionalloop?: string | number | object | Function | any[]
The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property in the tween has completed once.
OptionalloopDelay?: string | number | object | Function | any[]
The time the tween will pause before starting either a yoyo or returning to the start for a repeat.
OptionalonActive?: TweenOnActiveCallback
A function to call when the tween becomes active within the Tween Manager.
OptionalonActiveParams?: any[]
Additional parameters to pass to onActive.
OptionalonComplete?: TweenOnCompleteCallback
A function to call when the tween completes.
OptionalonCompleteParams?: any[]
Additional parameters to pass to onComplete.
OptionalonLoop?: TweenOnLoopCallback
A function to call each time the tween loops.
OptionalonLoopParams?: any[]
Additional parameters to pass to onLoop.
OptionalonPause?: TweenOnPauseCallback
A function to call when the tween is paused.
OptionalonPauseParams?: any[]
Additional parameters to pass to onPause.
OptionalonRepeat?: TweenOnRepeatCallback
A function to call each time a property tween repeats. Called once per property per target.
OptionalonRepeatParams?: any[]
Additional parameters to pass to onRepeat.
OptionalonResume?: TweenOnResumeCallback
A function to call when the tween is resumed after being paused.
OptionalonResumeParams?: any[]
Additional parameters to pass to onResume.
OptionalonStart?: TweenOnStartCallback
A function to call when the tween starts playback, after any delays have expired.
OptionalonStartParams?: any[]
Additional parameters to pass to onStart.
OptionalonStop?: TweenOnStopCallback
A function to call when the tween is stopped.
OptionalonStopParams?: any[]
Additional parameters to pass to onStop.
OptionalonUpdate?: TweenOnUpdateCallback
A function to call each time the tween steps. Called once per property per target.
OptionalonUpdateParams?: any[]
Additional parameters to pass to onUpdate.
OptionalonYoyo?: TweenOnYoyoCallback
A function to call each time a property tween yoyos. Called once per property per target.
OptionalonYoyoParams?: any[]
Additional parameters to pass to onYoyo.
Optionalpaused?: boolean
Does the tween start in a paused state (true) or playing (false)?
Optionalpersist?: boolean
Will the Tween be automatically destroyed on completion, or retained for future playback?
Optionalprops?: { [key: string]: string | number | GetEndCallback | TweenPropConfig }
The properties to tween.
Optionalrepeat?: number
The number of times each property tween repeats.
OptionalrepeatDelay?: number
The number of milliseconds to pause before a repeat.
Optionalyoyo?: boolean
Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take duration milliseconds to complete.

tweenchain

tweenchain: {
    callbackScope?: any;
    completeDelay?: string | number | object | Function | any[];
    delay?: number | Function;
    duration?: number;
    ease?: string | Function;
    easeParams?: any[];
    flipX?: boolean;
    flipY?: boolean;
    hold?: number;
    interpolation?: string | Function;
    loop?: string | number | object | Function | any[];
    loopDelay?: string | number | object | Function | any[];
    onActive?: TweenOnActiveCallback;
    onActiveParams?: any[];
    onComplete?: TweenOnCompleteCallback;
    onCompleteParams?: any[];
    onLoop?: TweenOnLoopCallback;
    onLoopParams?: any[];
    onPause?: TweenOnPauseCallback;
    onPauseParams?: any[];
    onRepeat?: TweenOnRepeatCallback;
    onRepeatParams?: any[];
    onResume?: TweenOnResumeCallback;
    onResumeParams?: any[];
    onStart?: TweenOnStartCallback;
    onStartParams?: any[];
    onStop?: TweenOnStopCallback;
    onStopParams?: any[];
    onUpdate?: TweenOnUpdateCallback;
    onUpdateParams?: any[];
    onYoyo?: TweenOnYoyoCallback;
    onYoyoParams?: any[];
    paused?: boolean;
    persist?: boolean;
    props?: {
        [key: string]: string | number | GetEndCallback | TweenPropConfig;
    };
    repeat?: number;
    repeatDelay?: number;
    yoyo?: boolean;
    [key: string]: any;
}[]

Type Declaration

[key: string]: any
OptionalcallbackScope?: any
The scope (or context) for all of the callbacks. The default scope is the tween.
OptionalcompleteDelay?: string | number | object | Function | any[]
The time the tween will wait before the onComplete event is dispatched once it has completed, in ms.
Optionaldelay?: number | Function
The number of milliseconds to delay before the tween will start.
Optionalduration?: number
The duration of the tween in milliseconds.
Optionalease?: string | Function
The easing equation to use for the tween.
OptionaleaseParams?: any[]
Optional easing parameters.
OptionalflipX?: boolean
Horizontally flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the flipX property.
OptionalflipY?: boolean
Vertically flip the target of the Tween when it completes (before it yoyos, if set to do so). Only works for targets that support the flipY property.
Optionalhold?: number
The number of milliseconds to hold the tween for before yoyo'ing.
Optionalinterpolation?: string | Function
The interpolation function to use if the value given is an array of numbers.
Optionalloop?: string | number | object | Function | any[]
The number of times the tween will repeat. (A value of 1 means the tween will play twice, as it repeated once.) The first loop starts after every property in the tween has completed once.
OptionalloopDelay?: string | number | object | Function | any[]
The time the tween will pause before starting either a yoyo or returning to the start for a repeat.
OptionalonActive?: TweenOnActiveCallback
A function to call when the tween becomes active within the Tween Manager.
OptionalonActiveParams?: any[]
Additional parameters to pass to onActive.
OptionalonComplete?: TweenOnCompleteCallback
A function to call when the tween completes.
OptionalonCompleteParams?: any[]
Additional parameters to pass to onComplete.
OptionalonLoop?: TweenOnLoopCallback
A function to call each time the tween loops.
OptionalonLoopParams?: any[]
Additional parameters to pass to onLoop.
OptionalonPause?: TweenOnPauseCallback
A function to call when the tween is paused.
OptionalonPauseParams?: any[]
Additional parameters to pass to onPause.
OptionalonRepeat?: TweenOnRepeatCallback
A function to call each time a property tween repeats. Called once per property per target.
OptionalonRepeatParams?: any[]
Additional parameters to pass to onRepeat.
OptionalonResume?: TweenOnResumeCallback
A function to call when the tween is resumed after being paused.
OptionalonResumeParams?: any[]
Additional parameters to pass to onResume.
OptionalonStart?: TweenOnStartCallback
A function to call when the tween starts playback, after any delays have expired.
OptionalonStartParams?: any[]
Additional parameters to pass to onStart.
OptionalonStop?: TweenOnStopCallback
A function to call when the tween is stopped.
OptionalonStopParams?: any[]
Additional parameters to pass to onStop.
OptionalonUpdate?: TweenOnUpdateCallback
A function to call each time the tween steps. Called once per property per target.
OptionalonUpdateParams?: any[]
Additional parameters to pass to onUpdate.
OptionalonYoyo?: TweenOnYoyoCallback
A function to call each time a property tween yoyos. Called once per property per target.
OptionalonYoyoParams?: any[]
Additional parameters to pass to onYoyo.
Optionalpaused?: boolean
Does the tween start in a paused state (true) or playing (false)?
Optionalpersist?: boolean
Will the Tween be automatically destroyed on completion, or retained for future playback?
Optionalprops?: { [key: string]: string | number | GetEndCallback | TweenPropConfig }
The properties to tween.
Optionalrepeat?: number
The number of times each property tween repeats.
OptionalrepeatDelay?: number
The number of milliseconds to pause before a repeat.
Optionalyoyo?: boolean
Should the tween complete, then reverse the values incrementally to get back to the starting tween values? The reverse tweening will also take duration milliseconds to complete.

visible

visible: boolean

The visible state of the Game Object.

An invisible Game Object will skip rendering, but will still process update logic.

w

w: number

The w position of this Game Object.

width

width: number

The native (un-scaled) width of this Game Object.

Changing this value will not change the size that the Game Object is rendered in-game. For that you need to either set the scale of the Game Object (setScale) or use the displayWidth property.

x

x: number

The x position of this Game Object.

y

y: number

The y position of this Game Object.

z

z: number

The z position of this Game Object.

Note: The z position does not control the rendering order of 2D Game Objects. Use Phaser.GameObjects.Components.Depth#depth instead.

Interface ContainerConfiguration

Hierarchy (View Summary)

Index

Properties

Properties

active

alpha

angle

blendMode

Optionalchildren

depth

displayHeight

displayWidth

ReadonlyhasTransformComponent

height

mask

rotation

scale

scaleX

scaleY

scrollFactor

scrollFactorX

scrollFactorY

tween

Type Declaration

[key: string]: any

OptionalcallbackScope?: any

OptionalcompleteDelay?: string | number | object | Function | any[]

Optionaldelay?: number | Function

Optionalduration?: number

Optionalease?: string | Function

OptionaleaseParams?: any[]

OptionalflipX?: boolean

OptionalflipY?: boolean

Optionalhold?: number

Optionalinterpolation?: string | Function

Optionalloop?: string | number | object | Function | any[]

OptionalloopDelay?: string | number | object | Function | any[]

OptionalonActive?: TweenOnActiveCallback

OptionalonActiveParams?: any[]

OptionalonComplete?: TweenOnCompleteCallback

OptionalonCompleteParams?: any[]

OptionalonLoop?: TweenOnLoopCallback

OptionalonLoopParams?: any[]

OptionalonPause?: TweenOnPauseCallback

OptionalonPauseParams?: any[]

OptionalonRepeat?: TweenOnRepeatCallback

OptionalonRepeatParams?: any[]

OptionalonResume?: TweenOnResumeCallback

OptionalonResumeParams?: any[]

OptionalonStart?: TweenOnStartCallback

OptionalonStartParams?: any[]

OptionalonStop?: TweenOnStopCallback

OptionalonStopParams?: any[]

OptionalonUpdate?: TweenOnUpdateCallback

OptionalonUpdateParams?: any[]

OptionalonYoyo?: TweenOnYoyoCallback

OptionalonYoyoParams?: any[]

Optionalpaused?: boolean

Optionalpersist?: boolean

Optionalprops?: { [key: string]: string | number | GetEndCallback | TweenPropConfig }

Optionalrepeat?: number

OptionalrepeatDelay?: number

Optionalyoyo?: boolean

tweenchain

Type Declaration

[key: string]: any

OptionalcallbackScope?: any

OptionalcompleteDelay?: string | number | object | Function | any[]

Optionaldelay?: number | Function

Optionalduration?: number

Optionalease?: string | Function

OptionaleaseParams?: any[]

OptionalflipX?: boolean

OptionalflipY?: boolean

Optionalhold?: number

Optionalinterpolation?: string | Function

Optionalloop?: string | number | object | Function | any[]

OptionalloopDelay?: string | number | object | Function | any[]

OptionalonActive?: TweenOnActiveCallback

`Optional`children

`Readonly`hasTransformComponent

`Optional`callbackScope?: any

`Optional`completeDelay?: string | number | object | Function | any[]

`Optional`delay?: number | Function

`Optional`duration?: number

`Optional`ease?: string | Function

`Optional`easeParams?: any[]

`Optional`flipX?: boolean

`Optional`flipY?: boolean

`Optional`hold?: number

`Optional`interpolation?: string | Function

`Optional`loop?: string | number | object | Function | any[]

`Optional`loopDelay?: string | number | object | Function | any[]

`Optional`onActive?: TweenOnActiveCallback

`Optional`onActiveParams?: any[]

`Optional`onComplete?: TweenOnCompleteCallback

`Optional`onCompleteParams?: any[]

`Optional`onLoop?: TweenOnLoopCallback

`Optional`onLoopParams?: any[]

`Optional`onPause?: TweenOnPauseCallback

`Optional`onPauseParams?: any[]

`Optional`onRepeat?: TweenOnRepeatCallback

`Optional`onRepeatParams?: any[]

`Optional`onResume?: TweenOnResumeCallback

`Optional`onResumeParams?: any[]

`Optional`onStart?: TweenOnStartCallback

`Optional`onStartParams?: any[]

`Optional`onStop?: TweenOnStopCallback

`Optional`onStopParams?: any[]

`Optional`onUpdate?: TweenOnUpdateCallback

`Optional`onUpdateParams?: any[]

`Optional`onYoyo?: TweenOnYoyoCallback

`Optional`onYoyoParams?: any[]

`Optional`paused?: boolean

`Optional`persist?: boolean

`Optional`props?: { [key: string]: string | number | GetEndCallback | TweenPropConfig }

`Optional`repeat?: number

`Optional`repeatDelay?: number

`Optional`yoyo?: boolean

`Optional`callbackScope?: any

`Optional`completeDelay?: string | number | object | Function | any[]

`Optional`delay?: number | Function

`Optional`duration?: number

`Optional`ease?: string | Function

`Optional`easeParams?: any[]

`Optional`flipX?: boolean

`Optional`flipY?: boolean

`Optional`hold?: number

`Optional`interpolation?: string | Function

`Optional`loop?: string | number | object | Function | any[]

`Optional`loopDelay?: string | number | object | Function | any[]

`Optional`onActive?: TweenOnActiveCallback

`Optional`onActiveParams?: any[]

`Optional`onComplete?: TweenOnCompleteCallback

`Optional`onCompleteParams?: any[]

`Optional`onLoop?: TweenOnLoopCallback

`Optional`onLoopParams?: any[]

`Optional`onPause?: TweenOnPauseCallback

`Optional`onPauseParams?: any[]

`Optional`onRepeat?: TweenOnRepeatCallback

`Optional`onRepeatParams?: any[]

`Optional`onResume?: TweenOnResumeCallback

`Optional`onResumeParams?: any[]

`Optional`onStart?: TweenOnStartCallback

`Optional`onStartParams?: any[]

`Optional`onStop?: TweenOnStopCallback

`Optional`onStopParams?: any[]

`Optional`onUpdate?: TweenOnUpdateCallback

`Optional`onUpdateParams?: any[]

`Optional`onYoyo?: TweenOnYoyoCallback

`Optional`onYoyoParams?: any[]

`Optional`paused?: boolean

`Optional`persist?: boolean

`Optional`props?: { [key: string]: string | number | GetEndCallback | TweenPropConfig }

`Optional`repeat?: number

`Optional`repeatDelay?: number

`Optional`yoyo?: boolean