aboutsummaryrefslogtreecommitdiff
path: root/src/ecs/component.zig
diff options
context:
space:
mode:
authorjjanzen <jjanzen@jjanzen.ca>2025-01-21 23:26:23 -0600
committerjjanzen <jjanzen@jjanzen.ca>2025-01-21 23:26:23 -0600
commit900c8756edc3bc547dfd2cd47921ecd453bf703b (patch)
tree057be3b086c66bab292da8b2ae798e92f8db54b2 /src/ecs/component.zig
parent385ca6511a8de0a4cc1dca774a3c743422c3d6be (diff)
doc comments and io refactor
Diffstat (limited to 'src/ecs/component.zig')
-rw-r--r--src/ecs/component.zig4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/ecs/component.zig b/src/ecs/component.zig
index 37956d0..3a50c88 100644
--- a/src/ecs/component.zig
+++ b/src/ecs/component.zig
@@ -1,5 +1,7 @@
+//! This module provides a basic component interface for an Entity Component System
const std = @import("std");
+/// An empty component for testing purposes
pub const ComponentStub = struct {
pub fn init(args: ComponentStub) ComponentStub {
_ = args;
@@ -11,10 +13,12 @@ pub const ComponentStub = struct {
}
};
+/// All valid component types are stored in this enum
pub const ComponentType = enum {
component_stub,
};
+/// The components are stored as a MultiArrayList over this struct
pub const Components = struct {
component_stub: ?ComponentStub,
};