Documentation
¶
Index ¶
- func InitConfigurator()
- func LoadConfiguration(fileName string)
- func Marshal(file string, data interface{})
- func MarshalImageLayer(fileName string, value *ImageLayerData)
- func MarshalImageMetadata(fileName string, imgLayer *ImageMetadata)
- func MarshalNavigator(fileName string, value *NavigatorData)
- func MarshalScene(fileName string, value *Scene)
- func ReadFile(fileName string) []byte
- func UnmarshalBytes(contents []byte, toType interface{})
- func UnmarshalFile(fileName string, toType interface{})
- func WriteFile(fileName string, data interface{})
- type ActionStageController
- type ActionStageControllerData
- type AudioState
- type AudioStateData
- func (s *AudioStateData) GetAudioFile() string
- func (s *AudioStateData) IncrementAudio() int32
- func (s *AudioStateData) IsAudioOnLoop() bool
- func (s *AudioStateData) ResetAudioCount() AudioState
- func (s *AudioStateData) SetAudioFile(fileName string) AudioState
- func (s *AudioStateData) SetAudioLoop(shouldLoop bool) AudioState
- type Engine
- type Font
- type FontData
- type FrameTracker
- type FrameTrackerData
- func (fd *FrameTrackerData) GetCurrentFrame() int32
- func (fd *FrameTrackerData) GetIdleFrames() int32
- func (fd *FrameTrackerData) GetMaxFrame() int32
- func (fd *FrameTrackerData) IncrementFrameCount() FrameTracker
- func (fd *FrameTrackerData) IsFrameOnLoop() bool
- func (fd *FrameTrackerData) ResetFrameCount()
- func (fd *FrameTrackerData) SetMaxFrame(maxFrame int32) FrameTracker
- func (fd *FrameTrackerData) SetRepeatFrame(repeatPerFrame int32) FrameTracker
- func (fd *FrameTrackerData) SetToLoop(repeat bool) FrameTracker
- func (fd *FrameTrackerData) UpdateIdleFrames(x, y int32) int32
- type ImageLayerData
- type ImageMetadata
- type Navigator
- type NavigatorData
- type Scene
- type TextLine
- type TextLineData
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func InitConfigurator ¶
func InitConfigurator()
TODO Refactor and remove Viper... Could add Reset or Reinitialize TBD...
func LoadConfiguration ¶
func LoadConfiguration(fileName string)
func MarshalImageLayer ¶
func MarshalImageLayer(fileName string, value *ImageLayerData)
func MarshalImageMetadata ¶
func MarshalImageMetadata(fileName string, imgLayer *ImageMetadata)
func MarshalNavigator ¶
func MarshalNavigator(fileName string, value *NavigatorData)
func MarshalScene ¶
func UnmarshalBytes ¶
func UnmarshalBytes(contents []byte, toType interface{})
func UnmarshalFile ¶
func UnmarshalFile(fileName string, toType interface{})
Types ¶
type ActionStageController ¶
type ActionStageController interface {
CheckBehaviorColorAt(x, y int32) color.Color
SetControlMap(image *image.Image, width, height int) ActionStageController
Load(data *ImageLayerData) ActionStageController
}
type ActionStageControllerData ¶
type ActionStageControllerData struct {
// contains filtered or unexported fields
}
func (*ActionStageControllerData) CheckBehaviorColorAt ¶
func (a *ActionStageControllerData) CheckBehaviorColorAt(x, y int32) color.Color
func (*ActionStageControllerData) Load ¶
func (a *ActionStageControllerData) Load(data *ImageLayerData) ActionStageController
TODO This shoudl probably be the ImageMetadata and not layer. Not sure if a behavior map would have more than one layer but it is possible. In that case we'll likely need different behavior map types.
func (*ActionStageControllerData) SetControlMap ¶
func (a *ActionStageControllerData) SetControlMap(i *image.Image, width, height int) ActionStageController
type AudioState ¶
type AudioState interface {
SetAudioFile(fileName string) AudioState
SetAudioLoop(shouldLoop bool) AudioState
IsAudioOnLoop() bool
GetAudioFile() string
IncrementAudio() int32
ResetAudioCount() AudioState
}
func NewAudioState ¶
func NewAudioState(fileName string, loop bool) AudioState
type AudioStateData ¶
type AudioStateData struct {
AudioFile string `yaml:"AudioFile"`
LoopAudio bool `yaml:"LoopAudio"`
// contains filtered or unexported fields
}
func CreateTestAudioData ¶
func CreateTestAudioData() AudioStateData
func (*AudioStateData) GetAudioFile ¶
func (s *AudioStateData) GetAudioFile() string
func (*AudioStateData) IncrementAudio ¶
func (s *AudioStateData) IncrementAudio() int32
func (*AudioStateData) IsAudioOnLoop ¶
func (s *AudioStateData) IsAudioOnLoop() bool
func (*AudioStateData) ResetAudioCount ¶
func (s *AudioStateData) ResetAudioCount() AudioState
func (*AudioStateData) SetAudioFile ¶
func (s *AudioStateData) SetAudioFile(fileName string) AudioState
func (*AudioStateData) SetAudioLoop ¶
func (s *AudioStateData) SetAudioLoop(shouldLoop bool) AudioState
type Engine ¶
type Engine interface {
Start()
}
TODO Determine common lifecycle or handler mechanisms that any Engine implementation must provide.
type Font ¶
type FontData ¶
///////////////////////////////////////////////////////////////////////////////
func (*FontData) GetFontSize ¶
func (*FontData) SetFontSize ¶
type FrameTracker ¶
type FrameTracker interface {
SetMaxFrame(maxFrame int32) FrameTracker
SetRepeatFrame(repeatPerFrame int32) FrameTracker
GetCurrentFrame() int32
GetMaxFrame() int32
SetToLoop(bool) FrameTracker
UpdateIdleFrames(x, y int32) int32
GetIdleFrames() int32
IsFrameOnLoop() bool
IncrementFrameCount() FrameTracker
ResetFrameCount()
}
func NewFrameData ¶
func NewFrameData() FrameTracker
Most data is set once at start up so limited Setters.
type FrameTrackerData ¶
type FrameTrackerData struct {
CurrentFrame int32 `yaml:"CurrentFrame"`
MaxFrame int32 `yaml:"MaxFrame"`
RepeatPerFrame int32 `yaml:"RepeatPerFrame"`
CurrentFrameRepeats int32 `yaml:"CurrentFrameRepeats"`
IdleFrames int32 `yaml:"IdleFrames"`
LoopFrames bool `yaml:"LoopFrames"`
}
func CreateTestFrameTrackerData ¶
func CreateTestFrameTrackerData() FrameTrackerData
func (*FrameTrackerData) GetCurrentFrame ¶
func (fd *FrameTrackerData) GetCurrentFrame() int32
func (*FrameTrackerData) GetIdleFrames ¶
func (fd *FrameTrackerData) GetIdleFrames() int32
func (*FrameTrackerData) GetMaxFrame ¶
func (fd *FrameTrackerData) GetMaxFrame() int32
func (*FrameTrackerData) IncrementFrameCount ¶
func (fd *FrameTrackerData) IncrementFrameCount() FrameTracker
func (*FrameTrackerData) IsFrameOnLoop ¶
func (fd *FrameTrackerData) IsFrameOnLoop() bool
func (*FrameTrackerData) ResetFrameCount ¶
func (fd *FrameTrackerData) ResetFrameCount()
func (*FrameTrackerData) SetMaxFrame ¶
func (fd *FrameTrackerData) SetMaxFrame(maxFrame int32) FrameTracker
func (*FrameTrackerData) SetRepeatFrame ¶
func (fd *FrameTrackerData) SetRepeatFrame(repeatPerFrame int32) FrameTracker
func (*FrameTrackerData) SetToLoop ¶
func (fd *FrameTrackerData) SetToLoop(repeat bool) FrameTracker
func (*FrameTrackerData) UpdateIdleFrames ¶
func (fd *FrameTrackerData) UpdateIdleFrames(x, y int32) int32
type ImageLayerData ¶
type ImageLayerData struct {
LayerMetadata []*ImageMetadata `yaml:"LayerMetadata"`
}
func UnmarshalImageLayer ¶
func UnmarshalImageLayer(fileName string) *ImageLayerData
type ImageMetadata ¶
type ImageMetadata struct {
ImageFileName string `yaml:"ImageFileName"`
X int32 `yaml:"X"`
Y int32 `yaml:"Y"`
Width int32 `yaml:"Width"`
Height int32 `yaml:"Height"`
HorizontalFlip bool `yaml:"HorizontalFlip"`
}
func UnmarshalImageMetadata ¶
func UnmarshalImageMetadata(fileName string) *ImageMetadata
type Navigator ¶
type Navigator interface {
ActionStageController
}
func CreateTestNavigator ¶
func CreateTestNavigator() Navigator
func NewLocation ¶
func NewLocation() Navigator
func NewNavigator ¶
func NewNavigator(x, y, xMove, yMove, maxXOffset, maxYOffset int32, controller ActionStageController) Navigator
type NavigatorData ¶
type NavigatorData struct {
}
/////////////////////////////////////////////////////////////////////////////
func UnmarshalNavigator ¶
func UnmarshalNavigator(fileName string) *NavigatorData
func (*NavigatorData) Add ¶
func (cl *NavigatorData) Add(x, y int32)
func (*NavigatorData) CalculateMoveIncrement ¶
func (cl *NavigatorData) CalculateMoveIncrement(moveToX, moveToY int32) (x, y int32)
This is in the middle of refactoring.
func (*NavigatorData) GetCurrentPoint ¶
func (cl *NavigatorData) GetCurrentPoint() (x, y int32)
Clone
func (*NavigatorData) MoveByIncrement ¶
func (cl *NavigatorData) MoveByIncrement(x, y int32)
func (*NavigatorData) MoveTowardMouse ¶
func (cl *NavigatorData) MoveTowardMouse(x, y int32)
type Scene ¶
type Scene struct {
WindowTitle string `yaml:"WindowTitle"`
WindowWidth int `yaml:"WindowWidth"`
WindowHeight int `yaml:"WindowHeight"`
RegisterKeys []rune `yaml:"RegisterKeys"`
Background *ImageLayerData `yaml:"Background"`
BehaviorMap *ImageLayerData `yaml:"BehaviorMap"`
Foreground *ImageLayerData `yaml:"Foreground"`
Actors []string `yaml:"Actors"`
}
///////////////////////////////////////////////////////////////////////////////
func UnmarshalScene ¶
type TextLine ¶
func NewTextLine ¶
type TextLineData ¶
///////////////////////////////////////////////////////////////////////////////
func (*TextLineData) GetText ¶
func (p *TextLineData) GetText() string