Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 1.22 KB

README.md

File metadata and controls

25 lines (16 loc) · 1.22 KB

Godot Utils

A library of utility functions and nodes for the Godot game engine.

Installation

  1. Download and un-zip files.
  2. Place godot_utils-main or equivalent folder into your project's addons folder.
  3. Enable plugin in Projects > Project Settings > Plugins

Documentation

Documentation is embedded within the plugin's scripts. Documentation is most-easily viewed inside the Godot Engine. Shortcut to access documentation of any class: F1 > Search for class name (example: StringUtils).

Usage

Classes

Classes each have their own usage, but most are initialized using the ClassName.new(...) pattern. (ex. PID.new(p_value, i_value, d_value))

Global utilities

Globals are all declared as classes with static functions, and are declared automatically inside Godot, so you can reference the classes with their names just like any other built-in class. (ex. FileUtils.get_files_in_directory("res://addons") )

Singletons

Singletons can be used selectively in a project, by adding them to the autoload list (Project > Project Settings > Autoload) and referenced using the autoload/singleton name assigned (Default naming scheme for singletons is the PascalCase conversion of the filename, ex. PingService)