Class TwitchDeckManager

Namespace

ONITwitchLib.Core

Assembly

ONITwitchLib.dll

Provides methods to manipulate the deck of events

[PublicAPI]
public class TwitchDeckManager

Inheritance

object

TwitchDeckManager

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Instance

The instance of the deck manager.

[PublicAPI]
[NotNull]
public static TwitchDeckManager Instance { get; }

Property Value

TwitchDeckManager

Methods

AddGroup(EventGroup)

Adds an EventGroup of actions to the deck

[PublicAPI]
public void AddGroup(EventGroup group)

Parameters

group EventGroup

Draw()

Draws an EventInfo from the deck, shuffling if necessary.

[PublicAPI]
[MustUseReturnValue]
[CanBeNull]
public EventInfo Draw()

Returns

EventInfo

The drawn event.

GetGroup(string)

Gets the EventGroup with the name specified by name, if it exists in the deck.

[PublicAPI]
[MustUseReturnValue("This retrieves a group without modifying anything")]
[CanBeNull]
public EventGroup GetGroup(string name)

Parameters

name string

The name of the group to retrieve.

Returns

EventGroup

The group, if it exists, otherwise null.

GetGroups()

Gets all EventGroups registered in the deck.

[PublicAPI]
[Pure]
[NotNull]
public IEnumerable<EventGroup> GetGroups()

Returns

IEnumerable<EventGroup>

An enumerable containing the groups in the deck.