flutter3d
Showcase Changelog 62 packages API reference

Levels from a seed: the source

since 1.0.0-rc.1 Simulation, audio and XR

Regions the guide quotes: rules (line 53), generate (line 57), draw (line 68), check (line 149).

1/// A level made from a seed and a few rules: rooms laid out by wave function
2/// collapse, joined by corridors, the player in one room and the exit in the
3/// farthest, and refused unless the exit can be walked to.
4///
5/// Quoted by `procedural_levels.md` and shown whole in the Source tab.
6library;
7
8import 'dart:convert';
9
10import 'package:flutter3d/flutter3d.dart';
11import 'package:flutter3d_showcase/src/demo/demo.dart';
12import 'package:flutter3d_showcase/src/demo/scene_kit.dart';
13import 'package:flutter3d_sim/flutter3d_sim.dart';
15/// The `procedural-levels` page: a level of rooms made from a seed. Its
16/// check is that a seed makes the same level twice and that its exit can be
17/// walked to.
18final class ProceduralLevelsDemo extends ShowcaseDemo {
19 /// The seed the level is made from, 1 to 64, rounded.
20 double seed = 7;
22 /// How densely rooms are laid out, 0.3 to 0.95.
23 double density = 0.7;
25 bool _dirty = true;
26 late final DeviceMesh _cube;
27 late final MeshNode _player;
28 late final MeshNode _exit;
29 final SceneNode _rooms = SceneNode(name: 'rooms');
30 late Generated _generated;
32 @override
33 void configureView(DemoContext context) {
34 context.orbit
35 ..distance = 78.0
36 ..pitch = 1.1
37 ..yaw = 0.0;
38 context.orbit.target.setValues(32.0, 0.0, 24.0);
39 }
41 @override
42 Scene build(DemoContext context) {
43 _cube = DeviceMesh.upload(
44 context.device,
45 CuboidShape(size: Vector3.all(1.0)).build(),
46 );
47 _player = ballNode(context, 'player', 1.2, Vector4(0.35, 0.9, 0.45, 1.0));
48 _exit = ballNode(context, 'exit', 1.2, Vector4(0.95, 0.35, 0.3, 1.0));
49 _regenerate();
50 return sceneOf(<SceneNode>[_rooms, _player, _exit]);
51 }
53 /// Four cells across and three down, sixteen metres each, a room of ten
54 /// in each cell the seed makes a room, and corridors three metres wide.
55 LevelRules get _rules => LevelRules(density: density);
57 /// The level [seed] makes. When a seed makes nothing playable, the next is
58 /// tried, and [Generated.seed] says which one it was.
59 Generated _make(int seed) => generateLevel(_rules, seed: seed);
61 void _regenerate() {
62 _generated = _make(seed.round());
63 for (final SceneNode old in _rooms.children) {
64 _rooms.remove(old);
65 }
66 final Level? level = _generated.level;
67 if (level == null) return;
68 // The rooms and corridors are recipes; `expandRecipes` turns them into
69 // the brushes everything that uses a level reads. The ceilings are left
70 // out so the camera sees in.
71 for (final Brush brush in expandRecipes(level).brushes) {
72 if (brush.material == 'ceiling') continue;
73 final bool floor = brush.material == 'floor';
74 _rooms.add(
75 MeshNode(
76 _cube,
77 RenderMaterial(
78 name: brush.material,
79 baseColor: floor
80 ? LinearColor.fromSrgb(0.42, 0.44, 0.47, 1.0)
81 : LinearColor.fromSrgb(0.72, 0.66, 0.56, 1.0),
82 roughness: 0.85,
83 ),
84 name: brush.material,
85 )
86 ..setPositionFrom(
87 brush.center.toVector3Relative(WorldPosition.origin),
88 )
89 ..setScale(brush.size.x, brush.size.y, brush.size.z),
90 );
91 }
92 _player.setPositionFrom(
93 level
94 .ofType('player_spawn')
95 .first
96 .position
97 .toVector3Relative(WorldPosition.origin) +
98 Vector3(0, 1.2, 0),
99 );
100 _exit.setPositionFrom(
101 level
102 .ofType('exit')
103 .first
104 .position
105 .toVector3Relative(WorldPosition.origin) +
106 Vector3(0, 1.2, 0),
107 );
108 }
110 @override
111 void update(DemoContext context, double dt) {
112 if (!_dirty) return;
113 _dirty = false;
114 _regenerate();
115 }
117 @override
118 List<DemoControl> controls(DemoContext context) => <DemoControl>[
119 SliderControl(
120 'Seed',
121 min: 1,
122 max: 64,
123 divisions: 63,
124 value: () => seed,
125 onChanged: (double v) {
126 seed = v;
127 _dirty = true;
128 },
129 format: (double v) => '${v.round()}',
130 ),
131 SliderControl(
132 'Room density',
133 min: 0.3,
134 max: 0.95,
135 value: () => density,
136 onChanged: (double v) {
137 density = v;
138 _dirty = true;
139 },
140 format: (double v) => v.toStringAsFixed(2),
141 ),
142 ];
144 @override
145 void verify(Scene scene, FrameResult frame) {
146 if (frame.drawCalls < 1 || _rooms.children.isEmpty) {
147 throw StateError('no room of the level reached the frame');
148 }
149 final Generated first = _make(seed.round());
150 final Generated again = _make(seed.round());
151 final Level level = first.level!;
152 if (jsonEncode(level.toJson()) != jsonEncode(again.level!.toJson())) {
153 throw StateError('the same seed should make the same level');
154 }
155 // The generator held the level to this rule already; asking again is
156 // what any game that loads a level can do.
157 final List<LevelIssue> issues = <LevelIssue>[];
158 const ExitReachable().check(LevelCheck(level: level, out: issues));
159 if (issues.any((LevelIssue i) => i.isError)) {
160 throw StateError('the exit cannot be walked to: $issues');
161 }
162 }