events

Documentation

Overview

Package events contain the events for our engine

Index

• type ChangeGameStage
• type GameCloseEvent
• type KeyEvent
• type MouseMoveEvent
• type MouseUpEvent
• type MusicStateChangeEvent
• type PauseMusicEvent
• type PlayMusicEvent
• type PlaySoundEvent
• type ResumeMusicEvent
• type StopMusicEvent

Types

type ChangeGameStage

type ChangeGameStage struct {
	// Stage is the name of the stage to change to, it must be created with engine.AddGameStage
	Stage string
}

ChangeGameStage is an event that indicates that change game stage, all entities, systems, sprites sheets and textures will be removed. If the Stage does not exist the game.Run method will return an error. Stages must be created with engine.AddGameStage

type GameCloseEvent

type GameCloseEvent struct{}

GameCloseEvent is an event that indicates that game need to close

type KeyEvent

type KeyEvent struct {
	Key    device.Key
	Status device.KeyStatus
}

KeyEvent this event triggers when the status of a key change

type MouseMoveEvent

type MouseMoveEvent struct {
	geometry.Point
}

MouseMoveEvent is an event that indicates that the mouse is moving

type MouseUpEvent

type MouseUpEvent struct {
	// Point is the geometry.Point where the mouse is  when released
	Point geometry.Point
	// MouseButton is the device.MouseButton been released
	MouseButton device.MouseButton
}

MouseUpEvent is an event that indicates that the mouse is release

type MusicStateChangeEvent

type MusicStateChangeEvent struct {
	Name string                  // Name of the music
	Old  audio.MusicPlayingState // Old is the previous audio.MusicPlayingState
	New  audio.MusicPlayingState // New is the current audio.MusicPlayingState
}

MusicStateChangeEvent is a event trigger when a music state change

type PauseMusicEvent

type PauseMusicEvent struct {
	Name string
}

PauseMusicEvent is an event to pause a music stream

type PlayMusicEvent

type PlayMusicEvent struct {
	Name  string
	Loops int32
}

PlayMusicEvent is an event to play a music stream

type PlaySoundEvent

type PlaySoundEvent struct {
	Name string
}

PlaySoundEvent is an event to play a sound wave

type ResumeMusicEvent

type ResumeMusicEvent struct {
	Name string
}

ResumeMusicEvent is an event to resume a music stream

type StopMusicEvent

type StopMusicEvent struct {
	Name string
}

StopMusicEvent is an event to play a music stream