Enums/FCVAR

From Garry's Mod
(Difference between revisions)
Jump to: navigation, search
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{Enumeration
 
{{Enumeration
|Description=Enumerations used by {{LibraryFunction|concommand|Add}}, {{GlobalFunction|CreateClientConVar}} amd {{GlobalFunction|CreateConVar}}.
+
|Description=Enumerations used by {{LibraryFunction|concommand|Add}}, {{GlobalFunction|CreateClientConVar}} and {{GlobalFunction|CreateConVar}}.
|Fields=
+
|Fields={{EnumField|FCVAR_ARCHIVE|128|Save the {{Type|ConVar}} value into config.cfg
{{EnumField|FCVAR_ARCHIVE|128|Save the {{Type|ConVar}} value into config.cfg}}
+
 
{{EnumField|FCVAR_ARCHIVE_XBOX|16777216|Save the {{Type|ConVar}} value into config.cfg on XBox}}
+
Reported as "a" by ''cvarlist'', except Lua {{Type|ConVar}}s
{{EnumField|FCVAR_CHEAT|16384|Requires sv_cheats to be enabled to change/run the command}}
+
}}{{EnumField|FCVAR_ARCHIVE_XBOX|16777216|Save the {{Type|ConVar}} value into config.cfg on XBox}}{{EnumField|FCVAR_CHEAT|16384|Requires sv_cheats to be enabled to change the {{Type|ConVar}} or run the command
{{EnumField|FCVAR_CLIENTCMD_CAN_EXECUTE|1073741824|IVEngineClient::ClientCmd is allowed to execute this command}}
+
 
{{EnumField|FCVAR_CLIENTDLL|8|{{Type|ConVar}} is defined by the client DLL.<br/>This flag is set automatically}}
+
Reported as "cheat" by ''cvarlist''
{{EnumField|FCVAR_DEMO|65536|Force the {{Type|ConVar}} to be recorded by demo recordings.}}
+
}}{{EnumField|FCVAR_CLIENTCMD_CAN_EXECUTE|1073741824|IVEngineClient::ClientCmd is allowed to execute this command
{{EnumField|FCVAR_DONTRECORD|131072|Opposite of FCVAR_DEMO, ensures the {{Type|ConVar}} is not recorded in demos}}
+
 
{{EnumField|FCVAR_GAMEDLL|4|{{Type|ConVar}} is defined by the game DLL.<br/>This flag is set automatically}}
+
Reported as "clientcmd_can_execute" by ''cvarlist''
{{EnumField|FCVAR_NEVER_AS_STRING|4096|Tells the engine to never print this variable as a string since it contains control sequences}}
+
}}{{EnumField|FCVAR_CLIENTDLL|8|{{Type|ConVar}} is defined by the client DLL.<br/>This flag is set automatically
{{EnumField|FCVAR_NONE|0|No flags}}
+
 
{{EnumField|FCVAR_NOTIFY|256|For serverside {{Type|ConVar}}s, notifies all players with blue chat text when the value gets changed}}
+
Reported as "cl" by ''cvarlist''
{{EnumField|FCVAR_NOT_CONNECTED|4194304|Makes the {{Type|ConVar}} not changeable while connected to a server or in singleplayer}}
+
}}{{EnumField|FCVAR_DEMO|65536|Force the {{Type|ConVar}} to be recorded by demo recordings.
{{EnumField|FCVAR_PRINTABLEONLY|1024|Forces the {{Type|ConVar}} to only have printable characters ( No control characters )}}
+
 
{{EnumField|FCVAR_PROTECTED|32|Makes the {{Type|ConVar}} value hidden from all clients ( For example sv_password )}}
+
Reported as "demo" by ''cvarlist''
{{EnumField|FCVAR_REPLICATED|8192|For serverside {{Type|ConVar}}s, it will send its value to all clients}}
+
}}{{EnumField|FCVAR_DONTRECORD|131072|Opposite of FCVAR_DEMO, ensures the {{Type|ConVar}} is not recorded in demos
{{EnumField|FCVAR_SERVER_CANNOT_QUERY|536870912|Prevents the server from querying value of this {{Type|ConVar}}}}
+
 
{{EnumField|FCVAR_SERVER_CAN_EXECUTE|268435456|Makes the command or {{Type|ConVar}} only executeable/changeable from the server console}}
+
Reported as "norecord" by ''cvarlist''
{{EnumField|FCVAR_SPONLY|64|Executing the command or changing the {{Type|ConVar}} is only allowed in singleplayer}}
+
}}{{EnumField|FCVAR_GAMEDLL|4|{{Type|ConVar}} is defined by the game DLL.<br/>This flag is set automatically
{{EnumField|FCVAR_UNLOGGED|2048|Don't log the {{Type|ConVar}} changes to console/log files/users}}
+
 
{{EnumField|FCVAR_UNREGISTERED|1|If this is set, don't add to linked list, etc}}
+
Reported as "sv" by ''cvarlist''
{{EnumField|FCVAR_USERINFO|512|For clientside commands, sends the value to the server}}
+
}}{{EnumField|FCVAR_LUA_CLIENT|262144|Set automatically on all ConVars and console commands created by the client Lua state.
{{EnumField|FCVAR_LUA_CLIENT|262144|Set automatically on all ConVars and console commands created by the client Lua state.{{NextUpdate}}}}
+
 
{{EnumField|FCVAR_LUA_SERVER|524288|Set automatically on all ConVars and console commands created by the server Lua state.{{NextUpdate}}}}
+
Reported as "lua_client" by ''cvarlist''
 +
}}{{EnumField|FCVAR_LUA_SERVER|524288|Set automatically on all ConVars and console commands created by the server Lua state.
 +
 
 +
Reported as "lua_server" by ''cvarlist''
 +
}}{{EnumField|FCVAR_NEVER_AS_STRING|4096|Tells the engine to never print this variable as a string.
 +
 
 +
Reported as "numeric" by ''cvarlist''
 +
}}{{EnumField|FCVAR_NONE|0|No flags}}{{EnumField|FCVAR_NOTIFY|256|For serverside {{Type|ConVar}}s, notifies all players with blue chat text when the value gets changed
 +
 
 +
Reported as "nf" by ''cvarlist''
 +
}}{{EnumField|FCVAR_NOT_CONNECTED|4194304|Makes the {{Type|ConVar}} not changeable while connected to a server or in singleplayer}}{{EnumField|FCVAR_PRINTABLEONLY|1024|Forces the {{Type|ConVar}} to only have printable characters ( No control characters )
 +
 
 +
Reported as "print" by ''cvarlist''
 +
}}{{EnumField|FCVAR_PROTECTED|32|Makes the {{Type|ConVar}} value hidden from all clients ( For example sv_password )
 +
 
 +
Reported as "prot" by ''cvarlist''
 +
}}{{EnumField|FCVAR_REPLICATED|8192|For serverside {{Type|ConVar}}s, it will send its value to all clients. The {{Type|ConVar}} with the same name must also exist on the client!
 +
 
 +
Reported as "rep" by ''cvarlist''
 +
}}{{EnumField|FCVAR_SERVER_CANNOT_QUERY|536870912|Prevents the server from querying value of this {{Type|ConVar}}}}{{EnumField|FCVAR_SERVER_CAN_EXECUTE|268435456|The server is allowed to execute this command on clients.
 +
 
 +
Reported as "server_can_execute" by ''cvarlist''
 +
}}{{EnumField|FCVAR_SPONLY|64|Executing the command or changing the {{Type|ConVar}} is only allowed in singleplayer
 +
 
 +
Reported as "sp" by ''cvarlist''
 +
}}{{EnumField|FCVAR_UNLOGGED|2048|Don't log the {{Type|ConVar}} changes to console/log files/users
 +
 
 +
Reported as "log" by ''cvarlist''
 +
}}{{EnumField|FCVAR_UNREGISTERED|1|If this is set, the convar will become anonymous and won't show up in the 'find' results.}}{{EnumField|FCVAR_USERINFO|512|For clientside commands, sends the value to the server
 +
 
 +
Reported as "user" by ''cvarlist''
 +
}}
 
}}
 
}}

Latest revision as of 01:46, 23 October 2019

Enumerations used by concommand.Add, CreateClientConVar and CreateConVar.

Warning! Decimal values are for reference only! The actual value may be different between two Garry's Mod versions.
Name Decimal Description
FCVAR_ARCHIVE 128 Save the ConVar value into config.cfg

Reported as "a" by cvarlist, except Lua ConVars

FCVAR_ARCHIVE_XBOX 16777216 Save the ConVar value into config.cfg on XBox
FCVAR_CHEAT 16384 Requires sv_cheats to be enabled to change the ConVar or run the command

Reported as "cheat" by cvarlist

FCVAR_CLIENTCMD_CAN_EXECUTE 1073741824 IVEngineClient::ClientCmd is allowed to execute this command

Reported as "clientcmd_can_execute" by cvarlist

FCVAR_CLIENTDLL 8 ConVar is defined by the client DLL.
This flag is set automatically

Reported as "cl" by cvarlist

FCVAR_DEMO 65536 Force the ConVar to be recorded by demo recordings.

Reported as "demo" by cvarlist

FCVAR_DONTRECORD 131072 Opposite of FCVAR_DEMO, ensures the ConVar is not recorded in demos

Reported as "norecord" by cvarlist

FCVAR_GAMEDLL 4 ConVar is defined by the game DLL.
This flag is set automatically

Reported as "sv" by cvarlist

FCVAR_LUA_CLIENT 262144 Set automatically on all ConVars and console commands created by the client Lua state.

Reported as "lua_client" by cvarlist

FCVAR_LUA_SERVER 524288 Set automatically on all ConVars and console commands created by the server Lua state.

Reported as "lua_server" by cvarlist

FCVAR_NEVER_AS_STRING 4096 Tells the engine to never print this variable as a string.

Reported as "numeric" by cvarlist

FCVAR_NONE 0 No flags
FCVAR_NOTIFY 256 For serverside ConVars, notifies all players with blue chat text when the value gets changed

Reported as "nf" by cvarlist

FCVAR_NOT_CONNECTED 4194304 Makes the ConVar not changeable while connected to a server or in singleplayer
FCVAR_PRINTABLEONLY 1024 Forces the ConVar to only have printable characters ( No control characters )

Reported as "print" by cvarlist

FCVAR_PROTECTED 32 Makes the ConVar value hidden from all clients ( For example sv_password )

Reported as "prot" by cvarlist

FCVAR_REPLICATED 8192 For serverside ConVars, it will send its value to all clients. The ConVar with the same name must also exist on the client!

Reported as "rep" by cvarlist

FCVAR_SERVER_CANNOT_QUERY 536870912 Prevents the server from querying value of this ConVar
FCVAR_SERVER_CAN_EXECUTE 268435456 The server is allowed to execute this command on clients.

Reported as "server_can_execute" by cvarlist

FCVAR_SPONLY 64 Executing the command or changing the ConVar is only allowed in singleplayer

Reported as "sp" by cvarlist

FCVAR_UNLOGGED 2048 Don't log the ConVar changes to console/log files/users

Reported as "log" by cvarlist

FCVAR_UNREGISTERED 1 If this is set, the convar will become anonymous and won't show up in the 'find' results.
FCVAR_USERINFO 512 For clientside commands, sends the value to the server

Reported as "user" by cvarlist

Personal tools
Navigation