basic utility scripts

Author: TinyTakinTeller

README.md

@@ -71,7 +71,9 @@
 - **Persistence Manager**
 	- TODO
 
-## 💎 Globals
+## 🤖 Code
+
+### 💎 Globals
 
 - **Configuration**
 	- Configure Plugins & Project depending on environment.
@@ -86,7 +88,7 @@
 - **Wrapper**
 	- **SceneManagerWrapper** - call SceneManager with options presets Resource.
 
-## 🎬 Scenes
+### 🎬 Scenes
 
 - **BootSplash**
 	- Main Scene, smoothly transitions from boot to true main scene.
@@ -97,6 +99,14 @@
 - **OptionsMenu**
 	- TODO
 
+### 📄 Scripts
+
+- **FileSystemUtils**
+- **MathUtils**
+- **NodeUtils**
+- **RandomUtils**
+
+
 ## 🚀 Deployment
 
 - **TODO**

godot/autoload/reference/reference.gd

@@ -6,19 +6,18 @@ var _resource_references: Dictionary = {}
 
 
 func get_scene_manager_options(resource_name: String) -> SceneManagerOptions:
-	var key: String = _get_key(resource_name, SceneManagerOptions)
+	return _get_resource(resource_name, SceneManagerOptions)
+
+
+func _get_resource(resource_name: String, type: Variant) -> Resource:
+	var key: String = _get_key(resource_name, type)
 	return _resource_references[key]
 
 
 func _ready() -> void:
 	Log.debug("AUTOLOAD READY: ", name)
 
-	_init()
-
-
-func _init() -> void:
-	var root_path: String = PathConsts.RESOURCES
-	var paths: Array[String] = FileSystemUtils.get_paths(root_path, RESOURCE_EXTENSION)
+	var paths: Array[String] = FileSystemUtils.get_paths(PathConsts.RESOURCES, RESOURCE_EXTENSION)
 	_resource_references = _load_resources(paths)
 
 

godot/scripts/consts/charset_consts.gd

@@ -0,0 +1,9 @@
+class_name CharsetConsts
+
+const DIGITS: String = "0123456789"
+const LOWERCASE: String = "abcdefghijklmnopqrstuvwxyz"
+const UPPERCASE: String = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+const LETTERS: String = LOWERCASE + UPPERCASE
+const USERNAME: String = LETTERS + DIGITS
+const SPECIAL: String = " !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~"
+const ASCII: String = USERNAME + SPECIAL

godot/scripts/utils/file_system_utils.gd

@@ -7,8 +7,8 @@ const EXTENSION_SEPARATOR = "."
 ## Converts full file path to file name, removing the path prefix and the extension suffix.
 static func get_file_name(path: String) -> String:
 	var parts: PackedStringArray = path.split(PATH_SEPARATOR)
-	var output: String = parts[parts.size() - 1]
-	return output.split(EXTENSION_SEPARATOR)[0]
+	var file_name: String = parts[parts.size() - 1]
+	return file_name.split(EXTENSION_SEPARATOR)[0]
 
 
 ## Returns full file paths of all files under path, with given extension.

godot/scripts/utils/math_utils.gd

@@ -0,0 +1,14 @@
+class_name MathUtils
+
+
+## integer power (edge cases in order: 0^x = 0, 1^x = 0, x^0 = 1)
+static func pow_int(base: int, exponent: int) -> int:
+	if base == 0 or exponent < 0:
+		return 0
+	if base == 1 or exponent == 0:
+		return 1
+
+	var result: int = 1
+	for i: int in range(exponent):
+		result *= base
+	return result

godot/scripts/utils/node_utils.gd

@@ -0,0 +1,70 @@
+class_name NodeUtils
+
+
+## remove child from node
+static func remove_child(node: Node, child: Node) -> void:
+	node.remove_child(child)
+	child.queue_free()
+
+
+## remove all children of given node
+static func remove_children(node: Node) -> void:
+	for child: Node in node.get_children():
+		remove_child(node, child)
+
+
+## remove all children of given node with given type
+static func remove_children_of(node: Node, type: Variant) -> void:
+	for child: Node in node.get_children():
+		if is_instance_of(child, type):
+			remove_child(node, child)
+
+
+## remove child of given node at given index (allows large and negative index, looping around)
+static func remove_child_at(parent: Node, index: int) -> void:
+	index = index % parent.get_child_count()
+	var child: Node = parent.get_child(index)
+	parent.remove_child(child)
+	child.queue_free()
+
+
+## remove last child of given node
+static func remove_child_back(parent: Node) -> void:
+	remove_child_at(parent, -1)
+
+
+## remove first child of given node
+static func remove_child_front(parent: Node) -> void:
+	remove_child_at(parent, 0)
+
+
+## add child to given node to last spot
+static func add_child_back(child: Node, parent: Node) -> void:
+	parent.add_child(child)
+
+
+## add child to given node to first spot
+static func add_child_front(child: Node, parent: Node) -> void:
+	parent.add_child(child)
+	parent.move_child(child, 0)
+
+
+## add child to given node such that children remain sorted (assumes children are sorted before add)
+static func add_child_sorted(child: Node, parent: Node, compare_func: Callable) -> void:
+	parent.add_child(child)
+	var children: Array[Node] = parent.get_children()
+	if children.size() == 0:
+		return
+	var position: int = children.bsearch_custom(child, compare_func)
+	parent.move_child(child, position)
+
+
+## returns active theme of control node (control nodes inheirt parent theme if theirs is null)
+static func get_inherited_theme(control: Node) -> Resource:
+	var theme: Resource = null
+	while (control != null) and ("theme" in control):
+		theme = control.theme
+		if theme != null:
+			break
+		control = control.get_parent()
+	return theme

godot/scripts/utils/random_utils.gd

@@ -0,0 +1,29 @@
+class_name RandomUtils
+
+
+## Given a dictionary, return random string key weighted by corresponding int values.
+## Example: {"gold": 10, "silver": 20, "copper": 70} has 20% chance to return "silver"
+## If weight_sum is not provided, it will be calculated.
+static func random_weighted_item(item_weight_dict: Dictionary, weight_sum: int = 0) -> String:
+	if weight_sum <= 0:
+		weight_sum = get_weights_sum(item_weight_dict)
+	var roll: int = randi() % weight_sum
+	for item: String in item_weight_dict:
+		var weight: int = item_weight_dict[item]
+		if roll < weight:
+			return item
+		roll -= weight
+	return item_weight_dict[item_weight_dict.size() - 1]
+
+
+## Use this to (re)calculate weight_sum only after dictionary is modified to optimize performance.
+static func get_weights_sum(item_weight_dict: Dictionary) -> int:
+	return item_weight_dict.values().reduce(func(x: int, n: int) -> int: return x + n, 0)
+
+
+## Generate random string of given length and charset. (Default charset is ASCII.)
+func random_string(length: int, charset: String = CharsetConsts.ASCII) -> String:
+	var result: String = ""
+	for i: int in range(length):
+		result += charset[randi() % charset.length()]
+	return result