Mod API Reference:GameOrderCustom - Revision history

Fizzer at 22:12, 29 March 2025

2025-03-29T22:12:16Z

← Older revision		Revision as of 22:12, 29 March 2025
Line 8:		Line 8:
	* '''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. Note: custom turn phases cannot be used in versions 5.31 or later.		* '''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. Note: custom turn phases cannot be used in versions 5.31 or later.
	* '''TerritoryAnnotationsOpt''' ''Table<[[Mod API Reference:TerritoryID\|TerritoryID]],[[Mod API Reference:TerritoryAnnotation\|TerritoryAnnotation]]>'': When the order is selected in the orders list by the player, these messages will be presented on top of the territories specified. (Added in version 5.34.1)		* '''TerritoryAnnotationsOpt''' ''Table<[[Mod API Reference:TerritoryID\|TerritoryID]],[[Mod API Reference:TerritoryAnnotation\|TerritoryAnnotation]]>'': When the order is selected in the orders list by the player, these messages will be presented on top of the territories specified. (Added in version 5.34.1)
			* '''JumpToActionSpotOpt''' ''[[Mod API Reference:RectangleVM\|RectangleVM]]'': If specified, this will be the spot on the map that the map focuses on when the player clicks on this event in the orders list. Specify coordinates on the map, which you can get by looking at a [[Mod API Reference:TerritoryDetails\|TerritoryDetails]] object. (Added in version 5.34.1)

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

Fizzer at 22:11, 29 March 2025

2025-03-29T22:11:20Z

← Older revision		Revision as of 22:11, 29 March 2025
Line 7:		Line 7:
	* '''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.		* '''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. Note: custom turn phases cannot be used in versions 5.31 or later.		* '''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. Note: custom turn phases cannot be used in versions 5.31 or later.
			* '''TerritoryAnnotationsOpt''' ''Table<[[Mod API Reference:TerritoryID\|TerritoryID]],[[Mod API Reference:TerritoryAnnotation\|TerritoryAnnotation]]>'': When the order is selected in the orders list by the player, these messages will be presented on top of the territories specified. (Added in version 5.34.1)

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

DanWL60: Note about custom turn phases not allowed in newer clients

2025-01-30T22:51:43Z

Note about custom turn phases not allowed in newer clients

← Older revision		Revision as of 22:51, 30 January 2025
Line 6:		Line 6:
	* '''Payload''' ''string'': Data the mod wishes to store along with this order, but does not want players to 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.		* '''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.		* '''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. Note: custom turn phases cannot be used in versions 5.31 or later.

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

Kaninchen: Forgot to remove that part yesterday

2024-04-18T16:58:22Z

Forgot to remove that part yesterday

← Older revision		Revision as of 16:58, 18 April 2024
Line 7:		Line 7:
	* '''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.		* '''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.		* '''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.
	~~'''Important to note'''~~

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

Fizzer: Reverted edits by Fizzer (talk) to last revision by Kaninchen

2024-04-17T21:48:31Z

Reverted edits by Fizzer (talk) to last revision by Kaninchen

← Older revision		Revision as of 21:48, 17 April 2024
Line 9:		Line 9:
	'''Important to note'''		'''Important to note'''

	~~The Server~~ [[Mod ~~Hooks~~]] ~~which accept the '''GameOrderCustom'''~~ should ~~only depend on the payload, as hackers may modify all fields ('''Message''', '''Payload''', '''CostOpt''' and '''OccursInPhaseOpt''')~~ to gain an advantage. Note that, since hackers can modify '''Payload''' too, it is essential to verify that it was even possible for the player to send the received '''Payload''' in the first place. All other Fields should be recreated by the Server.		[[Mod_Security\|Mod security]] should be applied to [[Mod_Hooks\|Mod Hooks]] working with this card
	~~== Functions ==~~

	* '''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]]:		* '''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]]		[[Category:Mod API Reference]]

Fizzer: Reverted edits by Kaninchen (talk) to last revision by DanWL60

2024-04-17T21:46:01Z

Reverted edits by Kaninchen (talk) to last revision by DanWL60

← Older revision		Revision as of 21:46, 17 April 2024
Line 9:		Line 9:
	'''Important to note'''		'''Important to note'''

	[[~~Mod_Security\|~~Mod ~~security~~]] should be ~~applied to [[Mod_Hooks\|Mod Hooks]] working with this card~~		The Server [[Mod Hooks]] which accept the '''GameOrderCustom''' should only depend on the payload, as hackers may modify all fields ('''Message''', '''Payload''', '''CostOpt''' and '''OccursInPhaseOpt''') to gain an advantage. Note that, since hackers can modify '''Payload''' too, it is essential to verify that it was even possible for the player to send the received '''Payload''' in the first place. All other Fields should be recreated by the Server.
			== Functions ==

	* '''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]]:		* '''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]]		[[Category:Mod API Reference]]

Kaninchen: removed text about hackers, replaced with a link to the Mod Security wiki page

2024-04-17T21:10:55Z

removed text about hackers, replaced with a link to the Mod Security wiki page

