joystick.md

Joysticks

This is a JoystickController

The player-controlling component.

Joystick

There is a pre-included implementation (Joystick) ready to use, but also configurable to add a custom looking or even add as many actions as you will.

Or you can implement JoystickController yourself and emit event trough a JoystickListener.

Joystick is configurable by the following parameters:

  return BonfireWidget(
    joystick: Joystick(
        keyboardConfig: KeyboardConfig(
          enable: true, // Use to enable ou disable keyboard events (default is true)
          acceptedKeys: [ // You can pass specific Keys accepted. If null accept all keys
            LogicalKeyboardKey.space,
          ],
          keyboardDirectionalType: KeyboardDirectionalType.arrows, // Type of the directional (arrows or wasd)
        ), // Here you enable receive keyboard interaction
        directional: JoystickDirectional(
          spriteBackgroundDirectional: Sprite.load('joystick_background.png'), //directinal control background
          spriteKnobDirectional: Sprite.load('joystick_knob.png'), // directional indicator circle background
          color: Colors.black, // if you do not pass  'pathSpriteBackgroundDirectional' or  'pathSpriteKnobDirectional' you can define a color for the directional.
          size: 100, // directional control size
          isFixed: false, // enables directional with dynamic position in relation to the first touch on the screen
        ),
        actions: [
          JoystickAction(
            actionId: 1, //(required) Action identifier, will be sent to 'void joystickAction(JoystickActionEvent event) {}' when pressed
            sprite: Sprite.load('joystick_atack_range.png'), // the action image
            spritePressed: Sprite.load('joystick_atack_range.png'), // Optional image to be shown when the action is fired
            spriteBackgroundDirection: Sprite.load('joystick_background.png'), //directinal control background
            enableDirection: true, // enable directional in action
            align: JoystickActionAlign.BOTTOM_RIGHT,
            color: Colors.blue,
            size: 50,
            margin: EdgeInsets.only(bottom: 50, right: 160),
          )
        ],
    ),
    ...
  );

Check a example.

JoystickMoveToPosition

Use this joystick to moviment your player with touch to a position.

  return BonfireWidget(
    joystick: JoystickMoveToPosition(
      enabledMoveCameraWithClick = false,
      mouseButtonUsedToMoveCamera = MouseButton.primary,
      mouseButtonUsedToMoveToPosition = MouseButton.secondary,
    ),
    ...
  );

• With enabledMoveCameraWithClick enabled:

JoystickListener

Mixin used to listen the joystick interactions.

A component that use this mixin can listen the Joystick events adding as observer:

gameRef.addJoystickObserver(myComponentJoystickListener);