API reference

The public API in CS2-SimpleAdminApi/, generated from the source at build time: signatures as written, with their /// documentation. Get the API with the simpleadmin:api plugin capability; see Modules for a working module. Menus are passed around as object: create them with the API and pass them back to it (AddMenuOption, AddSubMenu, OpenMenu).

“Used by” names the modules in this repository that call a member, as examples to read.

Events 5
Players and penalties 6
Server and database 3
Messages, logging and silent admins 7
Commands 2
Menus 13
Types 4

Events

event Action? OnSimpleAdminReady

Used by: FunCommands, ExampleModule

event Action<PlayerInfo, PlayerInfo?, PenaltyType, string, int, int?, int?>? OnPlayerPenaltied

Event fired when a player receives a penalty.

Used by: BanSoundModule, ExampleModule

event Action<SteamID, PlayerInfo?, PenaltyType, string, int, int?, int?>? OnPlayerPenaltiedAdded

Event fired when a penalty is added to a player by SteamID.

Used by: ExampleModule

event Action<string, string?, bool, object>? OnAdminShowActivity

Event to show admin activity messages.

Used by: RedisInform

event Action<int, bool>? OnAdminToggleSilent

Event fired when an admin toggles silent mode.

Used by: StealthModule

Players and penalties

PlayerInfo GetPlayerInfo(CCSPlayerController player)

Gets player information associated with the specified player controller.

player: The player controller.

Used by: FunCommands, ExampleModule

Dictionary<PenaltyType, List<(DateTime EndDateTime, int Duration, bool Passed)>> GetPlayerMuteStatus(CCSPlayerController player)

Returns mute-related penalties for the specified player.

player: The player controller.

void IssuePenalty(CCSPlayerController player, CCSPlayerController? admin, PenaltyType penaltyType, string reason, int duration = -1)

Issues a penalty to a player controller with specified type, reason, and optional duration.

Used by: AntiDLL, ExampleModule

void IssuePenalty(SteamID steamid, CCSPlayerController? admin, PenaltyType penaltyType, string reason, int duration = -1)

Issues a penalty to a player identified by SteamID with specified type, reason, and optional duration.

Used by: AntiDLL, ExampleModule

TargetResult? GetTarget(CommandInfo command)

Gets target players from command

Used by: FunCommands

List<CCSPlayerController> GetValidPlayers()

Returns the list of current valid players, available to call from other plugins.

Used by: FunCommands, ExampleModule

Server and database

string GetConnectionString()

Returns the database connection string used by the plugin.

Used by: ExampleModule

string GetServerAddress()

Returns the configured server IP address with port.

Used by: ExampleModule

int? GetServerId()

Returns the internal server ID assigned in the plugin's database.

Used by: ExampleModule

Messages, logging and silent admins

void LogCommand(CCSPlayerController? caller, string command)

Logs a command invoked by a caller with the command string.

Used by: FunCommands

void LogCommand(CCSPlayerController? caller, CommandInfo command)

Logs a command invoked by a caller with the command info object.

Used by: FunCommands

void ShowAdminActivity(string messageKey, string? callerName = null, bool dontPublish = false, params object[] messageArgs)

Shows an admin activity message, optionally suppressing broadcasting.

Used by: FunCommands, RedisInform

void ShowAdminActivityTranslated(string translatedMessage, string? callerName = null, bool dontPublish = false)

Shows an admin activity message with a custom translated message (for modules with their own localizer).

translatedMessage: Already translated message to display to players.
callerName: Name of the admin executing the action (optional).
dontPublish: If true, won't trigger publish events.

void ShowAdminActivityLocalized(object moduleLocalizer, string messageKey, string? callerName = null, bool dontPublish = false, params object[] messageArgs)

Shows an admin activity message using module's localizer for per-player language support. This method sends messages in each player's configured language.

moduleLocalizer: The module's IStringLocalizer instance.
messageKey: The translation key from the module's lang files.
callerName: Name of the admin executing the action (optional).
dontPublish: If true, won't trigger publish events.
messageArgs: Arguments to format the localized message.

Used by: FunCommands

bool IsAdminSilent(CCSPlayerController player)

Returns true if the specified admin player is in silent mode (not broadcasting activity).

Used by: FunCommands, StealthModule, ExampleModule

HashSet<int> ListSilentAdminsSlots()

Returns a set of player slots representing admins currently in silent mode.

Used by: StealthModule

Commands

void RegisterCommand(string name, string? description, CommandInfo.CommandCallback callback)

Registers a new command with the specified name, description, and callback.

Used by: FunCommands

void UnRegisterCommand(string name)

Unregisters an existing command by its name.

Used by: FunCommands

Menus

void RegisterMenuCategory(string categoryId, string categoryName, string permission = "@css/generic")

Registers a menu category.

Used by: FunCommands, ExampleModule

void RegisterMenuCategory(string categoryId, string categoryNameKey, string permission, object moduleLocalizer)

Registers a menu category with per-player localization support for modules. Supports per-player localization using module's IStringLocalizer!

categoryId: The category ID (unique identifier).
categoryNameKey: Translation key from module's lang files.
permission: Required permission to access this category.
moduleLocalizer: Module's IStringLocalizer for per-player translation.

Used by: FunCommands, ExampleModule

void RegisterMenu(string categoryId, string menuId, string menuName, Func<CCSPlayerController, object> menuFactory, string? permission = null, string? commandName = null)

Registers a menu in a category.

