Document the existing scripting commands

ikarth commented 4 years ago

GB Studio has a number of scripting commands. We want to create an API to be able to write scripts via Python. But in order to do that, we need to know what kinds of parameters each script command takes. For example, EVENT_IF_VALUE looks like this in the project file's JSON:


                        {
                            "id": "ffd12d30-9a4b-40c3-8fab-be80048aa76b",
                            "command": "EVENT_IF_VALUE",
                            "args": {
                                "variable": "L3",
                                "operator": ">",
                                "comparator": 2,
                                "__collapseElse": false
                            },
                            "children": {
                                "true": [],
                                "false": []
                            }
                        }

The main thing we need to know is what information is in "args", plus if there are any "children".

Event control

[x] EVENT_END
[x] EVENT_STOP
[x] EVENT_WAIT

Scenes

[x] EVENT_SWITCH_SCENE
[ ] EVENT_START_BATTLE
[ ] EVENT_RETURN_TO_TITLE
[x] EVENT_SCENE_PUSH_STATE
[x] EVENT_SCENE_POP_STATE
[x] EVENT_SCENE_RESET_STATE
[x] EVENT_SCENE_POP_ALL_STATE

Save/Load

[x] EVENT_LOAD_DATA
[x] EVENT_SAVE_DATA
[x] EVENT_CLEAR_DATA

Control flow

[x] EVENT_IF_TRUE
[x] EVENT_IF_FALSE
[x] EVENT_IF_VALUE
[ ] EVENT_IF_VALUE_COMPARE
[x] EVENT_IF_INPUT
[x] EVENT_IF_ACTOR_DIRECTION
[x] EVENT_IF_SAVED_DATA
[x] EVENT_IF_ACTOR_AT_POSITION
[x] EVENT_SET_TRUE
[x] EVENT_SET_FALSE
[x] EVENT_CHOICE
[x] EVENT_RESET_VARIABLES
[x] EVENT_LOOP
[x] EVENT_GROUP
[x] EVENT_MENU
[x] EVENT_COMMENT

Scripting

[x] EVENT_SET_INPUT_SCRIPT
[ ] EVENT_SET_BACKGROUND_SCRIPT
[ ] EVENT_REMOVE_INPUT_SCRIPT

Math

[x] EVENT_VARIABLE_MATH
[x] EVENT_SET_VALUE
[ ] EVENT_SET_RANDOM_VALUE
[x] EVENT_INC_VALUE
[x] EVENT_DEC_VALUE
[ ] EVENT_MATH_ADD
[ ] EVENT_MATH_SUB
[ ] EVENT_MATH_MUL
[ ] EVENT_MATH_DIV
[ ] EVENT_MATH_MOD
[ ] EVENT_MATH_ADD_VALUE
[ ] EVENT_MATH_SUB_VALUE
[ ] EVENT_MATH_MUL_VALUE
[ ] EVENT_MATH_DIV_VALUE
[ ] EVENT_MATH_MOD_VALUE
[ ] EVENT_COPY_VALUE
[x] EVENT_SET_FLAGS
[x] EVENT_ADD_FLAGS
[x] EVENT_CLEAR_FLAGS
[x] EVENT_IF_FLAGS_COMPARE

Input

[x] EVENT_AWAIT_INPUT

Actors

[x] EVENT_TEXT
[x] EVENT_TEXT_SET_ANIMATION_SPEED
[x] EVENT_ACTOR_SET_DIRECTION
[x] EVENT_ACTOR_SET_DIRECTION_TO_VALUE
[x] EVENT_ACTOR_SET_POSITION
[x] EVENT_ACTOR_SET_POSITION_RELATIVE
[x] EVENT_ACTOR_MOVE_RELATIVE
[ ] EVENT_ACTOR_MOVE_TO
[x] EVENT_ACTOR_PUSH
[x] EVENT_ACTOR_SET_ANIMATION_SPEED
[x] EVENT_ACTOR_SET_MOVEMENT_SPEED
[x] EVENT_ACTOR_EMOTE
[x] EVENT_PLAYER_SET_SPRITE
[x] EVENT_ACTOR_GET_POSITION
[x] EVENT_ACTOR_GET_DIRECTION
[x] EVENT_ACTOR_SET_POSITION_TO_VALUE
[x] EVENT_ACTOR_MOVE_TO_VALUE
[x] EVENT_ACTOR_INVOKE
[x] EVENT_ACTOR_SET_FRAME
[x] EVENT_ACTOR_SET_FRAME_TO_VALUE

Camera

[x] EVENT_CAMERA_MOVE_TO
[x] EVENT_CAMERA_LOCK
[x] EVENT_CAMERA_SHAKE
[x] EVENT_FADE_OUT
[x] EVENT_FADE_IN
[x] EVENT_SHOW_SPRITES
[x] EVENT_HIDE_SPRITES
[x] EVENT_ACTOR_SHOW
[x] EVENT_ACTOR_HIDE

Overlay

[x] EVENT_OVERLAY_SHOW
[x] EVENT_OVERLAY_HIDE
[x] EVENT_OVERLAY_MOVE_TO

Music

[x] EVENT_MUSIC_PLAY
[x] EVENT_MUSIC_STOP

Sound

[ ] EVENT_SOUND_PLAY_BEEP

Custom

[x] EVENT_CALL_CUSTOM_EVENT

22aronl commented 4 years ago

Some Events are missing and unable to be found. Further work is needed

ikarth commented 4 years ago

The GBStudio documentation may be incomplete. We might need to make scripts in GBStudio, save the project, open it as a text file, and see what the data it actually writes is.

22aronl commented 4 years ago

Collisions are missing ie EVENT_ACTOR_COLLISIONS_DISABLE

22aronl commented 4 years ago

Major Bugs to fix

22aronl commented 4 years ago

I found the major bug, It has been patched and will soon be pushed to the main branch

ikarth / game-boy-rom-generator