res://addons/w4gd/game_server/agones_client.gd:Watcher

Inherits: Node

Used to receive realtime updates to the Agones configuration for this game server.

Description

Should be created via res://addons/w4gd/game_server/agones_client.gd.watch_game_server.

Methods

int	get_status ( )
bool	is_error ( )
bool	is_ok ( )
bool	is_running ( )
void	poll ( )
void	start ( )
void	stop ( bool emit_signal )

---

Signals

error ( Variant code )

Emitted when an error has been encountered.

---

received_data ( Variant data )

Emitted when new data has been received.

---

stopped ( )

Emitted when the watcher has stopped.

---

Method Descriptions

int get_status ( )

Gets the current error status. This will be set to OK when everything is working fine, and some other value in the case of an error.

---

bool is_error ( )

Returns true when there is an error; otherwise, false.

---

bool is_ok ( )

Returns true when everything is working fine; otherwise, false.

---

bool is_running ( )

Returns true when running; otherwise, false.

---

void poll ( )

Polls the connection to see if there's any more data available. This should be called automatically every frame.

---

void start ( )

Starts watching for updates.

---

void stop ( bool emit_signal )

Stops watching for updates.