Script editor #3074

ohlidalp · 2023-07-23T03:51:13Z

Script writing is powerful but clumsy:

edit in external editor, save to Documents\My Games\Rigs of Rods\scripts
switch to RoR, either type loadscript ... to console or use ScriptMonitor menu to Load/Reload the script
if there's an error, switch to Angelscript.log and figure the error
repeat

To make scripting fun, the dev/test cycle needs to be quick and comfy. So we needed an ingame editor with a "(RE)START" button and error reporting.

Behold the 'script_editor.as' AngelScript editor written in AngelScript:

At the moment it's somewhat glitchy but the START/STOP button works perfectly. It relies entirely on ImGui::InputTextMultiline(), errors and syntax highlight is done by overdrawing. The numbers are: line number, line length, comment offset, num errors - most are not useful but look cool, you can disable them in the View menu.

Update: yes, the hyperlink opens the default browser (only tested on Win10).

Update2: added game.findResourceFileInfo() which lists files in pre-defined resource groups. This allowed me to list up files in user's 'scripts' dir:

ohlidalp · 2023-07-24T23:41:52Z

I'm getting ahead of myself... but just a little.

BTW is it weird to run a physics sandbox game just to make and use your own text editor in there? 😅

AnotherFoxGuy · 2023-07-26T12:04:14Z

I just tested this, and one crash that I found is that if you try and load a script from a terrain folder the game crashes

ohlidalp · 2023-07-26T18:22:22Z

I just realized I'm not nearly done here, so I've converted this to draft.

@AnotherFoxGuy Probably an uncaught exception. I just added an exception-reporting event type, but I need to manually wrap all troublesome funcs. The save/loadStringResource() aren't wrapped yet.

I just added an API giving script info - I need it to make nice exception window, and also to tell which exceptions belong to who - the editor needs to catch all so it can diagnose it's guest script. The thisScript is a new automatic global var.

ohlidalp · 2023-07-26T21:26:31Z

If this isn't cool, IDK what is 😎

ohlidalp · 2023-07-26T22:10:43Z

@AnotherFoxGuy I can't seem to reproduce the crash you mentioned.

ohlidalp · 2023-08-25T13:43:26Z

Latest development: 👼script bindings of OGRE overlay system and a prototype editor script allowing you to add/edit/delete elements and export OGRE's .overlay files.. Also the editor now has tabs and autosave.

The diagnostic info directly from AngelScript engine (see `asSMessageInfo`), args: #1 ScriptUnitID, #2 asEMsgType, #3 row, #4 col, #5 sectionName, #6 message

…usbar.

CODECCHANGES: * scriptEngine.h: framestep() now returns void (retval was meaningless since multiple scripts got supported); aded `executeContextAndHandleErrors()` and `exceptionCallback()` * scriptEngine.cpp: framestep() now uses `executeContextAndHandleErrors()` * gameScript: added functions `get/setRegisteredEventsMask()` so that script editor can listen for the guest script's exceptions. * scriptEvents.h: added SE_ANGELSCRIPT_EXCEPTIONCALLBACK * doc/script2game/globals.h: added events SE_ANGELSCRIPT_EXCEPTIONCALLBACK (new) and SE_ANGELSCRIPT_LINECALLBACK (omitted by mistake). script_editor.as updated - angelscript exceptions are displayed alongside forwarded C++ exceptions

Folding is not implemented yet, only a visual highlight is present for testing. overlay_editor.as was marked up as example. Note the markers must be in // comments not to disrupt AngelScript.

`triggerEvent()` and `envokeCallback()` now use `[prepare/execute]ContextAndHandleErrors()` helpers. Coded while investigating Xploder98's as_CONTEXT_NOT_PREPARED problem which turned out to be a callback with incorrect signature.

….as"

….as' New conventions: * scripts with name 'example_*.as' are examples and have Examples menu in the script editor (aready estabilished) * scripts with name '*_utils.as' are includes and have Includes menu in the script editor (new) Documenting style (example): /// \title SCRIPT NAME /// \brief One-line short description /// Blah blah details... /// Usage: /// `#include "scriptname.as"` ~~ adds the utils to your script

- loading new file also focuses the new tab - fixed Save menu "Select" button writing to Load menu's inputbox - fixed script title & brief strings not appearing in menus.

CuriousMike56

Seems to work fine, though my knowledge with scripting is quite limited. A search feature and the ability to duplicate a line (CTRL+D in Notepad++) would be nice, but those could come later.

…rbage.

apparently `getAsString()` has some Linux-x64 issues (`eof()` triggers SIGINT): see https://discord.com/channels/136544456244461568/189904947649708032/1155952230130778262 Observed with OGRE 1.11.6

* changed "select+load" to just "load" in menubar. * workaround: clamp error line num.s to actual line count * Renamed "Welcome" tab to "Tutorial.as". * fixed bogus filesize of Recent scripts.

ohlidalp requested review from tritonas00, AnotherFoxGuy and CuriousMike56 July 23, 2023 12:39

ohlidalp force-pushed the script_editor branch from 3253a5a to 1755f6f Compare July 25, 2023 05:51

ohlidalp marked this pull request as draft July 26, 2023 18:18

Debug build fix of RigsOfRods#3085

4952340

ohlidalp mentioned this pull request Sep 17, 2023

👼Script: OGRE bindings for editing scene, meshes and textures - with examples #3030

Merged

ohlidalp added 17 commits September 18, 2023 01:03

👼 script: new event SE_ANGELSCRIPT_MSGCALLBACK

f044dc6

The diagnostic info directly from AngelScript engine (see `asSMessageInfo`), args: #1 ScriptUnitID, #2 asEMsgType, #3 row, #4 col, #5 sectionName, #6 message

