LCOV - code coverage report
Current view: top level - activity - activity.go Coverage Total Hit
Test: coverage.lcov Lines: 93.5 % 77 72
Test Date: 2026-11-19 00:25:22 Functions: - 0 0

            Line data    Source code
       1              : package activity
       2              : 
       3              : import (
       4              :         "fmt"
       5              : 
       6              :         "github.com/kijimaD/ruins/internal/i18n"
       7              : 
       8              :         gc "github.com/kijimaD/ruins/internal/components"
       9              :         "github.com/kijimaD/ruins/internal/consts"
      10              :         "github.com/kijimaD/ruins/internal/logger"
      11              :         w "github.com/kijimaD/ruins/internal/world"
      12              :         "github.com/mlange-42/ark/ecs"
      13              : )
      14              : 
      15              : // log はactivityパッケージ用のロガー
      16              : var log = logger.New(logger.CategoryAction)
      17              : 
      18              : // GetBehavior は gc.Activity に永続化された BehaviorName から実装を復元する。
      19              : // 単なる名前と実装の対応付けで、毎回ゼロ値の新しいインスタンスを返す。
      20              : // Behavior は状態を持たない振る舞いの束なので、これで問題ない。着手後のライフサイクル
      21              : // Validate/Start/DoTurn/Finish/Canceled はこのゼロ値インスタンスで回るため、per-アクティビティの
      22              : // 状態はインスタンスのフィールドに持たず gc.Activity 側に持たせる。着手パラメータは
      23              : // NewXxxActivity 構築関数が引数から gc.Activity の Params へ書き込む。
      24              : //
      25              : // default 句は置かない。新しい BehaviorName を足したとき case 追加漏れを exhaustive linter に
      26              : // 検知させるため。未知の名前は switch を抜けた後のエラーで扱う。
      27              : func GetBehavior(name gc.BehaviorName) (Behavior, error) {
      28            1 :         switch name {
      29              :         case gc.BehaviorMove:
      30            1 :                 return &MoveBehavior{}, nil
      31              :         case gc.BehaviorMelee:
      32            1 :                 return &MeleeBehavior{}, nil
      33              :         case gc.BehaviorRest:
      34            1 :                 return &RestBehavior{}, nil
      35              :         case gc.BehaviorWait:
      36            1 :                 return &WaitBehavior{}, nil
      37              :         case gc.BehaviorPickup:
      38            1 :                 return &PickupBehavior{}, nil
      39              :         case gc.BehaviorDrop:
      40            1 :                 return &DropBehavior{}, nil
      41              :         case gc.BehaviorUseItem:
      42            1 :                 return &UseItemBehavior{}, nil
      43              :         case gc.BehaviorTalk:
      44            1 :                 return &TalkBehavior{}, nil
      45              :         case gc.BehaviorOpenDoor:
      46            1 :                 return &OpenDoorBehavior{}, nil
      47              :         case gc.BehaviorCloseDoor:
      48            1 :                 return &CloseDoorBehavior{}, nil
      49              :         case gc.BehaviorRead:
      50            0 :                 return &ReadBehavior{}, nil
      51              :         case gc.BehaviorShoot:
      52            1 :                 return &ShootBehavior{}, nil
      53              :         case gc.BehaviorReload:
      54            1 :                 return &ReloadBehavior{}, nil
      55              :         case gc.BehaviorSleep:
      56            1 :                 return &SleepBehavior{}, nil
      57              :         case gc.BehaviorSwap:
      58            1 :                 return &SwapBehavior{}, nil
      59              :         case gc.BehaviorDisassemble:
      60            0 :                 return &DisassembleBehavior{}, nil
      61              :         case gc.BehaviorSearch:
      62            1 :                 return &SearchBehavior{}, nil
      63            0 :         case gc.BehaviorPortal, gc.BehaviorStorage, gc.BehaviorIgnite, gc.BehaviorFeedFuel:
      64              :                 // ExecuteInteraction が直接処理する結果ラベルで、対応する Behavior 実装は持たない
      65              :         }
      66            1 :         return nil, fmt.Errorf("%w: %s", ErrBehaviorUnregistered, name)
      67              : }
      68              : 
      69              : // Behavior はアクティビティの実行を担当するインターフェース。
      70              : //
      71              : // 全メソッドは GetBehavior が毎回作るゼロ値インスタンスで回る。インスタンスは状態を持たず、
      72              : // per-アクティビティの状態はすべて gc.Activity に持たせる。着手時のパラメータは Behavior の
      73              : // フィールドではなく、NewXxxActivity 構築関数が引数から gc.Activity へ書き込む。
      74              : // そのため Behavior は状態を持たない振る舞いの束であり、構築とライフサイクルが分離している。
      75              : type Behavior interface {
      76              :         Info() Info
      77              :         Name() gc.BehaviorName
      78              :         // Validate は実行前提を検査する副作用のない純粋関数。失敗の種別を error の型で表す。
      79              :         // 返す error のうち *UserError だけがユーザ起因で、呼び出し側が Msg を gamelog へ出して
      80              :         // 操作を取り消す。弾切れ・敵接近・本が無い等がこれにあたる。
      81              :         // それ以外の error は致命的で、呼び出し側が伝播させる。構築ミスや不変条件違反、
      82              :         // 手番を得た actor の死亡などがこれにあたる。
      83              :         // 検証通過なら nil を返す。副作用はなく、gamelog も呼ばず panic もしない。
      84              :         Validate(comp *gc.Activity, actor ecs.Entity, world w.World) error
      85              :         Start(comp *gc.Activity, actor ecs.Entity, world w.World) error
      86              :         // DoTurn の error は Validate と同じく致命的で、呼び出し側がアクティビティを除去して伝播させる。
      87              :         // 構築ミスや不変条件違反がこれにあたる。敵の接近のような一時的な中断は Cancel して nil を返し、
      88              :         // 呼び出し側が Canceled を呼ぶ
      89              :         DoTurn(comp *gc.Activity, actor ecs.Entity, world w.World) error
      90              :         Finish(comp *gc.Activity, actor ecs.Entity, world w.World) error
      91              :         Canceled(comp *gc.Activity, actor ecs.Entity, world w.World) error
      92              : }
      93              : 
      94              : // Info はアクティビティのメタデータを保持する
      95              : type Info struct {
      96              :         Name            string // 表示名
      97              :         Description     string // 説明文
      98              :         Interruptible   bool   // 中断可能か
      99              :         Resumable       bool   // 中断後の再開可能か
     100              :         ActionPointCost int    // 1ターン毎のアクションポイントコスト
     101              :         TotalRequiredAP int    // アクティビティ完了に必要な総AP量
     102              : }
     103              : 
     104              : // NewActivity は名前と必要総量から新しいActivityコンポーネントを作成する。
     105              : // required は完了に必要な総量で、各構築関数が常に0以上を渡す。初回ステップで満ちれば即時アクションになる。
     106              : func NewActivity(name gc.BehaviorName, required int) *gc.Activity {
     107            1 :         return &gc.Activity{
     108            1 :                 BehaviorName: name,
     109            1 :                 State:        gc.ActivityStateRunning,
     110            1 :                 Progress:     gc.IntPool{Max: required},
     111            1 :         }
     112              : }
     113              : 
     114              : // perTurnAP はアクターが継続アクションへ今ターン注げるAPを返す。
     115              : // 毎ターン再計算するためAPの変動へ追従する。取得できない場合も進行が止まらないよう最低 1 を返す。
     116              : func perTurnAP(actor ecs.Entity, world w.World) int {
     117            1 :         ap, err := getEntityMaxAP(actor, world)
     118            1 :         if err != nil || ap < 1 {
     119            1 :                 return 1
     120            1 :         }
     121            1 :         return ap
     122              : }
     123              : 
     124              : // CanInterrupt はアクティビティが中断可能かを返す
     125              : func CanInterrupt(comp *gc.Activity) bool {
     126            1 :         behavior, err := GetBehavior(comp.BehaviorName)
     127            1 :         if err != nil {
     128            1 :                 return false
     129            1 :         }
     130            1 :         return behavior.Info().Interruptible && comp.State == gc.ActivityStateRunning
     131              : }
     132              : 
     133              : // CanResume はアクティビティが再開可能かを返す
     134              : func CanResume(comp *gc.Activity) bool {
     135            1 :         behavior, err := GetBehavior(comp.BehaviorName)
     136            1 :         if err != nil {
     137            1 :                 return false
     138            1 :         }
     139            1 :         return behavior.Info().Resumable && comp.State == gc.ActivityStatePaused
     140              : }
     141              : 
     142              : // Interrupt はアクティビティを中断する
     143              : func Interrupt(comp *gc.Activity, reason i18n.Msgid) error {
     144            1 :         if !CanInterrupt(comp) {
     145            1 :                 return fmt.Errorf("activity '%s' cannot be paused", GetDisplayName(comp))
     146            1 :         }
     147            1 :         comp.State = gc.ActivityStatePaused
     148            1 :         comp.CancelReason = reason
     149            1 :         return nil
     150              : }
     151              : 
     152              : // Resume はアクティビティを再開する
     153              : func Resume(comp *gc.Activity) error {
     154            1 :         if !CanResume(comp) {
     155            0 :                 return fmt.Errorf("activity '%s' cannot be resumed", GetDisplayName(comp))
     156            0 :         }
     157            1 :         comp.State = gc.ActivityStateRunning
     158            1 :         comp.CancelReason = ""
     159            1 :         return nil
     160              : }
     161              : 
     162              : // GetDisplayName は表示用の名前を返す
     163              : func GetDisplayName(comp *gc.Activity) string {
     164            1 :         behavior, err := GetBehavior(comp.BehaviorName)
     165            1 :         if err != nil {
     166            1 :                 return string(comp.BehaviorName)
     167            1 :         }
     168            1 :         return behavior.Info().Name
     169              : }
     170              : 
     171              : // IsActive はアクティビティがアクティブかを返す
     172              : func IsActive(comp *gc.Activity) bool {
     173            1 :         return comp.State == gc.ActivityStateRunning
     174            1 : }
     175              : 
     176              : // IsCompleted はアクティビティが完了しているかを返す
     177              : func IsCompleted(comp *gc.Activity) bool {
     178            1 :         return comp.State == gc.ActivityStateCompleted
     179            1 : }
     180              : 
     181              : // IsCanceled はアクティビティがキャンセルされているかを返す
     182              : func IsCanceled(comp *gc.Activity) bool {
     183            1 :         return comp.State == gc.ActivityStateCanceled
     184            1 : }
     185              : 
     186              : // GetProgressPercent は進捗率を0-100の値で返す
     187              : func GetProgressPercent(comp *gc.Activity) float64 {
     188            1 :         if comp.Progress.Max <= 0 {
     189            1 :                 return 100.0
     190            1 :         }
     191            1 :         return (float64(comp.Progress.Current) / float64(comp.Progress.Max)) * 100.0
     192              : }
     193              : 
     194              : // Complete はアクティビティを完了状態にする
     195              : func Complete(comp *gc.Activity) {
     196            1 :         comp.State = gc.ActivityStateCompleted
     197            1 : }
     198              : 
     199              : // Cancel はアクティビティをキャンセルする
     200              : func Cancel(comp *gc.Activity, reason i18n.Msgid) {
     201            1 :         comp.State = gc.ActivityStateCanceled
     202            1 :         comp.CancelReason = reason
     203            1 : }
     204              : 
     205              : // requireDestination はActivityのPlaceParamsからタイル座標を取得する。
     206              : // PlaceParamsが未設定の場合はエラーを返す
     207              : func requireDestination(comp *gc.Activity) (consts.Coord[consts.Tile], error) {
     208            1 :         p, ok := comp.Params.(*gc.PlaceParams)
     209            1 :         if !ok {
     210            1 :                 return consts.Coord[consts.Tile]{}, ErrParamsTypeMismatch
     211            1 :         }
     212            1 :         return consts.Coord[consts.Tile]{X: p.Destination.X, Y: p.Destination.Y}, nil
     213              : }
        

Generated by: LCOV version 2.0-1