action

Documentation

Overview

Package action describes the valid actions that any character may take

Index

• type Action
  • func StringToAction(s string) Action
  • func (a Action) MarshalJSON() ([]byte, error)
  • func (a Action) String() string
  • func (a *Action) UnmarshalJSON(b []byte) error
• type AnimationState
  • func (a AnimationState) String() string
• type Eval
• type Evaluator
• type Failure
  • func (e Failure) MarshalJSON() ([]byte, error)
  • func (e Failure) String() string
  • func (e *Failure) UnmarshalJSON(b []byte) error
• type Info
  • func (a *Info) AnimationState() AnimationState
  • func (a *Info) CanQueueNext() bool
  • func (a *Info) CanUse(next Action) bool
  • func (a *Info) QueueAction(f func(), delay int)
  • func (a *Info) Tick() bool

Types

type Action

type Action int

const (
	InvalidAction Action = iota
	ActionSkill
	ActionBurst
	ActionAttack
	ActionCharge
	ActionHighPlunge
	ActionLowPlunge
	ActionAim
	ActionDash
	ActionJump
	// following action have to implementations
	ActionSwap
	ActionWalk
	ActionWait  // character should stand around and wait
	ActionDelay // delay before executing next action
	EndActionType
	// these are only used for frames purposes and that's why it's after end
	ActionSkillHoldFramesOnly
)

func StringToAction

func StringToAction(s string) Action

func (Action) MarshalJSON

func (a Action) MarshalJSON() ([]byte, error)

func (Action) String

func (a Action) String() string

func (*Action) UnmarshalJSON

func (a *Action) UnmarshalJSON(b []byte) error

type AnimationState

type AnimationState int

const (
	Idle AnimationState = iota
	NormalAttackState
	ChargeAttackState
	PlungeAttackState
	SkillState
	BurstState
	AimState
	DashState
	JumpState
	WalkState
	SwapState
)

func (AnimationState) String

func (a AnimationState) String() string

type Eval

type Eval struct {
	Char   keys.Char
	Action Action
	Param  map[string]int
}

Eval represents a sim action

type Evaluator

type Evaluator interface {
	NextAction() (*Eval, error) // NextAction should reuturn the next action, or nil if no actions left
	Continue()
	Exit() error
	Err() error
	Start()
}

Evaluator provides method for getting next action

type Failure

type Failure int

const (
	NoFailure Failure = iota
	SwapCD
	SkillCD
	BurstCD
	InsufficientEnergy
	InsufficientStamina
	CharacterDeceased // TODO: need chars to die first
	DashCD
)

func (Failure) MarshalJSON

func (e Failure) MarshalJSON() ([]byte, error)

func (Failure) String

func (e Failure) String() string

func (*Failure) UnmarshalJSON

func (e *Failure) UnmarshalJSON(b []byte) error

type Info

type Info struct {
	Frames              func(next Action) int `json:"-"`
	AnimationLength     int
	CanQueueAfter       int
	State               AnimationState
	FramePausedOnHitlag func() bool               `json:"-"`
	OnRemoved           func(next AnimationState) `json:"-"`
	// following are exposed only so we can log it properly
	TimePassed           float64
	NormalizedTimePassed float64
	UseNormalizedTime    func(next Action) bool
	// contains filtered or unexported fields
}

TODO: add a sync.Pool here to save some memory allocs

func (*Info) AnimationState

func (a *Info) AnimationState() AnimationState

func (*Info) CanQueueNext

func (a *Info) CanQueueNext() bool

func (*Info) CanUse

func (a *Info) CanUse(next Action) bool

func (*Info) QueueAction

func (a *Info) QueueAction(f func(), delay int)

func (*Info) Tick

func (a *Info) Tick() bool