categoryId: The category to add this menu to.
menuId: Unique identifier for the menu.
menuName: Display name of the menu.
menuFactory: Factory function that creates the menu for a player.
permission: Required permission to access this menu (optional).
commandName: Command name for permission override checking (optional, e.g., "css_god").

Used by: FunCommands, ExampleModule

void RegisterMenu(string categoryId, string menuId, string menuName, Func<CCSPlayerController, MenuContext, object> menuFactory, string? permission = null, string? commandName = null)

Registers a menu in a category with automatic context passing. RECOMMENDED: Use this overload to eliminate duplication of categoryId and menuName in factory methods.

categoryId: The category to add this menu to.
menuId: Unique identifier for the menu.
menuName: Display name of the menu.
menuFactory: Factory function that receives player and menu context.
permission: Required permission to access this menu (optional).
commandName: Command name for permission override checking (optional, e.g., "css_god").

Used by: FunCommands, ExampleModule

void RegisterMenu(string categoryId, string menuId, string menuNameKey, Func<CCSPlayerController, MenuContext, object> menuFactory, string? permission, string? commandName, object moduleLocalizer)

Registers a menu with per-player localization support for modules. Supports per-player localization using module's IStringLocalizer!

categoryId: The category to add this menu to.
menuId: Unique identifier for the menu.
menuNameKey: Translation key from module's lang files.
menuFactory: Factory function that receives player and menu context.
permission: Required permission to access this menu (optional).
commandName: Command name for permission override checking (optional).
moduleLocalizer: Module's IStringLocalizer for per-player translation.

Used by: FunCommands, ExampleModule

void UnregisterMenu(string categoryId, string menuId)

Unregisters a menu from a category.

Used by: FunCommands, ExampleModule

object CreateMenuWithBack(string title, string categoryId, CCSPlayerController player)

Creates a menu with an automatic back button.

Used by: FunCommands, ExampleModule

object CreateMenuWithBack(MenuContext context, CCSPlayerController player)

Creates a menu with an automatic back button using menu context. RECOMMENDED: Use this overload when calling from a context-aware menu factory to avoid title/category duplication.

context: Menu context containing title and category information.
player: The player who will see the menu.

Used by: FunCommands, ExampleModule

object CreateMenuWithPlayers(string title, string categoryId, CCSPlayerController admin, Func<CCSPlayerController, bool> filter, Action<CCSPlayerController, CCSPlayerController> onSelect)

Creates a menu with a list of players with filter and action.

Used by: FunCommands, ExampleModule

object CreateMenuWithPlayers(MenuContext context, CCSPlayerController admin, Func<CCSPlayerController, bool> filter, Action<CCSPlayerController, CCSPlayerController> onSelect)

Creates a menu with a list of players using menu context. RECOMMENDED: Use this overload when calling from a context-aware menu factory to avoid title/category duplication.

context: Menu context containing title and category information.
admin: The admin player opening the menu.
filter: Filter function to determine which players to show.
onSelect: Action to execute when a player is selected.

Used by: FunCommands, ExampleModule

void AddMenuOption(object menu, string name, Action<CCSPlayerController> action, bool disabled = false, string? permission = null)

Adds an option to the menu (extension method helper).

Used by: FunCommands, ExampleModule

void AddSubMenu(object menu, string name, Func<CCSPlayerController, object> subMenuFactory, bool disabled = false, string? permission = null)

Adds a submenu to the menu (extension method helper).

Used by: FunCommands, ExampleModule

void OpenMenu(object menu, CCSPlayerController player)

Opens a menu for a player.

Types

`class MenuContext`

Provides contextual information about a menu to its factory function. This eliminates the need to duplicate category IDs and menu titles when creating menus.

Member	Description
`string CategoryId`	The category ID this menu belongs to (e.g., "fun", "players"). Used for automatic "Back" button navigation.
`string MenuId`	The unique identifier for this menu within its category.
`string MenuTitle`	The display title of the menu (from registration).
`string? Permission`	The permission required to access this menu (if any).
`string? CommandName`	The command name for permission override checking (if any).
`MenuContext(string categoryId, string menuId, string menuTitle, string? permission = null, string? commandName = null)`	Creates a new MenuContext with the specified values.
`CategoryId = categoryId`
`MenuId = menuId`
`MenuTitle = menuTitle`
`Permission = permission`
`CommandName = commandName`

CS2-SimpleAdminApi/MenuContext.cs

`enum PenaltyType`

Ban = 0,
Kick,
Mute,
Gag,
Silence,
Warn

CS2-SimpleAdminApi/PenaltyType.cs

`class PlayerInfo`

PlayerInfo(
  int? userId,
  int slot,
  SteamID steamId,
  string name,
  string? ipAddress,
  int totalBans = 0,
  int totalMutes = 0,
  int totalGags = 0,
  int totalSilences = 0,
  int totalWarns = 0
)

Member	Description
`int? UserId`
`int Slot`
`SteamID SteamId`
`string Name`
`string? IpAddress`
`int TotalBans`
`int TotalMutes`
`int TotalGags`
`int TotalSilences`
`int TotalWarns`
`bool WaitingForKick`
`List<(ulong SteamId, string PlayerName)> AccountsAssociated`
`DiePosition? DiePosition`
`bool IsLoaded`

CS2-SimpleAdminApi/PlayerInfo.cs

`class DiePosition`

DiePosition(
  Vector3 position,
  Vector3 angle
)

Member	Description
`Vector3 Position`
`Vector3 Angle`

CS2-SimpleAdminApi/PlayerInfo.cs

Source: CS2-SimpleAdminApi/ICS2-SimpleAdminApi.cs