From 754273d955c1286144286827047b68f31beecd23 Mon Sep 17 00:00:00 2001 From: Matt Penny Date: Sat, 2 Mar 2024 16:06:26 -0500 Subject: [PATCH] Update fizzler docs, and consistent spacing --- documentation/levels/level_objects/fizzler.md | 12 +++++++++++- documentation/levels/level_objects/trigger.md | 2 +- documentation/levels/signals.md | 2 +- src/levels/level_definition.h | 2 +- src/scene/fizzler.c | 4 ++-- src/scene/fizzler.h | 2 +- 6 files changed, 17 insertions(+), 7 deletions(-) diff --git a/documentation/levels/level_objects/fizzler.md b/documentation/levels/level_objects/fizzler.md index 1ca3826..9023c22 100644 --- a/documentation/levels/level_objects/fizzler.md +++ b/documentation/levels/level_objects/fizzler.md @@ -6,5 +6,15 @@ objects and any player-placed portals. ## Name structure ``` -@fizzler +@fizzler [CUBE_SIGNAL_NAME] ``` + +## Arguments + +| Name | Description | +| ----------------------------- | ---------------------------------------------------------------------------------------------- | +| `CUBE_SIGNAL_NAME` (optional) | The name of the signal to emit when a cube is fizzled. Use `-1` or omit to indicate no signal. | + +## Notes + +The cube signal is only set for the frame that fizzling starts. diff --git a/documentation/levels/level_objects/trigger.md b/documentation/levels/level_objects/trigger.md index 9c6d3c3..ce60f3b 100644 --- a/documentation/levels/level_objects/trigger.md +++ b/documentation/levels/level_objects/trigger.md @@ -23,4 +23,4 @@ A 3D box that can set [signals](../signals.md) and start Triggers are only activated when objects are entirely contained within them. Signals are set until the relevant object leaves the trigger. Each cutscene -(player or cube) is only activiated at most one time each. \ No newline at end of file +(player or cube) is only activiated at most one time each. diff --git a/documentation/levels/signals.md b/documentation/levels/signals.md index 5fc276c..951ab5d 100644 --- a/documentation/levels/signals.md +++ b/documentation/levels/signals.md @@ -1,6 +1,6 @@ # Level Signals -Signals are a way to indicate that something has happened in a level. They can +Signals are a way to indicate that something is happening in a level. They can be emitted by: * Level objects * Triggers diff --git a/src/levels/level_definition.h b/src/levels/level_definition.h index e72a29b..125f28c 100644 --- a/src/levels/level_definition.h +++ b/src/levels/level_definition.h @@ -239,7 +239,7 @@ struct FizzlerDefinition { float width; float height; short roomIndex; - short cubeSignalIndex; + short cubeSignalIndex; }; struct ElevatorDefinition { diff --git a/src/scene/fizzler.c b/src/scene/fizzler.c index af224e4..4f74376 100644 --- a/src/scene/fizzler.c +++ b/src/scene/fizzler.c @@ -19,7 +19,7 @@ #define GFX_PER_PARTICLE(particleCount) ((particleCount) + (((particleCount) + 7) >> 3) + 1) void fizzlerTrigger(void* data, struct CollisionObject* objectEnteringTrigger) { - struct Fizzler* fizzler = (struct Fizzler*)data; + struct Fizzler* fizzler = (struct Fizzler*)data; if (objectEnteringTrigger->body) { objectEnteringTrigger->body->flags |= RigidBodyFizzled; @@ -151,7 +151,7 @@ void fizzlerInit(struct Fizzler* fizzler, struct Transform* transform, float wid fizzler->rigidBody.transform = *transform; fizzler->rigidBody.currentRoom = room; - fizzler->cubeSignalIndex = cubeSignalIndex; + fizzler->cubeSignalIndex = cubeSignalIndex; collisionObjectUpdateBB(&fizzler->collisionObject); collisionSceneAddDynamicObject(&fizzler->collisionObject); diff --git a/src/scene/fizzler.h b/src/scene/fizzler.h index d6fbd87..c109cc5 100644 --- a/src/scene/fizzler.h +++ b/src/scene/fizzler.h @@ -28,7 +28,7 @@ struct Fizzler { short maxVerticalExtent; short oldestParticleIndex; short dynamicId; - short cubeSignalIndex; + short cubeSignalIndex; }; void fizzlerInit(struct Fizzler* fizzler, struct Transform* transform, float width, float height, int room, short cubeSignalIndex);