Extend scripting API

[jbunke]

Change:

• [x] Rename get_frame() and related functions that set or access image objects to get_cel(); deprecate previous name but ensure backwards compatibility
• [x] Change signature of project.color_script(int, bool, bool, string); to project.color_script(int, bool, bool, script);

Add:

New types

• [x] save_config
• [x] script

project

Expressions

• [x] project.get_width() -> int
• [x] project.get_height() -> int
• [x] project.get_layer(string) -> layer - Get layer from its name; returns lowest matching layer, throws runtime error if there is no match

Statements

• [x] project.save_as(save_config); - Throws runtime error if save config is incompatible with this project. For example, saving a subset of frames that is not applicable to the project in question because it is out of range

layer

Expressions

• [x] layer.get_name() -> string

Statements

• [x] layer.set_name(string);

Global namespace ($SE)

Expressions

• [x] $SE.transform(project, script, bool, bool) -> project - Creates a new project by calling a preview script on the first argument project; sets it to the active Stipple Effect project and returns it
• [x] $SE.new_project(int, int, bool) -> project
• [x] $SE.read_script(string) -> script

Constants for enums

• [x] scope
  • $SE.PROJECT
  • $SE.LAYER
  • $SE.FRAME
  • $SE.CEL

Documentation

• [x] Update API documentation
• [x] Add to changelog
• [x] Update VS Code extension to support new types

[jbunke]

save_config

Constructor

• [x] $SE.new_save_config(string[] folder, string filename, int save_type) -> save_config

Setters

• [x] save_config.set_scale_up(int scale_up);
• [x] save_config.set_frames_per_dim(int fpd);
• [x] save_config.set_lower(int lower); - Sets lower frame bound and save mode to bounded
• [x] save_config.set_upper(int upper); - Sets upper frame bound and save mode to bounded
• [x] save_config.set_fps(int fps);
• [x] save_config.unbounded(); - Saves all frames
• [x] save_config.set_save_type(int save_type);
• [x] save_config.set_filename(string name);
• [x] save_config.set_folder(string[] folder);
• [x] save_config.set_prefix(string prefix);
• [x] save_config.set_suffix(string suffix);
• [x] save_config.set_count_from(int count_from);
• [x] save_config.set_dim(bool dim);

Related

• [x] project.get_save_config() -> save_config

[jbunke]

Dimension constants

• [x] $SE.VERT = false
• [x] $SE.HORZ = true