Returns a filtered table of currently connected players matching the given filter criteria. If no filters are provided, all players are returned.

Syntax

Server.Players.GetPlayersWhere( filters, [ caseInsensitive ] )

Arguments

• filters (table, optional): A table of key-value pairs to filter players by. Supported keys are:
  • name (string): Matches players by their name.
  • discriminator (string): Matches players by their discriminator.
  • mainMod (MainMod): Matches players by their selected main mod.
  • session (Session): Matches players by their session.
• caseInsensitive (boolean, optional): Whether string filters should be matched in a case-insensitive manner. Defaults to true.

Return Values

• (table): A table of Player objects matching all provided filters.

Examples

local filters = { name = "loren" }
local players = Server.Players.GetPlayersWhere(filters, false)
for i = 1, #players do
    local player = players[i]
    player:Kick("Get back to work on Donut Mod, " .. player.Name .. "!")
end