zig/mach
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

ecs: rename World.remove -> World.removeEntity; provide guidance on event names

Browse source 
Signed-off-by: Stephen Gutekanst <stephen@hexops.com>
This commit is contained in:
Stephen Gutekanst 2023-03-27 07:58:52 -07:00 • committed by Stephen Gutekanst
parent de398b0fde
commit 8ff02361da
1 changed files with 11 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

14
libs/ecs/src/systems.zig
View file

@ -310,7 +310,15 @@ pub fn World(comptime modules: anytype) type {
world.entities.deinit(); world.entities.deinit();
} }
/// Broadcasts a state message to all modules that are subscribed to it. /// Broadcasts an event to all modules that are subscribed to it.
///
/// The message tag corresponds with the handler method name to be invoked. For example,
/// if `send(.tick)` is invoked, all modules which declare a `pub fn init` will be invoked.
///
/// Events sent by Mach itself, or the application itself, may be single words. To prevent
/// name conflicts, events sent by modules provided by a library should prefix their events
/// with their module name. For example, a module named `.ziglibs_imgui` should use event
/// names like `.ziglibsImguiClick`, `.ziglibsImguiFoobar`.
pub fn send(world: *Self, comptime msg_tag: anytype) !void { pub fn send(world: *Self, comptime msg_tag: anytype) !void {
inline for (std.meta.fields(@TypeOf(modules))) |module_field| { inline for (std.meta.fields(@TypeOf(modules))) |module_field| {
const module = @field(modules, module_field.name); const module = @field(modules, module_field.name);
@ -327,8 +335,8 @@ pub fn World(comptime modules: anytype) type {
} }
/// Removes an entity. /// Removes an entity.
pub inline fn remove(world: *Self, entity: EntityID) !void { pub inline fn removeEntity(world: *Self, entity: EntityID) !void {
try world.entities.remove(entity); try world.entities.removeEntity(entity);
} }
}; };
} }