docs: removed Blueprint references

pull/282/head
alestiago 3 years ago
parent 72dd8da4f8
commit 344568e919

@ -3,8 +3,7 @@ import 'package:pinball/game/components/components.dart';
import 'package:pinball_components/pinball_components.dart' hide Assets;
/// {@template launcher}
/// A [Blueprint] which creates the [Plunger], [RocketSpriteComponent] and
/// [LaunchRamp].
/// Section where the ball is launched from.
/// {@endtemplate}
class Launcher extends Component {
/// {@macro launcher}

@ -4,8 +4,8 @@ import 'package:pinball_components/pinball_components.dart';
import 'package:pinball_flame/pinball_flame.dart';
/// {@template boundaries}
/// A [Blueprint] which creates the [_BottomBoundary] and [_OuterBoundary].
///{@endtemplate boundaries}
/// Pinball machine boundaring walls.
/// {@endtemplate}
class Boundaries extends Component {
/// {@macro boundaries}
Boundaries()
@ -85,8 +85,10 @@ class _BottomBoundarySpriteComponent extends SpriteComponent with HasGameRef {
}
/// {@template outer_boundary}
/// Boundary enclosing the top and left side of the board. The right side of the
/// board is closed by the barrier the [LaunchRamp] creates.
/// Boundary enclosing the top and left side of the board.
///
/// The right side of the board is closed by the barrier the [LaunchRamp]
/// creates.
/// {@endtemplate outer_boundary}
class _OuterBoundary extends BodyComponent with InitialPosition, Rendering {
/// {@macro outer_boundary}

@ -7,7 +7,7 @@ import 'package:pinball_components/pinball_components.dart' hide Assets;
import 'package:pinball_flame/pinball_flame.dart';
/// {@template dinowalls}
/// A [Blueprint] which creates walls for the [ChromeDino].
/// Walls near the [ChromeDino].
/// {@endtemplate}
class DinoWalls extends Component {
/// {@macro dinowalls}

@ -8,8 +8,7 @@ import 'package:pinball_components/pinball_components.dart';
import 'package:pinball_flame/pinball_flame.dart';
/// {@template launch_ramp}
/// A [Blueprint] which creates the [_LaunchRampBase] and
/// [_LaunchRampForegroundRailing].
/// Ramp where the ball is launched from.
/// {@endtemplate}
class LaunchRamp extends Component {
/// {@macro launch_ramp}
@ -24,11 +23,7 @@ class LaunchRamp extends Component {
);
}
/// {@template launch_ramp_base}
/// Ramp the [Ball] is launched from at the beginning of each ball life.
/// {@endtemplate}
class _LaunchRampBase extends BodyComponent with Layered, Rendering {
/// {@macro launch_ramp_base}
_LaunchRampBase()
: super(
renderBody: false,
@ -140,12 +135,7 @@ class _LaunchRampBackgroundRailingSpriteComponent extends SpriteComponent
}
}
/// {@template launch_ramp_foreground_railing}
/// Foreground railing for the [_LaunchRampBase] to render in front of the
/// [Ball].
/// {@endtemplate}
class _LaunchRampForegroundRailing extends BodyComponent with Rendering {
/// {@macro launch_ramp_foreground_railing}
_LaunchRampForegroundRailing()
: super(
children: [_LaunchRampForegroundRailingSpriteComponent()],

@ -4,8 +4,7 @@ import 'package:pinball_components/pinball_components.dart';
import 'package:pinball_flame/pinball_flame.dart';
/// {@template slingshots}
/// A [Blueprint] which creates the pair of [Slingshot]s on the right side of
/// the board.
/// A collection of [Slingshot]s.
/// {@endtemplate}
class Slingshots extends Component with Rendering {
/// {@macro slingshots}

@ -6,7 +6,7 @@ import 'package:pinball_components/pinball_components.dart';
import 'package:pinball_flame/pinball_flame.dart';
/// {@template spaceship_rail}
/// A [Blueprint] for the rail exiting the [AndroidSpaceship].
/// Rail exiting the [AndroidSpaceship].
/// {@endtemplate}
class SpaceshipRail extends Component {
/// {@macro spaceship_rail}

@ -8,7 +8,7 @@ import 'package:pinball_components/pinball_components.dart' hide Assets;
import 'package:pinball_flame/pinball_flame.dart';
/// {@template spaceship_ramp}
/// A [Blueprint] which creates the ramp leading into the [AndroidSpaceship].
/// Raamp leading into the [AndroidSpaceship].
/// {@endtemplate}
class SpaceshipRamp extends Component {
/// {@macro spaceship_ramp}

Loading…
Cancel
Save