Class JoyStick

Hierarchy

  • BaseJoyStick
    • JoyStick

Constructors

constructor

Properties

topics UseCanvas

Accessors

movePlayer visibility

Methods

destroy disable dispose enable hide init isPointInJoystick off on once setBorderChickness setPadding setSize setStyle show

Constructors

constructor

  • new JoyStick(world): JoyStick

  • Parameters

    Returns JoyStick

Properties

topics

topics: Record<keyof IJoyStickEvent, ITopic<any>[]> = ...

Static UseCanvas

UseCanvas: boolean = true

Accessors

movePlayer

  • get movePlayer(): boolean

  • Returns boolean

  • set movePlayer(value): void

  • Parameters

    • value: boolean

    Returns void

visibility

  • get visibility(): boolean

  • Returns boolean

Methods

destroy

  • destroy(): void

  • Returns void

disable

  • disable(): void

  • Returns void

dispose

  • dispose(): void

  • 移除所有的监听事件

    Returns void

enable

  • enable(): void

  • Returns void

hide

  • hide(): void

  • Returns void

init

  • init(options?): void

  • Parameters

    • Optional options: IJoystickOptions

    Returns void

isPointInJoystick

  • isPointInJoystick(pointX, pointY): boolean

  • 判断触发点是否在摇杆内

    Parameters

    • pointX: number

      二维坐标

    • pointY: number

      二维做表

    Returns boolean

    boolean

off

  • off<K>(topic, listener?): void

  • 移除监听事件

    Type Parameters

    • K extends keyof IJoyStickEvent

    Parameters

    • topic: K
    • Optional listener: IListener<IJoyStickEvent[K]>

    Returns void

on

  • on<K>(topic, listener, order?): {
        unsub: (() => void);
    }

  • 添加事件监听器

    Type Parameters

    • K extends keyof IJoyStickEvent

    Parameters

    • topic: K
    • listener: IListener<IJoyStickEvent[K]>
    • Optional order: number

    Returns {
        unsub: (() => void);
    }

    • unsub: (() => void)
        • (): void

        • Returns void

once

  • once<K>(topic, listener, order?): {
        unsub: (() => void);
    }

  • 添加事件监听器，单个 listener 只执行1次

    Type Parameters

    • K extends keyof IJoyStickEvent

    Parameters

    • topic: K
    • listener: IListener<IJoyStickEvent[K]>
    • Optional order: number

    Returns {
        unsub: (() => void);
    }

    • unsub: (() => void)
        • (): void

        • Returns void

setBorderChickness

  • setBorderChickness(thumbBorderChickness, puckBorderChickness): void

  • Parameters

    • thumbBorderChickness: number
    • puckBorderChickness: number

    Returns void

setPadding

  • setPadding(leftPadding, bottomPadding): void

  • Parameters

    • leftPadding: number
    • bottomPadding: number

    Returns void

setSize

  • setSize(thumbAreaSize, puckSize): void

  • Parameters

    • thumbAreaSize: number
    • puckSize: number

    Returns void

setStyle

  • setStyle(style, mode): void

  • Parameters

    • style: IXJoystickStyle
    • mode: EJoystickMode

    Returns void

show

  • show(): void

  • Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc