aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Fischer <florian.fischer@muhq.space>2025-06-25 11:11:36 -0500
committerFlorian Fischer <florian.fischer@muhq.space>2025-07-03 22:01:22 -0400
commit7db18a534591360e8ca2b38ad87752fdd56f33be (patch)
tree4979dfb6a5406cc60e75c7e850b9a2346ad6a39d
parent908e517210d536cc31b84abcd1bf711dc01a60f4 (diff)
downloadmuhqs-game-7db18a534591360e8ca2b38ad87752fdd56f33be.tar.gz
muhqs-game-7db18a534591360e8ca2b38ad87752fdd56f33be.zip
improve interface documentation
-rw-r--r--go/game/action.go7
1 files changed, 5 insertions, 2 deletions
diff --git a/go/game/action.go b/go/game/action.go
index f0dc5ca8..62703180 100644
--- a/go/game/action.go
+++ b/go/game/action.go
@@ -27,16 +27,19 @@ type (
)
type Action interface {
- Source() interface{}
+ Source() any
Controller() *Player
Speed() ActionSpeed
GameState() *LocalState
Targets() *Targets
- Target() *Target // Shortcut for to select the first target
+ // Shortcut for the first target
+ Target() *Target
NeedsActionCostChoice() bool
CheckTargets(*LocalState) error
+ // Check if an actions play costs can be payed and if so pays them
PayCosts(s *LocalState) bool
+ // Apply an actions effects to the game state
resolve(s *LocalState)
String() string
}