Class Mask
Represents a collection of points that are masked. Usually used to determine whether something is allowed to be placed on a certain position or not.
Inheritance
Namespace: InsaneScatterbrain.MapGraph
Syntax
public class Mask : objectConstructors
Mask()
Declaration
public Mask()Properties
UnmaskedPoints
Gets all the unmasked points.
Declaration
public IReadOnlyCollection<int> UnmaskedPoints { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyCollection<System.Int32> |
Methods
Clone()
Creates a clone of this mask.
Declaration
public Mask Clone()Returns
| Type | Description |
|---|---|
| Mask | The cloned mask instance. |
Clone(Mask)
Creates a clone of this mask.
Declaration
public void Clone(Mask mask)Parameters
| Type | Name | Description |
|---|---|---|
| Mask | mask | The mask instance to clone into. |
IsPointMasked(Int32)
Checks whether the given point is masked or not according to this mask.
Declaration
public bool IsPointMasked(int point)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | point | The point. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the point is masked, false otherwise. |
MaskPoint(Int32)
Marks a point as masked.
Declaration
public void MaskPoint(int point)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | point | The point. |
Merge(Mask)
Merges this mask and the other mask together to create a new mask instance.
Declaration
public Mask Merge(Mask otherMask)Parameters
| Type | Name | Description |
|---|---|---|
| Mask | otherMask | The other mask. |
Returns
| Type | Description |
|---|---|
| Mask | The new merged mask instance. |
Merge(Mask, Mask)
Merges this mask and the other mask together to create a new mask instance.
Declaration
public void Merge(Mask otherMask, Mask result)Parameters
| Type | Name | Description |
|---|---|---|
| Mask | otherMask | The other mask. |
| Mask | result | The mask instance that will contain the merged result. |
Reset()
Declaration
public void Reset()Set(IEnumerable<Int32>)
Declaration
public void Set(IEnumerable<int> initialUnmaskedPoints)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<System.Int32> | initialUnmaskedPoints |
Set(Int32)
Declaration
public void Set(int numUnmaskedPoints)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | numUnmaskedPoints |
UnmaskPoint(Int32)
Marks a point as unmasked.
Declaration
public void UnmaskPoint(int point)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | point | The point. |