Goonstation 13 - Modules - TypesDefine Details

_std/tgs.dm

TGS_DEFINE_AND_SET_GLOBALCreate a global variable named Name and set it to Value.
TGS_READ_GLOBALRead the value in the global variable Name.
TGS_WRITE_GLOBALSet the value in the global variable Name to Value.
TGS_WORLD_ANNOUNCEDisplay an announcement message from the server to all players.
TGS_NOTIFY_ADMINSNotify current in-game administrators of a string event.
TGS_INFO_LOGWrite an info message to a server log.
TGS_WARNING_LOGWrite an warning message to a server log.
TGS_ERROR_LOGWrite an error message to a server log.
TGS_PROTECT_DATUMDisallow ANYONE from reflecting a given path, security measure to prevent in-game use of DD -> TGS capabilities. - haha no
TGS_CLIENT_COUNTGet the number of connected /clients.
TGS_EVENT_REBOOT_MODE_CHANGEBefore a reboot mode change, extras parameters are the current and new reboot mode enums
TGS_EVENT_PORT_SWAPBefore a port change is about to happen, extra parameters is new port
TGS_EVENT_INSTANCE_RENAMEDBefore the instance is renamed, extra parameter is the new name
TGS_EVENT_WATCHDOG_REATTACHAfter the watchdog reattaches to DD, extra parameter is the new /datum/tgs_version of the server
TGS_EVENT_REPO_RESET_ORIGINWhen the repository is reset to its origin reference. Parameters: Reference name, Commit SHA
TGS_EVENT_REPO_CHECKOUTWhen the repository performs a checkout. Parameters: Checkout git object
TGS_EVENT_REPO_FETCHWhen the repository performs a fetch operation. No parameters
TGS_EVENT_REPO_MERGE_PULL_REQUESTWhen the repository test merges. Parameters: PR Number, PR Sha, (Nullable) Comment made by TGS user
TGS_EVENT_REPO_PRE_SYNCHRONIZEBefore the repository makes a sychronize operation. Parameters: Absolute repostiory path
TGS_EVENT_BYOND_INSTALL_STARTBefore a BYOND install operation begins. Parameters: /datum/tgs_version of the installing BYOND
TGS_EVENT_BYOND_INSTALL_FAILWhen a BYOND install operation fails. Parameters: Error message
TGS_EVENT_BYOND_ACTIVE_VERSION_CHANGEWhen the active BYOND version changes. Parameters: (Nullable) /datum/tgs_version of the current BYOND, /datum/tgs_version of the new BYOND
TGS_EVENT_COMPILE_STARTWhen the compiler starts running. Parameters: Game directory path, origin commit SHA
TGS_EVENT_COMPILE_CANCELLEDWhen a compile is cancelled. No parameters
TGS_EVENT_COMPILE_FAILUREWhen a compile fails. Parameters: Game directory path, [TRUE]/[FALSE] based on if the cause for failure was DMAPI validation
TGS_EVENT_COMPILE_COMPLETEWhen a compile operation completes. Note, this event fires before the new .dmb is loaded into the watchdog. Consider using the TGS_EVENT_DEPLOYMENT_COMPLETE instead. Parameters: Game directory path
TGS_EVENT_INSTANCE_AUTO_UPDATE_STARTWhen an automatic update for the current instance begins. No parameters
TGS_EVENT_REPO_MERGE_CONFLICTWhen the repository encounters a merge conflict: Parameters: Base SHA, target SHA, base reference, target reference
TGS_EVENT_DEPLOYMENT_COMPLETEWhen a deployment completes. No Parameters
TGS_EVENT_WATCHDOG_SHUTDOWNBefore the watchdog shuts down. Not sent for graceful shutdowns. No parameters.
TGS_EVENT_WATCHDOG_DETACHBefore the watchdog detaches for a TGS update/restart. No parameters.
TGS_EVENT_WORLD_PRIMEWatchdog event when TgsInitializationComplete() is called. No parameters.
TGS_REBOOT_MODE_NORMALThe server will reboot normally.
TGS_REBOOT_MODE_SHUTDOWNThe server will stop running on reboot.
TGS_REBOOT_MODE_RESTARTThe watchdog will restart on reboot.
TGS_SECURITY_TRUSTEDDreamDaemon Trusted security level.
TGS_SECURITY_SAFEDreamDaemon Safe security level.
TGS_SECURITY_ULTRASAFEDreamDaemon Ultrasafe security level.
TGS_TOPICPut this at the start of /world/proc/Topic.
/datum/tgs_revision_informationRepresents git revision information.
/datum/tgs_versionRepresents a version.
/datum/tgs_revision_information/test_mergeRepresents a merge of a GitHub pull request.
/datum/tgs_chat_channelRepresents a connected chat channel.
/datum/tgs_chat_commandUser definable chat command

