# Clan List

{% hint style="success" %}

#### Like what your seeing?

Support us as a [GitHub Sponsor](/old-kb/where-to-buy/become-a-sponsor.md) and get instant access to all our assets, exclusive tools and assets, escalated support and issue tracking and our gratitude.\
\
These articles are made possible by our [GitHub Sponsors](/old-kb/where-to-buy/become-a-sponsor.md) ... become a sponsor today!
{% endhint %}

## Introduction

Displays a list of the clans the user sees e.g. is a member of or otherwise has a relationship with.

```csharp
namespace HeathenEngineering.SteamworksIntegration.UI
```

```csharp
public class ClanList : MonoBehaviour
```

## Fields and Attributes

### Filter

Can only be set in the editor, Scopes the list to specific clans

```csharp
[SerializeField]
private Filter filter = Filter.Any;
```

Valid options include

* Any
* Official Groups
* Public Groups
* Non-official Groups
* Private Groups
* Followed

### Content

Can only be set in the editor, The root where new records will be spawned when found

```csharp
[SerializeField]
private Transform content;
```

### Record Template

Can only be set in the editor, The template to be cloned for each entry found

```csharp
[SerializeField]
private GameObject recordTemplate;
```

### Active Filter

Updates the filter value

```csharp
public Filter ActiveFilter { get; set; }
```

## Methods

### Clear

Clears the list of records being managed

```csharp
public void Clear()
```

### Update Display

Updates the displayed list of records

```csharp
public void UpdateDisplay()
```

### Match Filter

Returns true if the Clan priovided matches the filter value

```csharp
public bool MatchFilter(ClanData clan)
```


---

# 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://kb.heathen.group/old-kb/old-toolkit-for-steamworks/unity/objects/ui-components/clan-list.md?ask=<question>
```

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.