Class RecipientFilter

Namespace

CounterStrikeSharp.API.Modules.Utils

Assembly

CounterStrikeSharp.API.dll

A generic filter for determining whom to send message/sounds etc. to and providing a bit of additional state information

public class RecipientFilter : IList<CCSPlayerController>, ICollection<CCSPlayerController>, IEnumerable<CCSPlayerController>, IEnumerable

Inheritance

object

RecipientFilter

Implements

IList<CCSPlayerController>

ICollection<CCSPlayerController>

IEnumerable<CCSPlayerController>

IEnumerable

Constructors

RecipientFilter()

public RecipientFilter()

RecipientFilter(params CCSPlayerController[])

public RecipientFilter(params CCSPlayerController[] slots)

Parameters

slots CCSPlayerController[]

RecipientFilter(params int[])

public RecipientFilter(params int[] slots)

Parameters

slots int[]

RecipientFilter(ulong)

public RecipientFilter(ulong mask)

Parameters

mask ulong

Properties

Count

Gets the number of elements contained in the ICollection<T>.

public int Count { get; }

Property Value

int

The number of elements contained in the ICollection<T>.

IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

public bool IsReadOnly { get; }

Property Value

bool

true if the ICollection<T> is read-only; otherwise, false.

this[int]

Gets or sets the element at the specified index.

public CCSPlayerController this[int index] { get; set; }

Parameters

index int

The zero-based index of the element to get or set.

Property Value

CCSPlayerController

The element at the specified index.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The property is set and the IList<T> is read-only.

Methods

Add(CCSPlayerController)

Adds an item to the ICollection<T>.

public void Add(CCSPlayerController item)

Parameters

item CCSPlayerController

The object to add to the ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Add(int)

public void Add(int slot)

Parameters

slot int

AddAllPlayers()

public void AddAllPlayers()

Clear()

Removes all items from the ICollection<T>.

public void Clear()

Exceptions

NotSupportedException

The ICollection<T> is read-only.

Contains(CCSPlayerController)

Determines whether the ICollection<T> contains a specific value.

public bool Contains(CCSPlayerController item)

Parameters

item CCSPlayerController

The object to locate in the ICollection<T>.

Returns

bool

true if item is found in the ICollection<T>; otherwise, false.

CopyTo(CCSPlayerController[], int)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

public void CopyTo(CCSPlayerController[] array, int arrayIndex)

Parameters

array CCSPlayerController[]

The one-dimensional Array that is the destination of the elements copied from ICollection<T>. The Array must have zero-based indexing.

arrayIndex int

The zero-based index in array at which copying begins.

Exceptions

ArgumentNullException

array is null.

ArgumentOutOfRangeException

arrayIndex is less than 0.

ArgumentException

The number of elements in the source ICollection<T> is greater than the available space from arrayIndex to the end of the destination array.

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<CCSPlayerController> GetEnumerator()

Returns

IEnumerator<CCSPlayerController>

An enumerator that can be used to iterate through the collection.

GetNativeObject()

public IEnumerable<object> GetNativeObject()

Returns

IEnumerable<object>

GetRecipientMask()

public ulong GetRecipientMask()

Returns

ulong

IndexOf(CCSPlayerController)

Determines the index of a specific item in the IList<T>.

public int IndexOf(CCSPlayerController item)

Parameters

item CCSPlayerController

The object to locate in the IList<T>.

Returns

int

The index of item if found in the list; otherwise, -1.

Insert(int, CCSPlayerController)

Inserts an item to the IList<T> at the specified index.

public void Insert(int index, CCSPlayerController item)

Parameters

index int

The zero-based index at which item should be inserted.

item CCSPlayerController

The object to insert into the IList<T>.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The IList<T> is read-only.

Remove(CCSPlayerController)

Removes the first occurrence of a specific object from the ICollection<T>.

public bool Remove(CCSPlayerController item)

Parameters

item CCSPlayerController

The object to remove from the ICollection<T>.

Returns

bool

true if item was successfully removed from the ICollection<T>; otherwise, false. This method also returns false if item is not found in the original ICollection<T>.

Exceptions

NotSupportedException

The ICollection<T> is read-only.

RemoveAt(int)

Removes the IList<T> item at the specified index.

public void RemoveAt(int index)

Parameters

index int

The zero-based index of the item to remove.

Exceptions

ArgumentOutOfRangeException

index is not a valid index in the IList<T>.

NotSupportedException

The IList<T> is read-only.

Operators

implicit operator RecipientFilter(CCSPlayerController)

public static implicit operator RecipientFilter(CCSPlayerController player)

Parameters

player CCSPlayerController

Returns

RecipientFilter