Struct ComponentTypeTagPair

A type of a component and the tag expected to be associated with a component of that type in a IComponentCollection or map generation step.

Implements
System.IEquatable<ComponentTypeTagPair>
SadRogue.Primitives.IMatchable<ComponentTypeTagPair>
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: GoRogue.Components
Assembly: GoRogue.dll
Syntax
[DataContract]
[PublicAPI]
public struct ComponentTypeTagPair : IEquatable<ComponentTypeTagPair>, IMatchable<ComponentTypeTagPair>

Constructors

| Improve this Doc View Source

ComponentTypeTagPair(Type, String)

Constructor.

Declaration
public ComponentTypeTagPair(Type componentType, string tag)
Parameters
Type Name Description
System.Type componentType
System.String tag

Fields

| Improve this Doc View Source

ComponentType

The type of component expected.

Declaration
[DataMember]
public readonly Type ComponentType
Field Value
Type Description
System.Type
| Improve this Doc View Source

Tag

The tag expected to be associated with a component of the specified type.

Declaration
[DataMember]
public readonly string Tag
Field Value
Type Description
System.String

Methods

| Improve this Doc View Source

Deconstruct(out Type, out String)

Supports C# Deconstruction syntax.

Declaration
public void Deconstruct(out Type componentType, out string tag)
Parameters
Type Name Description
System.Type componentType
System.String tag
| Improve this Doc View Source

Equals(ComponentTypeTagPair)

True if the given pair has the same component type and tag; false otherwise.

Declaration
[Pure]
public bool Equals(ComponentTypeTagPair other)
Parameters
Type Name Description
ComponentTypeTagPair other
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Equals(Object)

True if the given object is a ComponentTypeTagPair and has the same component type and tag; false otherwise.

Declaration
[Pure]
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
System.ValueType.Equals(System.Object)
| Improve this Doc View Source

FromTuple((Type componentType, String tag))

Converts the tuple to an equivalent ComponentTypeTagPair.

Declaration
public static ComponentTypeTagPair FromTuple((Type componentType, string tag) tuple)
Parameters
Type Name Description
System.ValueTuple<System.Type, System.String> tuple
Returns
Type Description
ComponentTypeTagPair
| Improve this Doc View Source

GetHashCode()

Returns a hash code based on all of the pair's field's.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.ValueType.GetHashCode()
| Improve this Doc View Source

Matches(ComponentTypeTagPair)

True if the given pair has the same component type and tag; false otherwise.

Declaration
[Pure]
public bool Matches(ComponentTypeTagPair other)
Parameters
Type Name Description
ComponentTypeTagPair other
Returns
Type Description
System.Boolean
| Improve this Doc View Source

ToString()

Returns a string representing the component type and its tag.

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.ValueType.ToString()
| Improve this Doc View Source

ToTuple()

Converts the pair to an equivalent tuple.

Declaration
[Pure]
public (Type componentType, string tag) ToTuple()
Returns
Type Description
System.ValueTuple<System.Type, System.String>

Operators

| Improve this Doc View Source

Equality(ComponentTypeTagPair, ComponentTypeTagPair)

True if the given pairs have the same component type and tag; false otherwise.

Declaration
public static bool operator ==(ComponentTypeTagPair left, ComponentTypeTagPair right)
Parameters
Type Name Description
ComponentTypeTagPair left
ComponentTypeTagPair right
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Implicit(ComponentTypeTagPair to (Type componentType, String tag))

Implicitly converts a ComponentTypeTagPair to an equivalent tuple.

Declaration
public static implicit operator (Type componentType, string tag)(ComponentTypeTagPair pair)
Parameters
Type Name Description
ComponentTypeTagPair pair
Returns
Type Description
System.ValueTuple<System.Type, System.String>
| Improve this Doc View Source

Implicit((Type componentType, String tag) to ComponentTypeTagPair)

Implicitly converts a tuple to its equivalent ComponentTypeTagPair.

Declaration
public static implicit operator ComponentTypeTagPair((Type componentType, string tag) tuple)
Parameters
Type Name Description
System.ValueTuple<System.Type, System.String> tuple
Returns
Type Description
ComponentTypeTagPair
| Improve this Doc View Source

Inequality(ComponentTypeTagPair, ComponentTypeTagPair)

True if the given pairs have different component types and/or tags; false otherwise.

Declaration
public static bool operator !=(ComponentTypeTagPair left, ComponentTypeTagPair right)
Parameters
Type Name Description
ComponentTypeTagPair left
ComponentTypeTagPair right
Returns
Type Description
System.Boolean

Implements

System.IEquatable<T>
SadRogue.Primitives.IMatchable<T>

Extension Methods