Struct ComponentTagPair

A component from a IComponentCollection and its associated tag.

Implements
System.IEquatable<ComponentTagPair>
SadRogue.Primitives.IMatchable<ComponentTagPair>
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 ComponentTagPair : IEquatable<ComponentTagPair>, IMatchable<ComponentTagPair>

Constructors

| Improve this Doc View Source

ComponentTagPair(Object, String)

Constructor.

Declaration
public ComponentTagPair(object component, string tag)
Parameters
Type Name Description
System.Object component
System.String tag

Fields

| Improve this Doc View Source

Component

The component.

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

Tag

The tag associated with its component.

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

Methods

| Improve this Doc View Source

Deconstruct(out Object, out String)

Supports C# Deconstruction syntax.

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

Equals(ComponentTagPair)

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

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

Equals(Object)

True if the given object is a ComponentTagPair and has the same component 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((Object component, String tag))

Converts the tuple to an equivalent ComponentTagPair.

Declaration
public static ComponentTagPair FromTuple((object component, string tag) tuple)
Parameters
Type Name Description
System.ValueTuple<System.Object, System.String> tuple
Returns
Type Description
ComponentTagPair
| 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(ComponentTagPair)

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

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

ToString()

Returns a string representing the component 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 (object component, string tag) ToTuple()
Returns
Type Description
System.ValueTuple<System.Object, System.String>

Operators

| Improve this Doc View Source

Equality(ComponentTagPair, ComponentTagPair)

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

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

Implicit(ComponentTagPair to (Object component, String tag))

Implicitly converts a ComponentTagPair to an equivalent tuple.

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

Implicit((Object component, String tag) to ComponentTagPair)

Implicitly converts a tuple to its equivalent ComponentTagPair.

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

Inequality(ComponentTagPair, ComponentTagPair)

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

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

Implements

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

Extension Methods