ACS: Difference between revisions

1,770 bytes added ,  16 March
m
Added GetPlayerCountry
m (Added a link to the List of ACS functions in Zandronum article)
m (Added GetPlayerCountry)
Tag: Source edit
 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This is an '''incomplete''' list of Zandronum-'''only''' ACS functions and extensions. See {{zdw2|Built-in_ACS_functions|here}} for a list of ZDoom-supported ACS functions.  
This is a list of Zandronum-'''only''' ACS functions and extensions. See {{zdw2|Built-in_ACS_functions|here}} for a list of ZDoom-supported ACS functions.  


For a list of all the ACS functions supported by Zandronum, [[List of ACS functions in Zandronum|click here]].
For a list of all the ACS functions supported by Zandronum, [[List of ACS functions in Zandronum|click here]].


==Features==
== Features ==
Zandronum supports [[Databases|databases]], powered by [http://sqlite.org/ SQLite].
Zandronum supports [[Databases|databases]], powered by [http://sqlite.org/ SQLite].


==Script Types==
== Script types ==
'''<code>[[EVENT_scripts|EVENT]]</code>''' scripts are executed when specific game events occur.
'''<code>[[EVENT_scripts|EVENT]]</code>''' scripts are executed when specific game events occur.


Line 13: Line 13:
* <code>'''CLIENTSIDE'''</code> scripts client-side and can not be executed by the puke command.
* <code>'''CLIENTSIDE'''</code> scripts client-side and can not be executed by the puke command.
* <code>'''NET CLIENTSIDE'''</code> scripts are client-side and can be executed by the puke command.
* <code>'''NET CLIENTSIDE'''</code> scripts are client-side and can be executed by the puke command.
<br>
In this example, when someone picks up the enemy item it will start this script on the Client side:
Script 1 PICKUP CLIENTSIDE
{
    {{zdoomwiki|Print}}(s:"Someone got the flag!");
}


It is worth reading [[Clientside Scripting]] if you intend on using CLIENTSIDE scripts.
It is worth reading [[Clientside Scripting]] if you intend on using CLIENTSIDE scripts.


==ACS Functions==
==ACS Functions==
* <code>[[AddBot]]</code> {{Devfeature|3.2|alpha}}
* <code>[[AnnouncerSound]]</code>
* <code>[[AnnouncerSound]]</code>
* <code>[[BanFromGame]]</code> {{Devfeature|3.2|alpha}}
* <code>[[BeginDBTransaction]]</code>
* <code>[[BeginDBTransaction]]</code>
* <code>[[ChangeTeamScore]]</code> {{Devfeature|3.2|alpha}}
* <code>[[CloseMenu]]</code> {{Devfeature|3.2|alpha}}
* <code>[[ConsoleCommand]]</code>
* <code>[[ConsoleCommand]]</code>
* <code>[[ConsolePlayerNumber]]</code>
* <code>[[ConsolePlayerNumber]]</code>
* <code>[[CountDBResults]]</code>
* <code>[[CountDBResults]]</code>
* <code>[[EndDBTransaction]]</code>
* <code>[[EndDBTransaction]]</code>
* <code>[[ExecuteClientScript]]</code>
* <code>[[FreeDBResults]]</code>
* <code>[[FreeDBResults]]</code>
* <code>[[GameType]]</code>
* <code>[[GameType]]</code>
* <code>[[GetActorSectorLocation]]</code> {{Devfeature|3.2|alpha}}
* <code>[[GetChatMessage]]</code>
* <code>[[GetCurrentGameMode]]</code>
* <code>[[GetCurrentMapPosition]]</code> {{Devfeature|3.2|alpha}}
* <code>[[GetCustomPlayerValue]]</code> {{Devfeature|3.2|alpha}}
* <code>[[GetEventResult]]</code> {{Devfeature|3.2|alpha}}
* <code>[[GetDBEntries]]</code>
* <code>[[GetDBEntries]]</code>
* <code>[[GetDBEntry‎]]</code>
* <code>[[GetDBEntry‎]]</code>
Line 42: Line 46:
* <code>[[GetInvasionState]]</code>
* <code>[[GetInvasionState]]</code>
* <code>[[GetInvasionWave]]</code>
* <code>[[GetInvasionWave]]</code>
* <code>[[GetMapRotationInfo]]</code>
* <code>[[GetMapRotationSize]]</code>
* <code>[[GetPlayerAccountName]]</code>
* <code>[[GetPlayerAccountName]]</code>
* <code>[[GetPlayerChasecam]]</code>
* <code>[[GetPlayerCountry]]</code> {{Devfeature|3.2|alpha}}
* <code>[[GetPlayerLivesLeft]]</code>
* <code>[[GetPlayerLivesLeft]]</code>
* <code>[[GetPlayerScore]]</code>
* <code>[[GetPlayerSkin]]</code> {{Devfeature|3.2|alpha}}
* <code>[[GetPlayerStatus]]</code> {{Devfeature|3.2|alpha}}
* <code>[[GetTeamProperty]]</code>
* <code>[[GetTeamProperty]]</code>
* <code>[[GetTimeProperty]]</code>
* <code>[[GetTimeProperty]]</code>
* <code>[[IncrementDBEntry]]</code>
* <code>[[IncrementDBEntry]]</code>
* <code>[[InDemoMode]]</code>
* <code>[[IsNetworkGame|IsMultiplayer]]</code>
* <code>[[IsNetworkGame|IsMultiplayer]]</code>
* <code>[[IsOneFlagCTF]]</code>
* <code>[[IsOneFlagCTF]]</code>
* <code>[[KickFromGame]]</code>
* <code>[[KickFromGame]]</code>
* <code>[[LumpOpen]]</code> {{Devfeature|3.2|alpha}}
* <code>[[LumpRead]]</code> {{Devfeature|3.2|alpha}}
* <code>[[LumpReadArray]]</code> {{Devfeature|3.2|alpha}}
* <code>[[LumpReadString]]</code> {{Devfeature|3.2|alpha}}
* <code>[[LumpGetInfo]]</code> {{Devfeature|3.2|alpha}}
* <code>[[LumpClose]]</code> {{Devfeature|3.2|alpha}}
* <code>[[ExecuteClientScript|NamedExecuteClientScript]]</code>
* <code>[[RequestScriptPuke|NamedRequestScriptPuke]]</code>
* <code>[[RequestScriptPuke|NamedRequestScriptPuke]]</code>
* <code>[[SendNetworkString|NamedSendNetworkString]]</code>
* <code>[[OpenMenu]]</code> {{Devfeature|3.2|alpha}}
* <code>[[Player_SetTeam]]</code>
* <code>[[Player_SetTeam]]</code>
* <code>[[PlayerArmorpoints]]</code>
* <code>[[PlayerArmorpoints]]</code>
Line 57: Line 78:
* <code>[[PlayerIsSpectator]]</code>
* <code>[[PlayerIsSpectator]]</code>
* <code>[[PlayerTeam]]</code>
* <code>[[PlayerTeam]]</code>
* <code>[[RemoveBot]]</code> {{Devfeature|3.2|alpha}}
* <code>[[RequestScriptPuke]]</code>
* <code>[[RequestScriptPuke]]</code>
* <code>[[ResetCustomDataToDefault]]</code> {{Devfeature|3.2|alpha}}
* <code>[[ResetMap]]</code>
* <code>[[ResetMap]]</code>
* <code>[[SendNetworkString]]</code>
* <code>[[SetActivatorToPlayer]]</code>
* <code>[[SetActivatorToPlayer]]</code>
* <code>[[SetCurrentGameMode]]</code>
* <code>[[SetCustomPlayerValue]]</code> {{Devfeature|3.2|alpha}}
* <code>[[SetDBEntry]]</code>
* <code>[[SetDBEntry]]</code>
* <code>[[SetDBEntryString]]</code>
* <code>[[SetDBEntryString]]</code>
* <code>[[SetDeadSpectator]]</code>
* <code>[[SetDeadSpectator]]</code>
* <code>[[SetGameModeLimit]]</code>
* <code>[[SetGameplaySetting]]</code> {{Devfeature|3.2|alpha}}
* <code>[[SetPlayerChasecam]]</code>
* <code>[[SetPlayerClass]]</code>
* <code>[[SetPlayerLivesLeft]]</code>
* <code>[[SetPlayerLivesLeft]]</code>
* <code>[[SetPlayerScore]]</code>
* <code>[[SetPlayerSkin]]</code> {{Devfeature|3.2|alpha}}
* <code>[[SetPlayerWeaponZoomFactor]]</code> {{Devfeature|3.2|alpha}}
* <code>[[SortDBEntries]]</code>
* <code>[[SortDBEntries]]</code>
* <code>[[Strftime]]</code>
* <code>[[Strftime]]</code>
Line 69: Line 102:
* <code>[[Team_GivePoints]]</code>
* <code>[[Team_GivePoints]]</code>
* <code>[[Team_Score]]</code>
* <code>[[Team_Score]]</code>
* <code>[[Teleport_NoStop]]</code>


==Deprecated==
== Deprecated ==
These functions are '''deprecated'''. They still work, but will be removed eventually. It is recommended you use more up to date functions.
These functions are '''deprecated'''. They still work, but will be removed eventually. It is recommended you use more up to date functions.


Line 89: Line 121:
* [[Adding New ACS Functions to ACC]]
* [[Adding New ACS Functions to ACC]]


[[Category:Level Development]]
[[Category:ACS]]
[[Category:ACS Functions]]
[[Category:Modding]]
[[Category:Modding]]