From 9dad40bafc429381a3cab5b538f25e877ebfd28b Mon Sep 17 00:00:00 2001 From: wulfheart Date: Tue, 15 Dec 2020 13:08:47 +0100 Subject: [PATCH] Added comment for method --- state/state.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/state/state.go b/state/state.go index 348a4af9..16130ffe 100644 --- a/state/state.go +++ b/state/state.go @@ -260,6 +260,9 @@ func (self *State) Next() (err error) { return } +// PreviouslyAppliedOrders contains all the orders which were applied during the processing of state.Next(). +// If it is empty there are no previous orders yet as you probably have not run state.Next() or instantiated the state otherwise. +// Note that the orders specified here do not necessarily succeed. Again: This function only lists the orders which were applied during the processing of state.Next(). func (self *State) PreviouslyAppliedOrders() map[godip.Province]godip.Adjudicator{ return self.previouslyAppliedOrders }