Empires Callbacks - Revision history

Andrewg: Andrewg moved page AEP Callbacks to Empires Callbacks

2019-07-08T20:07:31Z

Andrewg moved page AEP Callbacks to Empires Callbacks

← Older revision	Revision as of 20:07, 8 July 2019
(No difference)

Andrewg at 20:07, 8 July 2019

2019-07-08T20:07:18Z

← Older revision		Revision as of 20:07, 8 July 2019
Line 38:		Line 38:
	=== UI_UPDATE_GROUP(groupID, zoom, mouseX, mouseY, buttons) ===		=== UI_UPDATE_GROUP(groupID, zoom, mouseX, mouseY, buttons) ===
	Called once per frame for each group visible on the map to update the UIGroup layout for the current frame. zoom is the height of the camera above the ground. Return <= 0 if there is nothing to be drawn. If the mouse is over any visible component of the UI, GetMouseGroup will return that group ID as it would if the mouse was over the group's on-map 3d object. The root of the UI is automatically placed to draw immediately below the base of the group's on-map 3d object.		Called once per frame for each group visible on the map to update the UIGroup layout for the current frame. zoom is the height of the camera above the ground. Return <= 0 if there is nothing to be drawn. If the mouse is over any visible component of the UI, GetMouseGroup will return that group ID as it would if the mouse was over the group's on-map 3d object. The root of the UI is automatically placed to draw immediately below the base of the group's on-map 3d object.

	~~=== UI_UPDATE_CITYSCAPE(regionID, zoom, mouseX, mouseY, buttons) ===~~
	Called once per frame for each region visible on the map to update the UICity layout for the current frame. zoom is the height of the camera above the ground. Return <= 0 if there is nothing to be drawn. If the mouse is over any visible component of the UI, GetMouseStructure will return the ID of structure in that region as it would if the mouse was over the structure's on-map 3d object. The root of the UI is automatically placed to draw immediately below anchor 0 of the region.

	== Scenario.bsf callbacks ==		== Scenario.bsf callbacks ==

Andrewg: /* New Game Example */

2018-05-16T17:48:44Z

New Game Example

← Older revision		Revision as of 17:48, 16 May 2018
Line 71:		Line 71:
	# StartMap		# StartMap
	# StartScenario		# StartScenario
	# ~~StartStructureVisuals~~ x X		# StartRegionVisuals x N
	# StartGroupVisuals x X		# StartGroupVisuals x N
			# show PreScenario UI (single player)
			## UpdateMap
			## UpdateScenario
			## repeat until script calls StartScenario command
	# StartTurn in Map.bsf		# StartTurn in Map.bsf
	# StartTurn in Scenario.bsf		# StartTurn in Scenario.bsf

Andrewg: /* StartScenario */

2018-01-10T22:58:52Z

StartScenario

← Older revision		Revision as of 22:58, 10 January 2018
Line 47:		Line 47:
	Called when a new game is started, immediately after InitMap.		Called when a new game is started, immediately after InitMap.

	=== StartScenario ===		=== StartScenario(flags) ===
	Called each time the scenario is opened (new game, loading a saved game), immediately after StartMap		Called each time the scenario is opened (new game, loading a saved game), immediately after StartMap. The flags parameter has the same meaning as in StartMap.

	=== StartTurn ===		=== StartTurn ===

Andrewg: /* StartMap */

2018-01-10T22:58:06Z

StartMap

← Older revision		Revision as of 22:58, 10 January 2018
Line 7:		Line 7:
	Called when a new game is started, immediately after InitScenario.		Called when a new game is started, immediately after InitScenario.

	=== StartMap ===		=== StartMap(flags) ===
	Called each time the scenario is opened (new game, loading a saved game, loading the scenario in the editor).		Called each time the scenario is opened (new game, loading a saved game, loading the scenario in the editor).

			Under some circumstances, StartMap can be called again during a play session, for example when a snapshot or replay state from an older play session is loaded. Bit 0 of the flags parameter will be set when this is the case, although generally the game should respond the same way.

	=== StartTurn ===		=== StartTurn ===

Andrewg at 17:05, 23 May 2017

2017-05-23T17:05:09Z

← Older revision		Revision as of 17:05, 23 May 2017
Line 25:		Line 25:
	Called each frame after all of the update callbacks. Primarily used for drawing UI elements over the map		Called each frame after all of the update callbacks. Primarily used for drawing UI elements over the map

	=== ~~StartGroup~~(id) ===		=== StartGroupVisuals(id) ===
	Expected to set up the visuals for a group (including call SetGroupAsset). Called at various points during game flow (expect it to be called multiple times as needed for the same group).		Expected to set up the visuals for a group (including call SetGroupAsset). Called at various points during game flow (expect it to be called multiple times as needed for the same group). Must not modify gameplay values for object.

	=== ~~StartStructure~~(id) ===		=== StartStructureVisuals(id) ===
	Expected to set up the visuals for a structure (including call SetStructureAsset). Called at various points during game flow (expect it to be called multiple times as needed for the same structure).		Expected to set up the visuals for a structure (including call SetStructureAsset). Called at various points during game flow (expect it to be called multiple times as needed for the same structure). Must not modify gameplay values for object.

	=== PathfindingData(region, group, ...) ===		=== PathfindingData(region, group, ...) ===
