EntropyCanvas::Schema::PropertyDefinition

EntropyCanvas::Schema::PropertyDefinition

Property definition within a component schema. More…

#include <ComponentSchema.h>

Public Functions

	Name
bool	operator==(const PropertyDefinition & other) const Equality comparison for property definitions.
bool	operator!=(const PropertyDefinition & other) const

Public Attributes

	Name
PropertyType	type Property type from PropertyTypes.h.
size_t	size Size in bytes.
bool	required Whether this property must be present (default: true).
size_t	offset Byte offset within component struct.
std::string	name Property name (e.g., “position”, “health”).
std::optional< PropertyValue >	defaultValue Optional default value.

Detailed Description

struct EntropyCanvas::Schema::PropertyDefinition;

Property definition within a component schema.

Describes a single property/field within a component type, including its name, type, memory layout offset, size, and metadata.

Metadata fields (required, defaultValue) support cross-application compatibility checking but are NOT included in structural or type hashes. This allows applications to add default values or change required status without breaking compatibility.

Public Functions Documentation

function operator==

inline bool operator==(
    const PropertyDefinition & other
) const

Equality comparison for property definitions.

Two definitions are equal if all fields match exactly, including metadata. Note: Structural hash only uses name/type/offset/size (not metadata).

function operator!=

inline bool operator!=(
    const PropertyDefinition & other
) const

Public Attributes Documentation

variable type

PropertyType type;

Property type from PropertyTypes.h.

variable size

size_t size;

Size in bytes.

variable required

bool required = true;

Whether this property must be present (default: true).

variable offset

size_t offset;

Byte offset within component struct.

variable name

std::string name;

Property name (e.g., “position”, “health”).

variable defaultValue

std::optional< PropertyValue > defaultValue = std::nullopt;

Optional default value.

---

Updated on 2026-01-26 at 17:14:35 -0500