TownSdkClient

Inherits: Object

Client wrapper that connects the Blazium engine to a TownServer instance over ENet.

Description

TownSdkClient owns the low-level C++ SDK, exposes it to GDScript and GDNative, and emits signals for all incoming events from the server. The module instantiates a singleton automatically during engine startup, which can be retrieved through TownSdkClient.get_singleton() or Engine.get_singleton("TownSDK"). Call poll() once per frame (e.g. from _process()) to keep the client responsive.

Methods

void	admin_broadcast(message: String, is_alert: bool = false)
void	admin_kick(username: String, reason: String = "")
void	admin_reload(scope: String)
void	admin_stats_request()
void	authenticate(jwt_token: String)
void	battle_action(battle_id: String, action: BattleAction, target_id: String = "")
void	clear_debug_log()
bool	connect_to_server(address: String, port: int)
void	disconnect_from_server()
void	enter_region(region_id: String)
PackedStringArray	get_debug_log() const
String	get_last_error_message() const
String	get_last_info_message() const
String	get_last_warning_message() const
String	get_server_version() const
TownSdkClient	get_singleton() static
bool	is_client_connected() const
bool	is_debug_logging_enabled() const
void	leave_battle(battle_id: String)
void	leave_region()
void	manual_reconnect()
void	poll(delta: float)
void	send_move(held: int, delta: float)
void	set_auto_reconnect(enabled: bool)
void	set_debug_logging_enabled(enabled: bool, history_limit: int = 64)

Signals

admin_broadcast_received(payload: Dictionary) 🔗

There is currently no description for this signal. Please help us by contributing one!

admin_kick_received(payload: Dictionary) 🔗

There is currently no description for this signal. Please help us by contributing one!

admin_reload_received(payload: Dictionary) 🔗

There is currently no description for this signal. Please help us by contributing one!

admin_stats_received(payload: Dictionary) 🔗

There is currently no description for this signal. Please help us by contributing one!

battle_end(battle: Dictionary) 🔗

There is currently no description for this signal. Please help us by contributing one!

battle_indicator_despawn(indicator: Dictionary) 🔗

There is currently no description for this signal. Please help us by contributing one!

battle_indicator_spawn(indicator: Dictionary) 🔗

There is currently no description for this signal. Please help us by contributing one!

battle_log(log: String) 🔗

There is currently no description for this signal. Please help us by contributing one!

battle_start(battle: Dictionary) 🔗

There is currently no description for this signal. Please help us by contributing one!

battle_state(state: Dictionary) 🔗

There is currently no description for this signal. Please help us by contributing one!

connected() 🔗

There is currently no description for this signal. Please help us by contributing one!

connection_failed() 🔗

There is currently no description for this signal. Please help us by contributing one!

disconnected(reason: String) 🔗

There is currently no description for this signal. Please help us by contributing one!

error(message: String) 🔗

There is currently no description for this signal. Please help us by contributing one!

move_state(state: Dictionary) 🔗

There is currently no description for this signal. Please help us by contributing one!

reconnect_failed(reason: String) 🔗

There is currently no description for this signal. Please help us by contributing one!

reconnected(resume_state: Variant) 🔗

There is currently no description for this signal. Please help us by contributing one!

reconnecting(attempt: int, next_delay: float) 🔗

There is currently no description for this signal. Please help us by contributing one!

snapshot_received(snapshot: Dictionary) 🔗

There is currently no description for this signal. Please help us by contributing one!

Enumerations

enum BattleAction: 🔗

BattleAction ACTION_ATTACK = 0

There is currently no description for this enum. Please help us by contributing one!

BattleAction ACTION_BLOCK = 1

There is currently no description for this enum. Please help us by contributing one!

BattleAction ACTION_DEFEND = 2

There is currently no description for this enum. Please help us by contributing one!