ningen

README

ningen

Abstracted helpful functions and packages to aid in Discord client development.

Documentation

Overview

Package ningen contains a set of helpful functions and packages to aid in making a Discord client.

Index

• type Connected
• type State
  • func FromState(s *state.State) (*State, error)
  • func (s *State) MessageMentions(msg discord.Message) bool
  • func (s *State) Open() error
  • func (s *State) PrivateChannels() ([]discord.Channel, error)

Types

type Connected

type Connected struct {
	Event gateway.Event
}

Connected is an event that's sent on Ready or Resumed. The event arrives before all ningen's handlers are called.

type State

type State struct {
	*state.State
	*handler.Handler

	// nil before Open().
	NoteState         *note.State
	ReadState         *read.State
	MutedState        *mute.State
	EmojiState        *emoji.State
	MemberState       *member.State
	RelationshipState *relationship.State
	// contains filtered or unexported fields
}

func FromState

func FromState(s *state.State) (*State, error)

FromState wraps a normal state.

func (*State) MessageMentions

func (s *State) MessageMentions(msg discord.Message) bool

func (*State) Open

func (s *State) Open() error

func (*State) PrivateChannels

func (s *State) PrivateChannels() ([]discord.Channel, error)