https://github.com/toasterofbread/godot-utilities

A collection of various nodes and scenes. Note: don't use this, it probably sucks.
https://github.com/toasterofbread/godot-utilities

Last synced: about 2 months ago
JSON representation

A collection of various nodes and scenes. Note: don't use this, it probably sucks.

• Host: GitHub
• URL: https://github.com/toasterofbread/godot-utilities
• Owner: toasterofbread
• Created: 2021-10-21T12:46:34.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-03-16T13:40:41.000Z (about 4 years ago)
• Last Synced: 2025-11-10T23:35:57.402Z (6 months ago)
• Language: GDScript
• Homepage:
• Size: 47.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
# **Godot Utilities**

#### A collection of various nodes and functions

### Nodes:

- **NinePatchRectTextureButton**

  - A combination of a NinePatchRect and a TextureButton, with some extra features like text

- **NodeTrailEmitter**

  - Emits a trail for each added node based on customisable parameters

- **ExPhysicsBodyArea2D**

  - A script intended for use with PhysicsBody2Ds and Area2Ds, with functions for quickly enabling and disabling all collision layers and masks.

- **KinematicBody2DWithArea2D**

  - A KinematicBody2D with an embedded Area2D that shares the same collision shapes

- **CustomDialog**

  - A custom WindowDialog with various additional functionality such as a signal emitted when any action occurs, and a static function to create and display the dialog with a single call.

### Classes:

- **ExArray**

  - A custom array with a limit property and signals emitted when items are added or removed

- **ExTexture**

  - A texture class which allows a texture to be scaled

### Functions (contained in Utils.gd):

- `RandomNumberGenerator` **get_RNG** `( )`

  ​	Returns the RNG object (a RandomNumberGenerator created and randomised on init).

- `Node` **get_anchor** `( )`

  ​	Returns the anchor node (an Node added to the Utils singleton on ready).

- `Node` **get_unique_anchor** `( type: GDScript or GDScriptNativeClass )`

  ​	Creates a new node using [type], adds it to the anchor node, and returns it.

- `void` **sprint** `( items: Array, divider: String = " | ", tprint: bool = false )`

  ​	Prints [items] in a single line with dividers. If [tprint] is true, prints using the tprint function.

   Example: `sprint(["one", 2, "three"])` **->** one | 2 | three

- `void` **tprint** `( msg: Any )`

  ​	Prints [msg] prepended with the current engine time (OS.get_ticks_msec()). Useful for printing every frame.

- `Any` **random_array_item** `( array: Array, rng: RandomNumberGenerator = get_RNG() )`

  ​	Returns a random item from [array] using [rng].

- `Color` **random_colour** `( r: float = NAN, g: float = NAN, b: float = NAN, a: float = NAN, rng: RandomNumberGenerator = get_rng() )`

  ​	Returns a random colour. Individual values can be overridden using [r], [g], [b], and [a].

- `void` **reparent_node** `( node: Node, new_parent: Node, retain_global_position: bool = false )`

  ​	Removes [node] from its parent, then adds it to  [new_parent]. If [retain_global_position] is true, the global_position of [node] will be maintained.

- `Vector2` **to_local** `( position_of: Node, relative_to: Node )`

  ​	Returns the position of [position_of] relative to [relative_to]. Equivalent to Node2D.to_local(), but also works for Control and Spatial nodes.

- `Vector2` **get_node_position** `( node: Node, global: bool = false )`

   Returns the local or [global] position of [node]. [node] must be a Node2D, Control, or Spatial.

- `void` **set_node_position** `( node: Node, global: bool = false )`

   Sets the local or [global] position of the [node]. [node] must be a Node2D, Control, or Spatial.

- `Color` **get_global_modulate** `( node: CanvasItem )`

   Returns the global modulation of [node] (the product of the modulations of the node and all its ancestors). In other words, returns the actual modulation applied to the node when rendered.

- `void` **append_dictionary** `( base: Dictionary, append: Dictionary, duplicate_values: bool = false )`

  ​	Appends [append] onto [base] (values will be overwritten). If [duplicate_values] is true, values that are an array or dictionary will be duplicated.

- `String` **bbcode_colour_text** `( text: String, colour: Color )`

   Returns [text] as a BBCode formatted string with the passed [colour].

- `int` **get_line_of_position** `( string: String, position: int )`

  ​	Returns the line number of [position] within [string].

- `int` **get_position_of_line** `( string: String, line: int )`

  ​	Returns the position of [line] within [string].

- `Array or int (error)` **get_dir_items** `( directory: String (path) or Directory, skip_navigational: bool = true, skip_hidden: bool = true )`

  ​	Returns the items contained in [directory] as an array. May return an int error.

- `JSONParseResult` **load_json** `( path: String )`

  ​	Loads file at [path], parses its contents as JSON, and returns the result.

- `void` **save_json** `( path: String, data, pretty: bool = false )`

  ​	Writes a file at [path] with [data] in JSON format. If [pretty] is true, indentation is added to the file.

- `void` **yield_particle_completion** `( emitter: Node )`

  ​	Yields until [emitter] has stopped emitting, and has no remaining particles. [emitter] must be of type Particles, Particles2D, CPUParticles, or CPUParticles2D.