Interface IRestrictionList

Adds the ability to restrict certain entities from being affected by "something". That "something" can be an area, for example, or a display list for a viewport.

Inherited Members

System.ComponentModel.INotifyPropertyChanged.PropertyChanged

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IRestrictionList : INotifyPropertyChanged

Properties

RestrictionList

Gets list of restricted entities (if it's a black list), or permitted entities (if it's a white list). If the list is empty then the component is effectively ignored (everybody is permitted).

Declaration

IConcurrentHashSet<string> RestrictionList { get; }

Property Value

Type	Description
IConcurrentHashSet<System.String>	The restriction list.

RestrictionType

Gets or sets the type of the restriction, black list (everybody in the list is restricted) or white list (everybody not in the list is restricted).

Declaration

RestrictionListType RestrictionType { get; set; }

Property Value

Type	Description
RestrictionListType	The type of the restriction.

Methods

IsRestricted(String)

Checks if an entity is restricted to this area (based on the restriction type and list).

Declaration

bool IsRestricted(string entityId)

Parameters

Type	Name	Description
System.String	entityId	Entity identifier.

Returns

Type	Description
System.Boolean	true, if entity is restricted, false otherwise.