← Older revision		Revision as of 21:10, 17 April 2024
Line 9:		Line 9:
	'''Important to note'''		'''Important to note'''

	~~The Server~~ [[Mod ~~Hooks~~]] ~~which accept the '''GameOrderCustom'''~~ should ~~only depend on the payload, as hackers may modify all fields ('''Message''', '''Payload''', '''CostOpt''' and '''OccursInPhaseOpt''')~~ to gain an advantage. Note that, since hackers can modify '''Payload''' too, it is essential to verify that it was even possible for the player to send the received '''Payload''' in the first place. All other Fields should be recreated by the Server.		[[Mod_Security\|Mod security]] should be applied to [[Mod_Hooks\|Mod Hooks]] working with this card
	~~== Functions ==~~

	* '''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]]:		* '''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]]		[[Category:Mod API Reference]]

DanWL60 at 00:18, 2 April 2024

2024-04-02T00:18:55Z

← Older revision		Revision as of 00:18, 2 April 2024
Line 9:		Line 9:
	'''Important to note'''		'''Important to note'''

	The Server [[~~Mod_Hooks~~]] which accept the '''GameOrderCustom''' should only depend on the payload, as hackers may modify all fields ('''Message''', '''Payload''', '''CostOpt''' and '''OccursInPhaseOpt''') to gain an advantage. Note that, since hackers can modify '''Payload''' too, it is essential to verify that it was even possible for the player to send the received '''Payload''' in the first place. All other Fields should be recreated by the Server.		The Server [[Mod Hooks]] which accept the '''GameOrderCustom''' should only depend on the payload, as hackers may modify all fields ('''Message''', '''Payload''', '''CostOpt''' and '''OccursInPhaseOpt''') to gain an advantage. Note that, since hackers can modify '''Payload''' too, it is essential to verify that it was even possible for the player to send the received '''Payload''' in the first place. All other Fields should be recreated by the Server.
	== Functions ==		== Functions ==

	* '''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]]:		* '''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]]		[[Category:Mod API Reference]]

Kaninchen: Added a warning due to possible hacking

2024-03-19T16:31:05Z

Added a warning due to possible hacking

← Older revision		Revision as of 16:31, 19 March 2024
Line 7:		Line 7:
	* '''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.		* '''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.		* '''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.
			'''Important to note'''

			The Server [[Mod_Hooks]] which accept the '''GameOrderCustom''' should only depend on the payload, as hackers may modify all fields ('''Message''', '''Payload''', '''CostOpt''' and '''OccursInPhaseOpt''') to gain an advantage. Note that, since hackers can modify '''Payload''' too, it is essential to verify that it was even possible for the player to send the received '''Payload''' in the first place. All other Fields should be recreated by the Server.
	== Functions ==		== Functions ==

	* '''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]]:		* '''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]]		[[Category:Mod API Reference]]

Fizzer at 14:00, 28 December 2022

2022-12-28T14:00:35Z

← Older revision		Revision as of 14:00, 28 December 2022
Line 6:		Line 6:
	* '''Payload''' ''string'': Data the mod wishes to store along with this order, but does not want players to 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.		* '''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.

	== Functions ==		== Functions ==

← Older revision		Revision as of 22:12, 29 March 2025
Line 8:		Line 8:
	* '''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. Note: custom turn phases cannot be used in versions 5.31 or later.		* '''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. Note: custom turn phases cannot be used in versions 5.31 or later.
	* '''TerritoryAnnotationsOpt''' ''Table<[[Mod API Reference:TerritoryID\|TerritoryID]],[[Mod API Reference:TerritoryAnnotation\|TerritoryAnnotation]]>'': When the order is selected in the orders list by the player, these messages will be presented on top of the territories specified. (Added in version 5.34.1)		* '''TerritoryAnnotationsOpt''' ''Table<[[Mod API Reference:TerritoryID\|TerritoryID]],[[Mod API Reference:TerritoryAnnotation\|TerritoryAnnotation]]>'': When the order is selected in the orders list by the player, these messages will be presented on top of the territories specified. (Added in version 5.34.1)
			* '''JumpToActionSpotOpt''' ''[[Mod API Reference:RectangleVM\|RectangleVM]]'': If specified, this will be the spot on the map that the map focuses on when the player clicks on this event in the orders list. Specify coordinates on the map, which you can get by looking at a [[Mod API Reference:TerritoryDetails\|TerritoryDetails]] object. (Added in version 5.34.1)

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

← Older revision		Revision as of 22:11, 29 March 2025
Line 7:		Line 7:
	* '''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.		* '''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. Note: custom turn phases cannot be used in versions 5.31 or later.		* '''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. Note: custom turn phases cannot be used in versions 5.31 or later.
			* '''TerritoryAnnotationsOpt''' ''Table<[[Mod API Reference:TerritoryID\|TerritoryID]],[[Mod API Reference:TerritoryAnnotation\|TerritoryAnnotation]]>'': When the order is selected in the orders list by the player, these messages will be presented on top of the territories specified. (Added in version 5.34.1)

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

← Older revision		Revision as of 16:58, 18 April 2024
Line 7:		Line 7:
	* '''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.		* '''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.		* '''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.
	~~'''Important to note'''~~

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