> For the complete documentation index, see [llms.txt](https://kinematicsoup.gitbook.io/reactor/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kinematicsoup.gitbook.io/reactor/api-reference/ks.reactor/ks.reactor.ksgroupmaskfilter.md).

# Class ksGroupMaskFilter

Namespace: [KS.Reactor](/reactor/api-reference/ks.reactor.md)\
Assembly: KSCommon.dll

A query filter that looks for colliders that belong to one of the collision groups in the [GroupMask](#KS_Reactor_ksGroupMaskFilter_GroupMask). All hits [TOUCH](/reactor/api-reference/ks.reactor/ks.reactor.ksqueryhittypes.md#KS_Reactor_ksQueryHitTypes_TOUCH).

```csharp
public class ksGroupMaskFilter : ksIQueryFilter
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) â† [ksGroupMaskFilter](/reactor/api-reference/ks.reactor/ks.reactor.ksgroupmaskfilter.md)

#### Implements

[ksIQueryFilter](/reactor/api-reference/ks.reactor/ks.reactor.ksiqueryfilter.md)

#### Inherited Members

[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)), [object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)), [object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode), [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype), [object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone), [object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals), [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Constructors

### ksGroupMaskFilter(uint) <a href="#ks_reactor_ksgroupmaskfilter__ctor_system_uint32" id="ks_reactor_ksgroupmaskfilter__ctor_system_uint32"></a>

Constructor

```csharp
public ksGroupMaskFilter(uint groupMask)
```

#### Parameters

`groupMask` [uint](https://learn.microsoft.com/dotnet/api/system.uint32)

Queries only hit colliders that belong to at least one of the collision groups in this mask.

## Properties

### GroupMask <a href="#ks_reactor_ksgroupmaskfilter_groupmask" id="ks_reactor_ksgroupmaskfilter_groupmask"></a>

Queries only hit colliders that belong to at least one of the collision groups in this mask.

```csharp
public uint GroupMask { get; set; }
```

#### Property Value

[uint](https://learn.microsoft.com/dotnet/api/system.uint32)

## Methods

### Filter(ksICollider, ksICollider, ksQueryResultTypes, ksBaseQueryParams) <a href="#ks_reactor_ksgroupmaskfilter_filter_ks_reactor_ksicollider_ks_reactor_ksicollider_ks_reactor_ksquery" id="ks_reactor_ksgroupmaskfilter_filter_ks_reactor_ksicollider_ks_reactor_ksicollider_ks_reactor_ksquery"></a>

Determines if a potential collider hit should be included in query results and whether it is a blocking or touching hit.

```csharp
public ksQueryHitTypes Filter(ksICollider queryCollider, ksICollider hitCollider, ksQueryResultTypes resultType, ksBaseQueryParams args)
```

#### Parameters

`queryCollider` [ksICollider](/reactor/api-reference/ks.reactor/ks.reactor.ksicollider.md)

The collider used in the query. Null for shape queries.

`hitCollider` [ksICollider](/reactor/api-reference/ks.reactor/ks.reactor.ksicollider.md)

The collider being evaluated for a hit.

`resultType` [ksQueryResultTypes](/reactor/api-reference/ks.reactor/ks.reactor.ksqueryresulttypes.md)

What kind of results the query returns

`args` [ksBaseQueryParams](/reactor/api-reference/ks.reactor/ks.reactor.ksbasequeryparams.md)

Query parameters

#### Returns

[ksQueryHitTypes](/reactor/api-reference/ks.reactor/ks.reactor.ksqueryhittypes.md)

Hit type
