ConsoleCommand: Difference between revisions
(Added information regarding "cl_protectcvars" and CVARINFO in 3.1.) |
DrinkyBird (talk | contribs) No edit summary Tag: Source edit |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{WarningBox | ||
| | | content = '''Warning:''' ConsoleCommand is dangerous and is flagged for eventual removal over security reasons. It is not advised to use ConsoleCommand in new mods. Details [http://zandronum.com/tracker/view.php?id=1070 here]. | ||
| image = MedalYouFailIt.png | |||
| background = FF8888 | |||
}} | }} | ||
{{Template:ACSWarning}} | {{Template:ACSWarning}} | ||
void '''ConsoleCommand''' (str ''consolecommand'') | void '''ConsoleCommand''' (str ''consolecommand'') | ||
==Usage== | == Usage == | ||
ConsoleCommand causes the game server to activate the given console command. This can be used to set mod-specific CVARs and other commands that cannot be executed by pure ACS. Only one command can be executed per function call. If the command is used from a CLIENTSIDE script, the local machine will execute the command. | ConsoleCommand causes the game server to activate the given console command. This can be used to set mod-specific CVARs and other commands that cannot be executed by pure ACS. Only one command can be executed per function call. If the command is used from a CLIENTSIDE script, the local machine will execute the command. | ||
| Line 30: | Line 29: | ||
* crashout | * crashout | ||
* wait | * wait | ||
Aliases and bindings can be managed in a {{Zdoomwiki|KEYCONF}} lump. | Aliases and bindings can be managed in a {{Zdoomwiki|KEYCONF}} lump. | ||
== | === Parameters === | ||
* ''consolecommand'': The string to be executed in the console. | |||
== Notes == | |||
As of 3.1, if a user has [[Console_Variables|cl_protectcvars]] enabled then any changes made to a CVar's value using this function will not be saved permanently and the CVar's original value will be restored upon exiting the game. In addition, it is possible for [https://zdoom.org/wiki/CVARINFO CVARINFO] to redefine any CVars created using the "set" and "archivecvar" [https://zdoom.org/wiki/CCMDs:Customization CCMDs] with this function, so mods don't have to create new names for them anymore. This is also backwards compatible in case an old version of the mod is loaded afterwards. | As of 3.1, if a user has [[Console_Variables|cl_protectcvars]] enabled then any changes made to a CVar's value using this function will not be saved permanently and the CVar's original value will be restored upon exiting the game. In addition, it is possible for [https://zdoom.org/wiki/CVARINFO CVARINFO] to redefine any CVars created using the "set" and "archivecvar" [https://zdoom.org/wiki/CCMDs:Customization CCMDs] with this function, so mods don't have to create new names for them anymore. This is also backwards compatible in case an old version of the mod is loaded afterwards. | ||
==Examples== | == Examples == | ||
{{noexamples}} | {{noexamples}} | ||
[[ | [[Category: ACS functions]] | ||
Latest revision as of 22:59, 2 January 2023
|
Warning: ConsoleCommand is dangerous and is flagged for eventual removal over security reasons. It is not advised to use ConsoleCommand in new mods. Details here. |
|
This article documents a Zandronum-specific ACS feature which may not be supported by ZDoom and its other child ports. |
void ConsoleCommand (str consolecommand)
Usage
ConsoleCommand causes the game server to activate the given console command. This can be used to set mod-specific CVARs and other commands that cannot be executed by pure ACS. Only one command can be executed per function call. If the command is used from a CLIENTSIDE script, the local machine will execute the command.
The following commands cannot be used and will be ignored:
- unbindall
- unbind
- bind
- quit
- exit
- logfile
- alias (including any alias commands)
- screenshot
- dumpmap
- say
- say_team
- sv_banfile
- sv_banexcemptionfile
- sv_adminlistfile
- error
- error_fatal
- crashout
- wait
Aliases and bindings can be managed in a 
KEYCONF lump.
Parameters
- consolecommand: The string to be executed in the console.
Notes
As of 3.1, if a user has cl_protectcvars enabled then any changes made to a CVar's value using this function will not be saved permanently and the CVar's original value will be restored upon exiting the game. In addition, it is possible for CVARINFO to redefine any CVars created using the "set" and "archivecvar" CCMDs with this function, so mods don't have to create new names for them anymore. This is also backwards compatible in case an old version of the mod is loaded afterwards.
Examples
| This article lists no examples, please add one. |