# Players Filter **Code:** [*guthscp.players\_filter*](https://github.com/Guthen/guthscpbase/blob/master/lua/guthscp/keter/core/shared/filters/players_filter.lua) **Extends:** [*guthscp.filter*](https://guthen.gitbook.io/guthscp/classes/filter) **Realm:**

Shared *** ## Description Players filters are containers useful for caching a list of players with pre-determined conditions. Similarly to filters, they must be instantiated on both client and server sides. As filters are automatically synchronized after a modification, only the server needs to manage their content. The client should only receive data from the server and should not alters the content by itself. By itself, a filter won't do anything unless you told him so. Therefore, you should either use `FILTER:listen_<...>` methods or manually hook into game events and use `FILTER:add` and `FILTER:remove` methods. *** ## Methods {% hint style="info" %} Inherited methods will NOT appear here, please read the parent's documentation. {% endhint %}

**`void`** `listen_disconnect()` Makes the filter to automatically clean-up disconnected players. ***

**`void`** `listen_weapon_users( string weapon_class )` Makes the filter to automatically add players who are using a specific weapon class and to remove those who are not. *** ## Example A common use case is to gather a list of players using a certain SCP weapon for later use. Code from [*guthscp173*](https://github.com/Guthen/guthscp173/blob/update-to-guthscpbase-remaster/lua/guthscp/modules/guthscp173/shared.lua):

guthscp173.filter = guthscp.players_filter:new( "guthscp173" )
if SERVER then
	guthscp173.filter:listen_disconnect()
	guthscp173.filter:listen_weapon_users( "guthscp_173" )  --  being SCP-173 just mean a player having the weapon 

	guthscp173.filter.event_removed:add_listener( "guthscp173:unfreeze", function( ply )
		ply:SetNWBool( "guthscp173:looked", false )
	end )
end

[^1]: Creates an instance of a Players Filter [^2]: Subscribes to the "remove event", called when a player is being removed from the filter --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://guthen.gitbook.io/guthscp/classes/filter/players-filter.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.