Files
RobustToolbox/Robust.Shared/Configuration/CVar.cs
slarticodefast 4747e5a05a Add and update a lot of documentation (#6337)
* Serialization docs

Co-authored-by: Moony <moonheart08@users.noreply.github.com>

* ECS docs

Co-authored-by: Moony <moonheart08@users.noreply.github.com>

* scattered docs

Co-authored-by: Moony <moonheart08@users.noreply.github.com>

* Fixes

---------

Co-authored-by: Moony <moonheart08@users.noreply.github.com>
Co-authored-by: PJB3005 <pieterjan.briers+git@gmail.com>
2025-12-15 20:26:17 +01:00

82 lines
2.2 KiB
C#

using System;
namespace Robust.Shared.Configuration
{
/// <summary>
/// Extra flags for changing the behavior of a config var.
/// </summary>
[Flags]
public enum CVar : short
{
/// <summary>
/// No special flags.
/// </summary>
NONE = 0,
/// <summary>
/// Debug vars that are considered 'cheating' to change.
/// </summary>
CHEAT = 1,
/// <summary>
/// Only the server can change this variable.
/// </summary>
SERVER = 2,
/// <summary>
/// This can only be changed when not connected to a server.
/// </summary>
NOT_CONNECTED = 4,
/// <summary>
/// Changing this var syncs between clients and server.
/// </summary>
/// <remarks>
/// Should only ever be used on shared CVars.
/// </remarks>
REPLICATED = 8,
/// <summary>
/// Non-default values are saved to the configuration file.
/// </summary>
ARCHIVE = 16,
/// <summary>
/// Changing this var on the server notifies all clients, does nothing client-side.
/// </summary>
/// <remarks>
/// Should only ever be used on shared CVars.
/// </remarks>
NOTIFY = 32,
/// <summary>
/// Ignore registration of this cvar on the client.
/// </summary>
/// <remarks>
/// This is intended to aid shared code.
/// </remarks>
SERVERONLY = 64,
/// <summary>
/// Ignore registration of this cvar on the server.
/// </summary>
/// <remarks>
/// This is intended to aid shared code.
/// </remarks>
CLIENTONLY = 128,
/// <summary>
/// CVar contains sensitive data that should not be accidentally leaked.
/// </summary>
/// <remarks>
/// This currently hides the content of the cvar in the "cvar" command completions.
/// </remarks>
CONFIDENTIAL = 256,
/// <summary>
/// Only the client can change this variable.
/// </summary>
CLIENT = 512,
}
}