Skip to main content

Module types

Module types 

Source
Expand description

Protocol-level primitive types.

Structs§

AgentProperties
Basic properties for any agent entity.
ClientId
A unique identifier for a connected client session. Assigned by the transport layer on connection, released on disconnect.
ComponentKind
A component type identifier. Used by the Encoder to determine how to serialize/deserialize a specific component’s fields.
DataDrop
Replicated state for a data drop entity.
DataStore
Replicated state for an agent’s data store.
ExtractionBeam
Replicated state for an agent’s extraction beam.
InputCommand
Aggregated user input for a single simulation tick.
IntegrityPool
Replicated state for an agent’s integrity pool.
LocalId
The ECS’s internal entity handle. Opaque to the network layer. In Phase 1 (Bevy), this wraps bevy_ecs::entity::Entity.
NetworkId
A globally unique entity identifier used in all network communication. Assigned by the server. Immutable for the lifetime of the entity.
NetworkIdAllocator
Authoritative allocator for NetworkIds.
PermissionString
A validated access-control permission token.
PriorityPool
Replicated state for an agent’s priority pool.
Resource
Tool
Replicated state for an agent’s primary tool.
ToolId
Unique identifier for a tool type.
Transform
Standard transform component used for replication (ComponentKind 1).
WorkspaceBounds
Spatial bounds of the workspace in world coordinates.
WorkspaceDefinition
Defines a spatial region as a Workspace.
WorkspaceMembership
Defines which Workspace an entity currently belongs to.
WorkspaceName
A validated workspace name.
WorkspaceStringError
Error returned when a WorkspaceName or PermissionString exceeds the allowed byte length.
ZoneId
A globally unique zone identifier.

Enums§

AIState
NPC Drone behavior state Machine.
AgentKind
Agent classification for rendering and property selection.
AllocatorError
InteractionBeamType
Beam delivery classification.
PayloadType
Payload types extracted from resources.
PlayerInputKind
Individual input actions performed by a player in a single tick.
RespawnLocation
Definitive respawn target semantics.
WorkspaceAccessPolicy
Access control policy for the workspace.

Constants§

ACTION_USE_TOOL
Action bitflag: use primary tool.
ALLOWED_ACTIONS_MASK
Bitmask of all currently supported action flags.
BEAM_MARKER_KIND
Replicated component for beam marker state.
DATA_DROP_KIND
Replicated component for data drop state.
DATA_STORE_KIND
Replicated component for agent data store state (replicated to owner).
ENTITY_TYPE_AGENT
Constant identifiers for entity types used in replication and rendering.
ENTITY_TYPE_AI_AGENT
ENTITY_TYPE_BEAM
ENTITY_TYPE_CARRIER_AGENT
ENTITY_TYPE_DATA_DROP
ENTITY_TYPE_HEAVY_AGENT
ENTITY_TYPE_RESOURCE
ENTITY_TYPE_TRAINING_TARGET
EXTRACTION_BEAM_KIND
Replicated component for the extraction beam state.
INPUT_COMMAND_KIND
Discriminant for client-to-server input commands. Tagged as Transient/Inbound-Only.
INTEGRITY_POOL_KIND
Replicated component for integrity pool state.
MAX_ACTIONS
Maximum allowed actions in a single InputCommand to prevent payload DoS. Chosen to stay well within MAX_SAFE_PAYLOAD_SIZE (1200 bytes).
MAX_WORKSPACE_STRING_BYTES
Maximum byte length (UTF-8) for WorkspaceName and PermissionString.
PRIORITY_POOL_KIND
Replicated component for priority pool state.
PROTOCOL_VERSION
RESOURCE_KIND
Replicated component for resource payload depletion tracking.
TOOL_KIND
Replicated component for primary tool state.
WORKSPACE_BOUNDS_KIND
Replicated component for Workspace Bounds.
WORKSPACE_DEFINITION_KIND
Replicated component for Workspace Definition.
WORKSPACE_MEMBERSHIP_KIND
Replicated component for Workspace Membership.

Functions§

get_default_properties
Returns the default authoritative vitals (max_integrity, max_priority) for a given entity type.