ImGuiAngelscript: fixed bad strings - crash hazzard

fbf6c98

👼 MSG_APP_LOAD_SCRIPT_REQUESTED can load from memory

ab3e13b

added 'script_editor.as' - has working "RUN" button!

0e98716

👼 script: added ImGui tab bar API + demo_script.as example.

b5afe89

ImGuiAngelscript: Fixed BeginChild(str...), added BeginChild(ID...)

6939f32

script_editor.as: added line numbers + error highlight

8891559

ImGuiAngelscript: InputTextMultiline() - added size param

2d67adc

Script editor: added 'num chars on line' column

def84bd

ImGuiAngelscript: fixed CalcTextSize() X being always 0.

c35a6ae

script_editor.as: proper errCount column + error texts

cff0c58

script_editor.as: Fixed error text layering, added warning text.

83a63dc

👼 Script: added SCRIPT_(UN)LOADED event types.

6ff3f7d

'script_editor.as': added STOP button, showing "(NOT)RUNNING" in stat…

aaa56cc

…usbar.

Fix: Silenced false console errmsg "Could not load script, no main()"

ced754a

script_editor.as: added comment highlights (+ number column)

eedddd5

script_editor.as: added Save/Load menus.

19cbac9

ohlidalp added 15 commits September 18, 2023 01:08

example_html_parsing.as: full rewrite, SAX (events) interface

4ec6c9b

script_editor.as: added autosave feature (default 25sec).

50ebcee

👼Script: ImGui::InputTextMultiline(): Removed 4096 char limit

e44c606

script_editor.as: Added tabs! Loading file opens new tab.

ad8fdf8

script_editor.as: File save result indicator (finally!)

28bb2ae

Fixed crash invoking script from asIScriptEngine exception-callback.

9d69e3e

script_editor.as: fixed comments starting on "/" instead on "//"

3ae1398

script_editor.as: added C#-like #region/#endregionmarkers

db60d9e

Folding is not implemented yet, only a visual highlight is present for testing. overlay_editor.as was marked up as example. Note the markers must be in // comments not to disrupt AngelScript.

👼 Script: Extended error handling

db2c3f2

`triggerEvent()` and `envokeCallback()` now use `[prepare/execute]ContextAndHandleErrors()` helpers. Coded while investigating Xploder98's as_CONTEXT_NOT_PREPARED problem which turned out to be a callback with incorrect signature.

script_editor.as: autosave now uses filename {fileNameBuf}+"_Autosave…

c3f3586

….as"

ImGuiAngelscript: added ProgressBar()

09dadbd

scriptinfo_utils.as: formatting, commented-out DBG logs

f1ed16e

Fixes after merging scriptinfo_utils support.

85bb231

ohlidalp force-pushed the script_editor branch from cb24ddf to 85bb231 Compare September 17, 2023 23:15

ohlidalp marked this pull request as ready for review September 17, 2023 23:16

ohlidalp added 3 commits September 18, 2023 23:27

script_editor.as minor fixes in saving/loading files

aeb9780

- loading new file also focuses the new tab - fixed Save menu "Select" button writing to Load menu's inputbox - fixed script title & brief strings not appearing in menus.

script_editor.as: added Docs menu, final touches

872608a

script_editor.as: Fixed line numbers not clipped at the top.

776868e

CuriousMike56 approved these changes Sep 21, 2023

View reviewed changes

ohlidalp added 5 commits September 22, 2023 20:53

Doxygen doc: Added rorserver scripting.

e830cf1

script_editor.as: Fixed 'Save' dumping whole buffer incl. NULs and ga…

e9ae1a0

…rbage.

👼 game.loadTextResourceAsString() linux workaround

b820c7c

apparently `getAsString()` has some Linux-x64 issues (`eof()` triggers SIGINT): see https://discord.com/channels/136544456244461568/189904947649708032/1155952230130778262 Observed with OGRE 1.11.6

Create user profile folder 'scripts' on startup.

b8a7c13

script_editor.as: Fixes during review

a1952a7

* changed "select+load" to just "load" in menubar. * workaround: clamp error line num.s to actual line count * Renamed "Welcome" tab to "Tutorial.as". * fixed bogus filesize of Recent scripts.

ohlidalp force-pushed the script_editor branch from e1ca279 to a1952a7 Compare September 26, 2023 01:45

ohlidalp merged commit 91f99be into RigsOfRods:master Sep 26, 2023
2 checks passed

ohlidalp deleted the script_editor branch September 26, 2023 02:16

ohlidalp mentioned this pull request Oct 23, 2023

Created vehicle tuning GUI using new .addonpart mod type #3096

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Script editor #3074

Script editor #3074

ohlidalp commented Jul 23, 2023 •

edited

Loading

ohlidalp commented Jul 24, 2023

AnotherFoxGuy commented Jul 26, 2023

ohlidalp commented Jul 26, 2023 •

edited

Loading

ohlidalp commented Jul 26, 2023

ohlidalp commented Jul 26, 2023

ohlidalp commented Aug 25, 2023 •

edited

Loading

CuriousMike56 left a comment

Script editor #3074

Script editor #3074

Conversation

ohlidalp commented Jul 23, 2023 • edited Loading

ohlidalp commented Jul 24, 2023

AnotherFoxGuy commented Jul 26, 2023

ohlidalp commented Jul 26, 2023 • edited Loading

ohlidalp commented Jul 26, 2023

ohlidalp commented Jul 26, 2023

ohlidalp commented Aug 25, 2023 • edited Loading

CuriousMike56 left a comment

Choose a reason for hiding this comment

ohlidalp commented Jul 23, 2023 •

edited

Loading

ohlidalp commented Jul 26, 2023 •

edited

Loading

ohlidalp commented Aug 25, 2023 •

edited

Loading