bonfire_tiled_widget.md

BonfireWidget

Widget that is used to work with Bonfire

To use Bonfire, use the following widget to map builded with Tiled:

(RECOMMENDED)

@override
  Widget build(BuildContext context) {
    return BonfireWidget(
      gameController: GameController(), // with the controller you can listen to all components of the game, control them and or add new ones.
      joystick: Joystick(), // required
      map: WorldMapByTiled('tile/map.json', forceTileSize: tileSize), // required
      player: Knight(), // If player is omitted, the joystick directional will control the map view, being very useful in the process of building maps
      components: <GameComponent>[],
      interface: KnightInterface(),
      background: GameComponent(), // to color you can use `BackgroundColorGame(Colors.blue)` or create your own background (to use parallax for example) extending from `GameComponent`
      constructionMode: false, // If true, activates hot reload to ease the map constructions and draws the grid
      showCollisionArea: false, // If true, show collision area of the elements
      constructionModeColor: Colors.blue, // If you wan customize the grid color.
      collisionAreaColor: Colors.blue, // If you wan customize the collision area color.
      lightingColorGame: Colors.black.withOpacity(0.4), // if you want to add general lighting for the game
      cameraConfig: CameraConfig(
        sizeMovementWindow: Size(50,50),
        moveOnlyMapArea: false,
        zoom: 1.0, // here you can set the default zoom for the camera. You can still zoom directly on the camera
        smoothCameraEnable: false, // default = false
        setZoomLimitToFitMap: false, // default = false | Set zoom automatically to fit map in the screen.
        smoothCameraSpeed: 1.0,
        target: GameComponent(),
      ),
      showFPS: false,
      progress: Widget(), //progress that show while loading map.
      colorFilter: GameColorFilter(),
      overlayBuilderMap: {
        'buttons':  (BonfireGame game, BuildContext context) {
          return MyWidget();
        }
      }
      initialActiveOverlays: [
        'buttons'
      ],
    );
  }

or to manual map:

@override
  Widget build(BuildContext context) {
    return BonfireWidget(
      gameController: GameController(), // with the controller you can listen to all components of the game, control them and or add new ones.
      joystick: MyJoystick(), // required
      map: WorldMap(<Tile>[]), // required
      player: Knight(), // If player is omitted, the joystick directional will control the map view, being very useful in the process of building maps
      interface: KnightInterface(),
      decorations: <GameDecoration>[],
      enemies: <Enemy>[],
      background: GameComponent(), // to color you can use `BackgroundColorGame(Colors.blue)` or create your own background (to use parallax for example) extending from `GameComponent`
      constructionMode: false, // If true, activates hot reload to ease the map constructions and draws the grid
      showCollisionArea: false, // If true, show collision area of the elements
      constructionModeColor: Colors.blue, // If you wan customize the grid color.
      collisionAreaColor: Colors.blue, // If you wan customize the collision area color.
      lightingColorGame: Colors.black.withOpacity(0.4), // if you want to add general lighting for the game
      cameraConfig: CameraConfig(
        sizeMovementWindow: Size(50,50),
        moveOnlyMapArea: false,
        zoom: 1.0, // here you can set the default zoom for the camera. You can still zoom directly on the camera
        target: GameComponent(),
      ),
      showFPS: false,
      colorFilter: GameColorFilter(),
    );
  }