Skip to content
Flecs v4.2
EcsScript Struct Reference

Script component. More...

#include <script.h>

Public Attributes

char * filename
 Script filename.
char * code
 Script source code.
char * error
 Set if script evaluation had errors.
ecs_script_t * script
 Parsed script object.
ecs_script_template_t * template_
 Only set for template scripts.
ecs_vec_t observers
 Observers for referenced components.
ecs_vec_t dyn_observers
 Observers for refs resolved at runtime.
bool skip_unknown
 Skip unknown components when loading.
bool ir
 Evaluate script with IR runtime.
char * saved_code
 Code as it was last loaded or saved.
ecs_vec_t undo
 Previous versions of the code, most recent last (vec<char*>).

Detailed Description

Script component.

This component is added to the entities of managed scripts and templates.

Definition at line 123 of file script.h.

Member Data Documentation

◆ code

char* EcsScript::code

Script source code.

Definition at line 125 of file script.h.

◆ dyn_observers

ecs_vec_t EcsScript::dyn_observers

Observers for refs resolved at runtime.

Definition at line 130 of file script.h.

◆ error

char* EcsScript::error

Set if script evaluation had errors.

Definition at line 126 of file script.h.

◆ filename

char* EcsScript::filename

Script filename.

Definition at line 124 of file script.h.

◆ ir

bool EcsScript::ir

Evaluate script with IR runtime.

Definition at line 132 of file script.h.

◆ observers

ecs_vec_t EcsScript::observers

Observers for referenced components.

Definition at line 129 of file script.h.

◆ saved_code

char* EcsScript::saved_code

Code as it was last loaded or saved.

For scripts loaded from a file this is the content of the file when it was last read or written. Used to detect unsaved changes and changes to the file on disk.

Definition at line 137 of file script.h.

◆ script

ecs_script_t* EcsScript::script

Parsed script object.

Definition at line 127 of file script.h.

◆ skip_unknown

bool EcsScript::skip_unknown

Skip unknown components when loading.

Definition at line 131 of file script.h.

◆ template_

ecs_script_template_t* EcsScript::template_

Only set for template scripts.

Definition at line 128 of file script.h.

◆ undo

ecs_vec_t EcsScript::undo

Previous versions of the code, most recent last (vec<char*>).

Updating the code of the script appends the replaced code. See ecs_script_undo().

Definition at line 141 of file script.h.


The documentation for this struct was generated from the following file: