Library Editor Features

[x87]

https://library.sannybuilder.com/

[x87]

List of supported games

Displays a series of icons, one per each game where this command is supported. If the command is not supported (is_unsupported: true) then no game icon is displayed. Hovering an icon shows a hint text.

Icons could be semi-transparent or have an orange border line:

• the orange border signals that the game supports this command, but the number of parameters is different.
• a transparent icon is displayed for games where the command is a nop.

[x87]

Opcode and Command name

Opcodes (command id) and command name are two mandatory elements that should always exist. Both are unique within the given extension. Different extensions may have duplicated command ids or names.

Command Id must have 4 hexadecimal characters and start with 0.
Command name must be in SCREAMING_SNAKE_CASE where all letters are in their capital form and words separated with _. No extra characters allowed. Editor replaces all whitespace characters and - with _

[x87]

Extension Picker

The extension is a mandatory field. Each command must fall in either one of the available extensions. If no extension name provided, the editor uses the default extension named default.

Clicking the arrow button opens the name picker

Entering a name of the extension that does not exist yet creates it. Extension names must be unique and be known to Sanny Builder. Refer to this list https://docs.sannybuilder.com/edit-modes/extensions#extensions-list for allowed names.

[x87]

Class Picker

You can pick the class name by clicking the button left to the input field. In the class name picker you can either choose one of the already available names or enter a new name in the bottom field (same as in the Extension name picker). Only letters and numbers are allowed. The name should be in UpperCamelCase. The editor automatically converts the input string into the required format.

[x87]

Class Member Name

Only letters and numbers are allowed. The name should be in UpperCamelCase. The editor automatically converts the input string into the required format.

[x87]

Short Description

Short description is a single sentence (without the ending period) that tries to highlight the meaning of this command. Do not try to describe everything here. For consistency with other commands start the description with a verb (e.g. Sets, Makes, Removes, etc.). Start conditional commands description with Returns true if or Returns true when.

[x87]

Input Parameters

[x87]

You can reorder rows by dragging a number cell

[x87]

Output Parameters

[x87]

You can reorder rows by dragging a number cell

[x87]

Attributes

Attributes serve to provide extra information about command specifics. The list of attributes is finite. Each command may have one or many attributes, or do not have any.

• is_branch: This command is used to branch the code. Such commands commonly have a label parameter.
• is_condition: This command can be used in conditional statements, e.g. be placed between IF..THEN.
• is_constructor: This command is used to create a new in-game entity, e.g. a vehicle or a pickup.
• is_destructor: This command is used to delete the in-game entity previously created by an is_constructor command
• is_keyword: This command is used as a single keyword followed by arguments. Keywords are part of the language constructs and directly affect the code execution
• is_nop: This command is a no-operation, just eats the arguments
• is_unsupported: This command is unsupported in the given game and its usage is forbidden
• is_overload: This command has multiple variations for different types of arguments
• is_segment: This command is used to separate segments in SCM header. As of now it's only the command jump (opcode 0002)
• is_static: This command operates on a static property or in-game entity that can not be constructed dynamically
• is_variadic: This command has variadic number of arguments, see start_new_script for example

While a command may have multiple attributes, some of them are mutually exclusive. For example, the command can not be is_constructor and is_destructor at the same time. The editor will display an error if the current combination of attributes is forbidden.

[x87]

Code Snippet

[x87]

Control Elements

If there are any unsaved changes, the editor displays the Reset all changes link. Clicking it will revert the command into the initial state.

Close button reverts all changes made to the point and closes the editor.

Save button stores the changes and makes them available for a commit to GitHub, then closes the editor.