Define Details

TGS_CLIENT_COUNT

Get the number of connected /clients.

TGS_DEFINE_AND_SET_GLOBAL

Create a global variable named Name and set it to Value.

TGS_ERROR_LOG

Write an error message to a server log.

TGS_EVENT_BYOND_ACTIVE_VERSION_CHANGE

When the active BYOND version changes. Parameters: (Nullable) /datum/tgs_version of the current BYOND, /datum/tgs_version of the new BYOND

TGS_EVENT_BYOND_INSTALL_FAIL

When a BYOND install operation fails. Parameters: Error message

TGS_EVENT_BYOND_INSTALL_START

Before a BYOND install operation begins. Parameters: /datum/tgs_version of the installing BYOND

TGS_EVENT_COMPILE_CANCELLED

When a compile is cancelled. No parameters

TGS_EVENT_COMPILE_COMPLETE

When a compile operation completes. Note, this event fires before the new .dmb is loaded into the watchdog. Consider using the TGS_EVENT_DEPLOYMENT_COMPLETE instead. Parameters: Game directory path

TGS_EVENT_COMPILE_FAILURE

When a compile fails. Parameters: Game directory path, [TRUE]/[FALSE] based on if the cause for failure was DMAPI validation

TGS_EVENT_COMPILE_START

When the compiler starts running. Parameters: Game directory path, origin commit SHA

TGS_EVENT_DEPLOYMENT_COMPLETE

When a deployment completes. No Parameters

TGS_EVENT_INSTANCE_AUTO_UPDATE_START

When an automatic update for the current instance begins. No parameters

TGS_EVENT_INSTANCE_RENAMED

Before the instance is renamed, extra parameter is the new name

TGS_EVENT_PORT_SWAP

Before a port change is about to happen, extra parameters is new port

TGS_EVENT_REBOOT_MODE_CHANGE

Before a reboot mode change, extras parameters are the current and new reboot mode enums

TGS_EVENT_REPO_CHECKOUT

When the repository performs a checkout. Parameters: Checkout git object

TGS_EVENT_REPO_FETCH

When the repository performs a fetch operation. No parameters

TGS_EVENT_REPO_MERGE_CONFLICT

When the repository encounters a merge conflict: Parameters: Base SHA, target SHA, base reference, target reference

TGS_EVENT_REPO_MERGE_PULL_REQUEST

When the repository test merges. Parameters: PR Number, PR Sha, (Nullable) Comment made by TGS user

TGS_EVENT_REPO_PRE_SYNCHRONIZE

Before the repository makes a sychronize operation. Parameters: Absolute repostiory path

TGS_EVENT_REPO_RESET_ORIGIN

When the repository is reset to its origin reference. Parameters: Reference name, Commit SHA

TGS_EVENT_WATCHDOG_DETACH

Before the watchdog detaches for a TGS update/restart. No parameters.

TGS_EVENT_WATCHDOG_REATTACH

After the watchdog reattaches to DD, extra parameter is the new /datum/tgs_version of the server

TGS_EVENT_WATCHDOG_SHUTDOWN

Before the watchdog shuts down. Not sent for graceful shutdowns. No parameters.

TGS_EVENT_WORLD_PRIME

Watchdog event when TgsInitializationComplete() is called. No parameters.

TGS_INFO_LOG

Write an info message to a server log.

TGS_NOTIFY_ADMINS

Notify current in-game administrators of a string event.

TGS_PROTECT_DATUM

Disallow ANYONE from reflecting a given path, security measure to prevent in-game use of DD -> TGS capabilities. - haha no

TGS_READ_GLOBAL

Read the value in the global variable Name.

TGS_REBOOT_MODE_NORMAL

The server will reboot normally.

TGS_REBOOT_MODE_RESTART

The watchdog will restart on reboot.

TGS_REBOOT_MODE_SHUTDOWN

The server will stop running on reboot.

TGS_SECURITY_SAFE

DreamDaemon Safe security level.

TGS_SECURITY_TRUSTED

DreamDaemon Trusted security level.

TGS_SECURITY_ULTRASAFE

DreamDaemon Ultrasafe security level.

TGS_TOPIC

Put this at the start of /world/proc/Topic.

TGS_WARNING_LOG

Write an warning message to a server log.

TGS_WORLD_ANNOUNCE

Display an announcement message from the server to all players.

TGS_WRITE_GLOBAL

Set the value in the global variable Name to Value.