C/C++ SDK / C ABI · Core (all targets) / KroysComponentTypeDesc

KroysComponentTypeDesc

A plugin component type (core->RegisterComponentType).

Kindstruct

Headerkroys/kroys_plugin.h

Members11

DECLARATION

Declaration

Declared in kroys/kroys_plugin.h.

kroys_plugin.h

typedef struct KroysComponentTypeDesc { ... } KroysComponentTypeDesc;

REFERENCE

Members

Fields

#uint32_t structSize;

Size of this struct as the writer compiled it (sizeof); the reader uses it to detect members appended by later minor versions.

field

#uint32_t flags;

KROYS_COMPONENT_*

field

#const char* name;

local name; the engine type is "<plugin id>.<name>"

field

#const char* displayName;

Inspector and Add Component name; null: name.

field

#const char* category;

Add Component group; null: "Plugins"

field

#const char* description;

Add Component tooltip; null: none.

field

#uint32_t schemaVersion;

>= 1

field

#uint32_t fieldCount;

Number of entries in fields.

field

#const KroysFieldDesc* fields;

The reflected fields (fieldCount entries, fieldDescSize bytes apart).

field

#uint32_t fieldDescSize;

sizeof(KroysFieldDesc) of the plugin's headers (array stride)

field

#uint32_t reserved;

Padding reserved for later use; leave it 0.

field

Members

uint32_t structSize;
uint32_t flags;
const char* name;
const char* displayName;
const char* category;
const char* description;
uint32_t schemaVersion;
uint32_t fieldCount;
const KroysFieldDesc* fields;
uint32_t fieldDescSize;
uint32_t reserved;

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.