Represents a script brush in the script window.
- add_bool_tag
- add_description
- add_int_tag
- add_null_tag
- add_real_tag
- add_string_list_tag
- add_string_tag
- get_name
- set_name
+ new script_brush(): script_brush
Returns: script_brush
• on_left_click: callback<(brush: script_brush, event: script_brush_event) => void>
The function to call when the user left clicks the world with this brush
• on_left_hold: callback<(brush: script_brush, event: script_brush_event) => void>
The funciton to call when the user holds the left mouse button in the world with this brush
• on_left_release: callback<(brush: script_brush, event: script_brush_event) => void>
The function to call when the user releases the left moues button in the world with this brush
• on_right_click: callback<(brush: script_brush, event: script_brush_event) => void>
The function to call when the user right clicks the world with this brush
• on_right_hold: callback<(brush: script_brush, event: script_brush_event) => void>
The funciton to call when the user holds the right mouse button in the world with this brush
• on_right_release: callback<(brush: script_brush, event: script_brush_event) => void>
The function to call when the user releases the right mouse button in the world with this brush
▸ add_bool_tag(item: string, def: boolean): tag<boolean>
Adds a bool tag to the settings panel
| Name | Type |
|---|---|
item |
string |
def |
boolean |
Returns: tag<boolean>
▸ add_description(text: string): any
Adds a description row to the brush window
| Name | Type |
|---|---|
text |
string |
Returns: any
▸ add_int_tag(item: string, low: number, high: number, def: number): tag<number>
Adds an integer tag to the settings panel
| Name | Type |
|---|---|
item |
string |
low |
number |
high |
number |
def |
number |
Returns: tag<number>
▸ add_null_tag(): any
Adds an empty tag, typically used to create empty lines in the settings panel
Returns: any
▸ add_real_tag(item: string, low: number, high: number, def: number): tag<number>
Adds a real (i.e. float) tag to the settings panel
| Name | Type |
|---|---|
item |
string |
low |
number |
high |
number |
def |
number |
Returns: tag<number>
▸ add_string_list_tag(item: string, ...values: string[]): tag<string>
Adds a dropdown menu to the settings panel
| Name | Type |
|---|---|
item |
string |
...values |
string[] |
Returns: tag<string>
▸ add_string_tag(item: string, def: string): tag<string>
Adds a string tag to the settings panel
| Name | Type |
|---|---|
item |
string |
def |
string |
Returns: tag<string>
▸ get_name(): string
Returns the current name of this script brush
Returns: string
▸ set_name(name: string): void
Changes the name of this script brush
| Name | Type |
|---|---|
name |
string |
Returns: void