The scenario library - Revision history

Prof. Garfield: Added onLoad and OnSave events

2019-08-15T20:05:08Z

Added onLoad and OnSave events

← Older revision		Revision as of 20:05, 15 August 2019
Line 11:		Line 11:

	<code>civ.scen.onUnitKilled(function (loser, winner) -> void)</code>		<code>civ.scen.onUnitKilled(function (loser, winner) -> void)</code>


			[[civ.scen.onLoad\|onLoad]]

			<code>civ.scen.onLoad(function (buffer) -> void)</code>

			Buffer is a string attached to the end of a saved game file. It can be unserialized back into a state table.

			[[civ.scen.onSave\|onSave]]

			<civ.scen.onSave( function () --> string)</code>

			The string returned is attached to the end of the saved game file.

Prof. Garfield at 03:28, 11 June 2019

2019-06-11T03:28:46Z

← Older revision		Revision as of 03:28, 11 June 2019
Line 81:		Line 81:
	[[civ.scen.onResolveCombat\|onResolveCombat]]		[[civ.scen.onResolveCombat\|onResolveCombat]]

	<code>civ.scen.onResolveCombat(function (defaultResolutionFunction, attacker~~, defender~~) -> boolean)</code>		<code>civ.scen.onResolveCombat(function (defaultResolutionFunction, defender, attacker) -> boolean)</code>

	Registers a function to be called during every combat turn. The first parameter of the callback is the default resolution function, as implemented by the game. It takes the attacker and defender as parameters. You can call this to produce a result for cases you don't need to handle yourself.		Registers a function to be called during every combat turn. The first parameter of the callback is the default resolution function, as implemented by the game. It takes the attacker and defender as parameters. You can call this to produce a result for cases you don't need to handle yourself.

Prof. Garfield at 19:23, 23 May 2019

2019-05-23T19:23:42Z

← Older revision		Revision as of 19:23, 23 May 2019
Line 10:		Line 10:
	[[civ.scen.onUnitKilled\|onUnitKilled]]		[[civ.scen.onUnitKilled\|onUnitKilled]]

	<code>civ.scen.onUnitKilled(function (~~defender~~, ~~attacker~~) -> void)</code>		<code>civ.scen.onUnitKilled(function (loser, winner) -> void)</code>

Prof. Garfield: Added to category lua resources

2019-01-26T20:16:27Z

Added to category lua resources

← Older revision		Revision as of 20:16, 26 January 2019
Line 1:		Line 1:
	[[Category: Resources]]		[[Category:Lua Resources]]
	Back To [[TOTPP Functions]]		Back To [[TOTPP Functions]]

Prof. Garfield: Created Page

2019-01-01T23:13:21Z

Created Page

New page

[[Category: Resources]]
Back To [[TOTPP Functions]]

[[civ.scen.onTurn|onTurn]]

<code>civ.scen.onTurn(function (turn) -> void)</code>

[[civ.scen.onUnitKilled|onUnitKilled]]

<code>civ.scen.onUnitKilled(function (defender, attacker) -> void)</code>

[[civ.scen.onScenarioLoaded|onScenarioLoaded]]

<code>civ.scen.onScenarioLoaded(function () -> void)</code>

[[civ.scen.onNegotiation|onNegotiation]]

<code>civ.scen.onNegotiation(function (talker, listener) -> boolean)</code>

[[civ.scen.onSchism|onSchism]]

<code>civ.scen.onSchism(function (tribe) -> boolean)</code>

[[civ.scen.onCityTaken|onCityTaken]]

<code>civ.scen.onCityTaken(function (city, defender) -> void)</code>

[[civ.scen.onCityProduction|onCityProduction]]

<code>civ.scen.onCityProduction(function (city, prod) -> void)</code>

[[civ.scen.onCentauriArrival|onCentauriArrival]]

<code>civ.scen.onCentauriArrival(function (tribe) -> void)</code>

[[civ.scen.onCityDestroyed|onCityDestroyed]]

<code>civ.scen.onCityDestroyed(function (city) -> void)</code>

[[civ.scen.onBribeUnit|onBribeUnit]]

<code>civ.scen.onBribeUnit(function (unit, previousOwner) -> void)</code>

[[civ.scen.onGameEnds|onGameEnds]]

<code>civ.scen.onGameEnds(function (reason) -> boolean)</code>

[[civ.scen.onKeyPress|onKeyPress]]

<code>civ.scen.onKeyPress(function (keyCode) -> void)</code>

Registers a function to be called every time a key is pressed.

[[civ.scen.onActivateUnit|onActivateUnit]]

<code>civ.scen.onActivateUnit(function (unit, source) -> void)</code>

Registers a function to be called every time a unit is activated. The callback takes the unit activated as a parameter, and the source of unit activation. Source is `true` if activated by keyboard or mouse click, `false` if activated by the game itself.

[[civ.scen.onCityFounded|onCityFounded]]

<code>civ.scen.onCityFounded(function (city) -> void)</code>

Registers a function to be called every time a city is founded. The callback takes the city as a parameter.

[[civ.scen.onResolveCombat|onResolveCombat]]

<code>civ.scen.onResolveCombat(function (defaultResolutionFunction, attacker, defender) -> boolean)</code>

Registers a function to be called during every combat turn. The first parameter of the callback is the default resolution function, as implemented by the game. It takes the attacker and defender as parameters. You can call this to produce a result for cases you don't need to handle yourself.
Return `true` to continue combat, `false` to stop.

[[civ.scen.onCanBuild|onCanBuild]]

<code>civ.scen.onCanBuild(function (defaultBuildFunction, city, item) -> boolean)</code>

Registers a function to be called every time a check is done whether a city can build something or not. It is called for all unit types, improvements and wonders. The first parameter of the callback is the default build function, as implemented by the game. It takes the city and item as parameters. You can call this to produce a result for cases you don't need to handle yourself. `item` can be a unittype, improvement or wonder.
Return `true` if `city` is allowed to produce `item`, `false` if not.