component

Documentation

Index

• type CharacterAttachmentComponent
  • func NewCharacterAttachmentComponent(f *grf.File, conf CharacterAttachmentComponentConfig) (*CharacterAttachmentComponent, error)
• type CharacterAttachmentComponentConfig
• type CharacterAttachmentComponentFace
• type CharacterSpriteRenderInfoComponent
  • func NewCharacterSpriteRenderInfoComponent() *CharacterSpriteRenderInfoComponent
• type CharacterSpriteRenderInfoComponentFace
• type CharacterStateComponent
• type CharacterStateComponentFace

Types

type CharacterAttachmentComponent

type CharacterAttachmentComponent struct {
	Files map[character.AttachmentType]grf.ActionSpriteFilePair
}

CharacterAttachmentComponent defines a component that holds state about character character attachments (shadow, body, head...).

func NewCharacterAttachmentComponent

func NewCharacterAttachmentComponent(
	f *grf.File,
	conf CharacterAttachmentComponentConfig,
) (*CharacterAttachmentComponent, error)

type CharacterAttachmentComponentConfig

type CharacterAttachmentComponentConfig struct {
	Gender           character.GenderType
	JobSpriteID      jobspriteid.Type
	HeadIndex        character.HeadIndex
	EnableShield     bool
	ShieldSpriteName string // Loaded from GRF
}

type CharacterAttachmentComponentFace

type CharacterAttachmentComponentFace interface {
	GetCharacterAttachmentComponent() *CharacterAttachmentComponent
}

type CharacterSpriteRenderInfoComponent

type CharacterSpriteRenderInfoComponent struct {
	ActionIndex        actionindex.Type
	AnimationDelay     time.Duration
	AnimationEndsAt    time.Time
	AnimationStartedAt time.Time
	Direction          directiontype.Type
	ForcedDuration     time.Duration
	FPSMultiplier      float64
	IsStandingBy       bool
}

func NewCharacterSpriteRenderInfoComponent

func NewCharacterSpriteRenderInfoComponent() *CharacterSpriteRenderInfoComponent

type CharacterSpriteRenderInfoComponentFace

type CharacterSpriteRenderInfoComponentFace interface {
	GetCharacterSpriteRenderInfoComponent() *CharacterSpriteRenderInfoComponent
}

type CharacterStateComponent

type CharacterStateComponent struct {
	PlayMode             actionplaymode.Type
	PreviousState, State statetype.Type
}

CharacterStateComponent defines a component that holds information about character state, such as the action (Idle, Walking...), the direction (South, North...) and state.

type CharacterStateComponentFace

type CharacterStateComponentFace interface {
	GetCharacterStateComponent() *CharacterStateComponent
}