daftlib-gdscript

A collection of commonly used utility classes and data structures.

Usage Example

Queue loader

var ql = QueueLoader.new()
ql.progress.connect(onProgress)
ql.complete.connect(onComplete)
ql.addItem("res://assets/art/enemyFlyingAlt_1.png")
ql.addItem("res://assets/art/enemyFlyingAlt_2.png")
ql.addItem("res://assets/art/enemySwimming_1.png")
ql.addItem("res://assets/art/enemySwimming_2.png")
ql.addItem("res://assets/art/enemyWalking_1.png")
ql.addItem("res://assets/art/enemyWalking_2.png")
ql.addItem("res://assets/art/House In a Forest Loop.ogg")
ql.start()
self.add_child(ql)

func onComplete():
	$Sprite2D.texture = ql.getItem("res://assets/art/enemyWalking_2.png")

func onProgress(percent):
	print(percent)

Transition Sprite

var imageTexture:ImageTexture = null
imageTexture = DisplayObjectUtil.getScreenShotImageTexture(self)

var duration = 0.5
var sprite:TransitionSprite = TransitionSprite.new()
sprite.type = TransitionSprite.Type.FADE
sprite.direction = TransitionSprite.Direction.OUT
sprite.duration = duration
sprite.shader_pattern_path = "res://shader_images/squares.png"
sprite.texture = imageTexture if duration > 0 else null
self.add_child(sprite)

var scale = DisplayObjectUtil.getCorrectionForAspectRatio(imageTexture)
sprite.scale = scale

sprite.complete.connect(_onTransComplete)

Simplify usage of UDP, and implemented heartbeat protocol

# Server side
var server:UDPServerController = UDPServerController.new()
server.message.connect(_onClientMessage)
self.add_child(server)

func _onClientMessage(content:String):
	_append_text(content)

# Client side
var client:UDPClient = UDPClient.new()
client.message.connect(_onServerMessage)
self.add_child(client)

func _onServerMessage(content:String):
	print(content)

func _sendMessageToServer(content:String):
	client.send_package(content)

Address

var address:Address = Address.new()
address.change.connect(on_address_change)
address.setValue("/learn/")
address.setValue("")
address.setValue("/blog/articles/godot")
address.up()
address.setValue("contact")
address.setValue("news")
address.back()
address.setValue("/about")
address.forward()
address.back()

func on_address_change(value):
	print(value)

Scenes Navigator

{
	"scenes": [
		{
			"id": "scene1",
			"packed_res": "res://assets/scenes/scene1.tscn",
			"music": "",
			"dialogues": []
		},
		{
			"id": "scene2",
			"packed_res": "res://assets/scenes/scene2.tscn",
			"music": "",
			"dialogues": []
		},
		{
			"id": "scene3",
			"packed_res": "res://assets/scenes/scene3.tscn",
			"music": "",
			"dialogues": []
		}
	]
}

# Add Navigator as Autoload
for item in data.scenes:
	var sceneId:String = item.get("id")
	Navigator.link(sceneId, item)
Navigator.change.connect(onSceneChange)
Navigator.finished.connect(onAllSceneFinished)
Navigator.first()

func onSceneChange(_id:String, data:Dictionary):
	var scene = load(data.get("packed_res")).instantiate()
	self.addChild(scene)

MP3Player

# Add MP3PLayer as Autoload
MP3Player.playMusic("res://music/title.mp3")
MP3Player.playSound("res://sound/hit.mp3")
MP3Player.stopAll()
SoundUtil.setVolumeForBus(MP3Player.MUSIC, -10)

SpineCanvas

var canvas:SpineCanvas = %SpineCanvas
print(canvas.getAnimationNames())
canvas.audio.connect(MP3Player.playSound)
canvas.playAnimation()

GameState

GameState.change.connect(onStateChange)
GameState.current = GameState.TRANSITIONING
GameState.current = GameState.GAME_PLAYING
func onStateChange(_current:String, _previous:String):
	print("GameState: ", _current, "PreviousState: ", _previous)

SignalManager

# Add SignalManager as Autoload
SignalManager.connectSignal(btn.pressed, _listenerA)
SignalManager.connectSignal(btn.pressed, _listenerB)
SignalManager.connectSignal(btn.pressed, _listenerC.bind(args))
SignalManager.disconnectAllForSignal(btn.pressed)

Game Config

# Add Config as Autoload
Config.add(VolumeControl.new(%vol_slider_1, MP3Player.MASTER))
Config.add(VolumeControl.new(%vol_slider_2, MP3Player.MUSIC))
Config.add(VolumeControl.new(%vol_slider_3, MP3Player.SOUND))
Config.add(FullscreenControl.new(%checkbox))
Config.add(LanguageControl.new(%option_button, ["en", "ja", "fr"]))
Config.loadConfig()

%apply_button.pressed.connect(_on_setting_apply)

func _on_setting_apply():
	Config.save()

Game Save

# Add Saver as Autoload

var save_resource:CustomResource = CustomResource.new()

# create a new gamesave
Saver.save(save_resource, DisplayObjectUtil.getScreenShotImage(%game_node))

# overwrite exist gamesave
Saver.overwrite("2023-06-30T21.28.40_4694A", save_resource, DisplayObjectUtil.getScreenShotImage(%game_node))

# create a new autosave
Saver.autosave(save_resource, DisplayObjectUtil.getScreenShotImage(%game_node))

# load an exist gamesave
save_resource = Saver.loadSave("2023-06-30T21.28.40_4694A")

# load thumbnail for gamesave
var image_texture := Saver.loadThumb("2023-06-30T21.28.40_4694A")

# load newest gamesave
save_resource = Saver.loadLatestSave()

# load newest autosave
save_resource = Saver.loadLatestAutosave()

# get all manual gamesave
print(Saver.getSaveSlots())

# get all autosave
print(Saver.getAutosaveSlots())

# get all save
print(Saver.getAllSaveSlots())

# there is an exist save or not
print(Saver.hasSave())

# delete an exist gamesave
deleteSaveAndThumb("2023-06-30T21.28.40_4694A")

# get formated time string from filename, return as YYYY-MM-DD HH:MM:SS
print(Saver.getTimeString("2023-06-30T21.28.40_4694A"))