Editing Mod API Reference:GameOrderCustom

'''GameOrderCustom''':  Subclass of [[Mod API Reference:GameOrder|GameOrder]].  This order does nothing on its own, but it can be used by mods for custom orders.  GameOrderCustom is typically sent up from clients to the server, in contrast to [[Mod API Reference:GameOrderEvent|GameOrderEvent]] which is typically sent down from the server to clients.
* '''Message''' ''string'': The message that will appear in the orders list.  This is what players see.
* '''Payload''' ''string'': Data the mod wishes to store along with this order, but does not want players to see.
* '''CostOpt''' ''Table<[[Mod API Reference:ResourceType|ResourceType]] (enum),integer>'': Defines how much gold the order will cost the player in a [[Commerce]] game.  This should only be set in commerce games.  If CostOpt is set to nil, then it's assumed to be the same as having a cost of 0.   The game will take care of taking the player's resources away correctly, both on the client and server, when inserting an order with a cost into their orders list.
* '''OccursInPhaseOpt''' ''[[Mod API Reference:Nullable|Nullable]]<[[Mod API Reference:TurnPhase|TurnPhase]] (enum)>'':  If not nil, then orders will be forced to be placed in this phase.  Players will not be able to move this order above an order of a lower phase, or below an order of a higher phase.  Added in v5.22.0.

[[Mod_Security|Mod security]] should be applied to [[Mod_Hooks|Mod Hooks]] working with this card

* '''WL.GameOrderCustom.Create'''('''playerID''' ''[[Mod API Reference:PlayerID|PlayerID]]'', '''message''' ''string'', '''payload''' ''string'', '''costOpt''' ''Table<[[Mod API Reference:ResourceType|ResourceType]] (enum),integer>'') (static) returns [[Mod API Reference:GameOrderCustom|GameOrderCustom]]:
[[Category:Mod API Reference]]