Line 69:		Line 69:
	# StartMap		# StartMap
	# StartScenario		# StartScenario
	# ~~StartStructure~~ x X		# StartStructureVisuals x X
	# ~~StartGroup~~ x X		# StartGroupVisuals x X
	# StartTurn in Map.bsf		# StartTurn in Map.bsf
	# StartTurn in Scenario.bsf		# StartTurn in Scenario.bsf
Line 94:		Line 94:
	# StartMap		# StartMap
	# StartScenario		# StartScenario
	# ~~StartStructure~~ x X		# StartStructureVisuals x X
	# ~~StartGroup~~ x X		# StartGroupVisuals x X
	# UpdateMap		# UpdateMap
	# UpdateScenario		# UpdateScenario

Andrewg at 23:03, 16 February 2017

2017-02-16T23:03:41Z

← Older revision		Revision as of 23:03, 16 February 2017
Line 33:		Line 33:
	=== PathfindingData(region, group, ...) ===		=== PathfindingData(region, group, ...) ===
	Request for connection info for a group leaving a region. For each region the group can enter from the requested region, the script must call SetPathfindingData.		Request for connection info for a group leaving a region. For each region the group can enter from the requested region, the script must call SetPathfindingData.

			=== UI_UPDATE_GROUP(groupID, zoom, mouseX, mouseY, buttons) ===
			Called once per frame for each group visible on the map to update the UIGroup layout for the current frame. zoom is the height of the camera above the ground. Return <= 0 if there is nothing to be drawn. If the mouse is over any visible component of the UI, GetMouseGroup will return that group ID as it would if the mouse was over the group's on-map 3d object. The root of the UI is automatically placed to draw immediately below the base of the group's on-map 3d object.

			=== UI_UPDATE_CITYSCAPE(regionID, zoom, mouseX, mouseY, buttons) ===
			Called once per frame for each region visible on the map to update the UICity layout for the current frame. zoom is the height of the camera above the ground. Return <= 0 if there is nothing to be drawn. If the mouse is over any visible component of the UI, GetMouseStructure will return the ID of structure in that region as it would if the mouse was over the structure's on-map 3d object. The root of the UI is automatically placed to draw immediately below anchor 0 of the region.

	== Scenario.bsf callbacks ==		== Scenario.bsf callbacks ==

Andrewg at 18:01, 10 February 2017

2017-02-10T18:01:26Z

← Older revision		Revision as of 18:01, 10 February 2017
Line 20:		Line 20:

	=== UpdateAI(faction) ===		=== UpdateAI(faction) ===
	Called for each AI controlled faction until it returns a non-zero value. It is expected to run a small slice AI planning each call. Called after UpdateScenario.		Called for each AI controlled faction until it returns a non-zero value. It is expected to run a small slice AI planning each call. Called after UpdateScenario. AI factions which have the INACTIVE attribute set to non-zero will be skipped.

	=== RenderMap ===		=== RenderMap ===

Andrewg at 22:37, 10 January 2017

2017-01-10T22:37:59Z

← Older revision		Revision as of 22:37, 10 January 2017
Line 12:		Line 12:
	=== StartTurn ===		=== StartTurn ===
	Called at the beginning of the planning phase of each turn.		Called at the beginning of the planning phase of each turn.

			=== EndTurn ===
			Called at the end of the resolution phase of each turn. Happens during the TurnResolveComplete command.

	=== UpdateMap(tick) ===		=== UpdateMap(tick) ===
Line 41:		Line 44:
	=== StartTurn ===		=== StartTurn ===
	Call each turn, immediately after Map.bsf StartTurn		Call each turn, immediately after Map.bsf StartTurn

			=== EndTurn ===
			Called each turn, immediately before Map.bsf EndTurn. Happens during the TurnResolveComplete command.

	=== UpdateScenario ===		=== UpdateScenario ===
Line 65:		Line 71:
	# RenderMap		# RenderMap
	# RenderScenario		# RenderScenario
			# UpdateMap
			# ...
			# UpdateMap
			# UpdateScenario
			# UpdateAI
			# ...
			# EndTurn in Scenario.bsf
			# EndTurn in Map.bsf
			# StartTurn in Map.bsf
			# StartTurn in Scenario.bsf
	# UpdateMap		# UpdateMap
	# ...		# ...

Andrewg at 20:38, 5 August 2016

2016-08-05T20:38:15Z

← Older revision		Revision as of 20:38, 5 August 2016
Line 50:		Line 50:
	== Callback sequence ==		== Callback sequence ==

	=== New Game ===		=== New Game Example ===

	# InitMap		# InitMap
Line 61:		Line 61:
	# StartTurn in Map.bsf		# StartTurn in Map.bsf
	# StartTurn in Scenario.bsf		# StartTurn in Scenario.bsf
			# UpdateMap
			# UpdateScenario
			# RenderMap
			# RenderScenario
	# UpdateMap		# UpdateMap
	# ...		# ...

	=== Loading Saved Game ===		=== Loading Saved Game Example ===

	# StartMap		# StartMap
Line 70:		Line 74:
	# StartStructure x X		# StartStructure x X
	# StartGroup x X		# StartGroup x X
			# UpdateMap
			# UpdateScenario
			# RenderMap
			# RenderScenario
	# UpdateMap		# UpdateMap
	# ...		# ...