Emil
dd02f9cae8
4.8 KiB
More complete examples
Each folder below is a separate, buildable gameplay module with Gameplay.hpp, Gameplay.cpp, and scene.json. Select one using FASET_GAMEPLAY_SOURCE_DIR, as shown in the first tutorial. The Player links that module statically.
Follow an interpolated object
examples/tutorials/following moves an object during fixed updates. A camera follows its presentation pose during lateUpdate:
--8<-- "examples/tutorials/following/Gameplay.cpp"
The camera resolves the saved target ID on each frame, handles its disappearance, reads presentation(target), and writes only its own presentation pose. In this small scene both objects are roots, so their coordinate frames match. For objects under different parents, transform between coordinate frames explicitly; adding local positions from unrelated parents is incorrect.
The tutorial_following test advances one and a half fixed intervals. It checks that the camera follows the halfway presentation position, while its simulation pose is unchanged. It also removes the target to exercise missing-handle behavior.
Spawn and destroy on safe boundaries
examples/tutorials/spawning creates a temporary sprite and removes it after its lifetime:
--8<-- "examples/tutorials/spawning/Gameplay.cpp"
The spawner's onStart queues creation. The new object's onStart runs only when that command is applied. Its elapsed time is ordinary C++ state owned by the callbacks. A key contains all three handle fields, so a recycled slot or restarted session cannot accidentally reuse an older object's timer.
When the timer expires, destroy queues removal; the handle remains valid until the next barrier. onDestroy removes the stored timer entry. The example's spawned_id must be unique in the runtime scene: using the same value on several spawners produces a duplicate-ID diagnostic. A production spawner should choose an appropriate runtime ID policy.
This does not save the spawned object into the authoring document. The test checks deferred creation, eventual invalidation, and a fresh spawn after reloading the scene.
Use a contact-based jump
examples/tutorials/physics contains the complete physics controller. Its test checks movement, a supported jump, rejection of a jump at the apex, and landing. The default example gameplay module also uses the same grounded query.
The query's slope/separation thresholds are intentionally small and explicit. Extend the gameplay controller when your game needs coyote time, jump buffering, climbing steps, or moving platforms; these are not automatically provided by naming a component “character”.
Run the tutorial checks
After configuring a normal build with BUILD_TESTING=ON:
cmake --build build/linux-debug --target \
faset_tutorial_moving_tests faset_tutorial_following_tests \
faset_tutorial_spawning_tests faset_tutorial_physics_tests
ctest --test-dir build/linux-debug -R '^tutorial_' --output-on-failure
On Windows use the chosen Windows build directory. The four tests compile separate gameplay libraries and execute their actual callbacks. They require neither a graphics window nor the Editor. Running a tutorial through faset_player additionally checks rendering and platform integration and requires the documented Vulkan setup.
Schema declarations are tested for stable map-key/FieldId matching and defaults. They remain ordinary C++ source; the engine does not scan arbitrary C++ classes to create this API automatically.
Play complete small projects
examples/projects/collect-2d and examples/projects/collect-3d contain complete projects with a manifest, scene, and a separate Scripts module. Open either folder with the Editor's --project option. The 2D project is ready to Play. For the 3D project, first import Assets/exit-arch/manifest.json from the Assets panel, then Play. Repeat this import after clearing its cache or cloning the project. Each project's README also provides the exact import and direct Player build commands.
Move the blue block with A/D in 2D or WASD in 3D, jump with Space, collect three gold cubes, and reach the green exit after its red gate opens. E resets the round. One pickup is on a raised platform. A visible gold marker and the Player log confirm completion; these initial examples use geometric progress displays instead of a text HUD.
The playable_2d and playable_3d CTests drive the actual modules through input, including the jump, objective, reset, and fresh session. The 3D module also explicitly registers a separately packaged example.beacon component from its local Scripts/Extensions/Beacon.hpp. Gameplay geometry uses built-in primitives; the 3D scene additionally references the imported Blender arch. Its GLB bundle is included, so Blender is only needed to edit or recreate that source asset.