Skip to content

Commit 69a0464

Browse files
committed
comment dascript
1 parent 6b72e50 commit 69a0464

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

grngame/bindings/da_script_bind.h

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,23 @@
55
extern "C" {
66
#endif
77

8+
// opaque pointer to a DaScriptEngine C++ class
89
typedef struct DaScriptVm DaScriptVm;
910

11+
/// Creates a new dascript vm
1012
DaScriptVm* DaScriptEngineCreate(void);
13+
14+
/// Destroys the dascript vm
1115
void DaScriptEngineDestroy(DaScriptVm* self);
16+
17+
/// Tries to compile the script named script_name
18+
/// It will look in the scripts folder for a script named script_name.das
19+
/// Works with scripts in subfolders
20+
/// Returns wether or not it succeeded, and logs the errors
1221
bool DaScriptEngineCompileScript(DaScriptVm* self, const char* script_name);
22+
23+
/// Tries to run the script named script_name
24+
/// Returns wether or not it succeeded, and logs the errors
1325
bool DaScriptEngineRunScript(DaScriptVm* self, const char* script_name, const char* entry);
1426

1527
#ifdef __cplusplus

0 commit comments

Comments
 (0)