ACS: Difference between revisions
m (Added a link to the List of ACS functions in Zandronum article) |
(Added links for the new ACS functions added in 3.1-alpha. Some functions still need to be documented though.) |
||
| Line 30: | Line 30: | ||
* <code>[[CountDBResults]]</code> | * <code>[[CountDBResults]]</code> | ||
* <code>[[EndDBTransaction]]</code> | * <code>[[EndDBTransaction]]</code> | ||
* <code>[[ExecuteClientScript]]</code> {{Devfeature|3.1|alpha}} | |||
* <code>[[FreeDBResults]]</code> | * <code>[[FreeDBResults]]</code> | ||
* <code>[[GameType]]</code> | * <code>[[GameType]]</code> | ||
* <code>[[GetChatMessage]]</code> {{Devfeature|3.1|alpha}} | |||
* <code>[[GetCurrentGameMode]]</code> {{Devfeature|3.1|alpha}} | |||
* <code>[[GetDBEntries]]</code> | * <code>[[GetDBEntries]]</code> | ||
* <code>[[GetDBEntry]]</code> | * <code>[[GetDBEntry]]</code> | ||
| Line 42: | Line 45: | ||
* <code>[[GetInvasionState]]</code> | * <code>[[GetInvasionState]]</code> | ||
* <code>[[GetInvasionWave]]</code> | * <code>[[GetInvasionWave]]</code> | ||
* <code>[[GetMapRotationInfo]]</code> {{Devfeature|3.1|alpha}} | |||
* <code>[[GetMapRotationSize]]</code> {{Devfeature|3.1|alpha}} | |||
* <code>[[GetPlayerAccountName]]</code> | * <code>[[GetPlayerAccountName]]</code> | ||
* <code>[[GetPlayerChasecam]]</code> {{Devfeature|3.1|alpha}} | |||
* <code>[[GetPlayerLivesLeft]]</code> | * <code>[[GetPlayerLivesLeft]]</code> | ||
* <code>[[GetPlayerScore]]</code> {{Devfeature|3.1|alpha}} | |||
* <code>[[GetTeamProperty]]</code> | * <code>[[GetTeamProperty]]</code> | ||
* <code>[[GetTimeProperty]]</code> | * <code>[[GetTimeProperty]]</code> | ||
* <code>[[IncrementDBEntry]]</code> | * <code>[[IncrementDBEntry]]</code> | ||
* <code>[[InDemoMode]]</code> {{Devfeature|3.1|alpha}} | |||
* <code>[[IsNetworkGame|IsMultiplayer]]</code> | * <code>[[IsNetworkGame|IsMultiplayer]]</code> | ||
* <code>[[IsOneFlagCTF]]</code> | * <code>[[IsOneFlagCTF]]</code> | ||
* <code>[[KickFromGame]]</code> | * <code>[[KickFromGame]]</code> | ||
* <code>[[ExecuteClientScript|NamedExecuteClientScript]]</code> {{Devfeature|3.1|alpha}} | |||
* <code>[[RequestScriptPuke|NamedRequestScriptPuke]]</code> | * <code>[[RequestScriptPuke|NamedRequestScriptPuke]]</code> | ||
* <code>[[SendNetworkString|NamedSendNetworkString]]</code> {{Devfeature|3.1|alpha}} | |||
* <code>[[Player_SetTeam]]</code> | * <code>[[Player_SetTeam]]</code> | ||
* <code>[[PlayerArmorpoints]]</code> | * <code>[[PlayerArmorpoints]]</code> | ||
| Line 59: | Line 69: | ||
* <code>[[RequestScriptPuke]]</code> | * <code>[[RequestScriptPuke]]</code> | ||
* <code>[[ResetMap]]</code> | * <code>[[ResetMap]]</code> | ||
* <code>[[SendNetworkString]]</code> {{Devfeature|3.1|alpha}} | |||
* <code>[[SetActivatorToPlayer]]</code> | * <code>[[SetActivatorToPlayer]]</code> | ||
* <code>[[SetCurrentGameMode]]</code> {{Devfeature|3.1|alpha}} | |||
* <code>[[SetDBEntry]]</code> | * <code>[[SetDBEntry]]</code> | ||
* <code>[[SetDBEntryString]]</code> | * <code>[[SetDBEntryString]]</code> | ||
* <code>[[SetDeadSpectator]]</code> | * <code>[[SetDeadSpectator]]</code> | ||
* <code>[[SetGameModeLimit]]</code> {{Devfeature|3.1|alpha}} | |||
* <code>[[SetPlayerChasecam]]</code> {{Devfeature|3.1|alpha}} | |||
* <code>[[SetPlayerClass]]</code> {{Devfeature|3.1|alpha}} | |||
* <code>[[SetPlayerLivesLeft]]</code> | * <code>[[SetPlayerLivesLeft]]</code> | ||
* <code>[[SetPlayerScore]]</code> {{Devfeature|3.1|alpha}} | |||
* <code>[[SortDBEntries]]</code> | * <code>[[SortDBEntries]]</code> | ||
* <code>[[Strftime]]</code> | * <code>[[Strftime]]</code> | ||
Revision as of 14:03, 26 September 2021
This is an incomplete list of Zandronum-only ACS functions and extensions. See 
here for a list of ZDoom-supported ACS functions.
For a list of all the ACS functions supported by Zandronum, click here.
Features
Zandronum supports databases, powered by SQLite.
Script Types
EVENT scripts are executed when specific game events occur.
There are additional script types that can be appended to regular script types:
NETscripts are server-side and can be executed by clients using the puke command.CLIENTSIDEscripts client-side and can not be executed by the puke command.NET CLIENTSIDEscripts are client-side and can be executed by the puke command.
In this example, when someone picks up the enemy item it will start this script on the Client side:
Script 1 PICKUP CLIENTSIDE
{
Print(s:"Someone got the flag!");
}
It is worth reading Clientside Scripting if you intend on using CLIENTSIDE scripts.
ACS Functions
AnnouncerSoundBeginDBTransactionConsoleCommandConsolePlayerNumberCountDBResultsEndDBTransactionExecuteClientScript(development version 3.1-alpha and above only)FreeDBResultsGameTypeGetChatMessage(development version 3.1-alpha and above only)GetCurrentGameMode(development version 3.1-alpha and above only)GetDBEntriesGetDBEntryGetDBEntryRankGetDBEntryStringGetDBResultKeyStringGetDBResultValueGetDBResultValueStringGetGameModeStateGetInvasionStateGetInvasionWaveGetMapRotationInfo(development version 3.1-alpha and above only)GetMapRotationSize(development version 3.1-alpha and above only)GetPlayerAccountNameGetPlayerChasecam(development version 3.1-alpha and above only)GetPlayerLivesLeftGetPlayerScore(development version 3.1-alpha and above only)GetTeamPropertyGetTimePropertyIncrementDBEntryInDemoMode(development version 3.1-alpha and above only)IsMultiplayerIsOneFlagCTFKickFromGameNamedExecuteClientScript(development version 3.1-alpha and above only)NamedRequestScriptPukeNamedSendNetworkString(development version 3.1-alpha and above only)Player_SetTeamPlayerArmorpointsPlayerHealthPlayerIsLoggedInPlayerIsSpectatorPlayerTeamRequestScriptPukeResetMapSendNetworkString(development version 3.1-alpha and above only)SetActivatorToPlayerSetCurrentGameMode(development version 3.1-alpha and above only)SetDBEntrySetDBEntryStringSetDeadSpectatorSetGameModeLimit(development version 3.1-alpha and above only)SetPlayerChasecam(development version 3.1-alpha and above only)SetPlayerClass(development version 3.1-alpha and above only)SetPlayerLivesLeftSetPlayerScore(development version 3.1-alpha and above only)SortDBEntriesStrftimeSystemTimeTeam_GivePointsTeam_ScoreTeleport_NoStop
Deprecated
These functions are deprecated. They still work, but will be removed eventually. It is recommended you use more up to date functions.
BlueCount(deprecated, seeGetTeamProperty)BlueScore(deprecated, seeGetTeamProperty)GetTeamScore(deprecated, seeGetTeamProperty)Music_Change(deprecated, seeRedCount(deprecated, seeGetTeamProperty)RedScore(deprecated, seeGetTeamProperty)SinglePlayer(deprecated, seeGameType)BlueTeamCount(deprecated, seeGetTeamProperty)BlueTeamScore(deprecated, seeGetTeamProperty)RedTeamCount(deprecated, seeGetTeamProperty)RedTeamScore(deprecated, seeGetTeamProperty)