Class Anchor

Anchor a game object to a screen position. Automatically repositions on resize.

Index

Constructors

Methods

apply bottomCenter center topLeft topRight

Constructors

constructor

new Anchor(): Anchor
Returns Anchor

Methods

`Static`apply

apply(
    scene: Scene,
    target: Phaser.GameObjects.Components.Transform,
    config: AnchorConfig,
): () => void
Anchor a target to a screen position with auto-reposition on resize. Returns a cleanup function to remove the resize listener.
Parameters
- scene: Scene
- target: Phaser.GameObjects.Components.Transform
- config: AnchorConfig
Returns () => void
- Defined in packages/clik-engine/src/ui/Anchor.ts:26

`Static`bottomCenter

bottomCenter(
    scene: Scene,
    target: Phaser.GameObjects.Components.Transform,
    offsetY?: number,
): void
Helper: pin to bottom-center
Parameters
- scene: Scene
- target: Phaser.GameObjects.Components.Transform
- offsetY: number = 30
Returns void
- Defined in packages/clik-engine/src/ui/Anchor.ts:81

`Static`center

center(
    scene: Scene,
    target: Phaser.GameObjects.Components.Transform,
    offsetX?: number,
    offsetY?: number,
): void
Helper: center a game object on screen
Parameters
- scene: Scene
- target: Phaser.GameObjects.Components.Transform
- offsetX: number = 0
- offsetY: number = 0
Returns void
- Defined in packages/clik-engine/src/ui/Anchor.ts:66

`Static`topLeft

topLeft(
    scene: Scene,
    target: Phaser.GameObjects.Components.Transform,
    marginX?: number,
    marginY?: number,
): void
Helper: pin to top-left corner
Parameters
- scene: Scene
- target: Phaser.GameObjects.Components.Transform
- marginX: number = 16
- marginY: number = 16
Returns void
- Defined in packages/clik-engine/src/ui/Anchor.ts:71

`Static`topRight

topRight(
    scene: Scene,
    target: Phaser.GameObjects.Components.Transform,
    marginX?: number,
    marginY?: number,
): void
Helper: pin to top-right corner
Parameters
- scene: Scene
- target: Phaser.GameObjects.Components.Transform
- marginX: number = 16
- marginY: number = 16
Returns void
- Defined in packages/clik-engine/src/ui/Anchor.ts:76