Specificities of the Lua implementation in Civ5 - Revision history

DonQuich at 12:09, 25 September 2012

2012-09-25T12:09:42Z

← Older revision		Revision as of 12:09, 25 September 2012
Line 4:		Line 4:
	The Civ5 implementation is based on Lua 5.1.4. However it has been modified, mainly for sandboxing purposes.		The Civ5 implementation is based on Lua 5.1.4. However it has been modified, mainly for sandboxing purposes.

	== Missing elements ==		= Missing elements =
	Those items do not exist in the Civ5 implmentation of Lua. See [http://www.lua.org/manual/5.1/#index Lua Reference#Index] if you want to learn what they are for.		Those items do not exist in the Civ5 implmentation of Lua. See [http://www.lua.org/manual/5.1/#index Lua Reference#Index] if you want to learn what they are for.

Line 32:		Line 32:


	== Include ==		= Include =
	Instead of the usual functions for loading and requiring a Lua file from another, Civ5 provides a custom function to do so: '''include'''.		Instead of the usual functions for loading and requiring a Lua file from another, Civ5 provides a custom function to do so: '''include'''.

DonQuich at 11:07, 24 September 2012

2012-09-24T11:07:36Z

← Older revision		Revision as of 11:07, 24 September 2012
Line 63:		Line 63:

	[[Category:Civ5 API]]		[[Category:Civ5 API]]
			[[Category:Civ5 Tutorials]]

DonQuich at 10:59, 24 September 2012

2012-09-24T10:59:31Z

← Older revision		Revision as of 10:59, 24 September 2012
Line 32:		Line 32:


	== ~~Includes~~ ==		== Include ==
	Instead of the usual functions for loading and requiring a Lua file from another, Civ5 provides a custom function to do so: '''include'''.		Instead of the usual functions for loading and requiring a Lua file from another, Civ5 provides a custom function to do so: '''include'''.

DonQuich at 10:44, 24 September 2012

2012-09-24T10:44:21Z

← Older revision		Revision as of 10:44, 24 September 2012
Line 40:		Line 40:
	* '''useRegex''': when true, the file argument will be treated as a [http://en.wikipedia.org/wiki/Regular_expression regular expression].		* '''useRegex''': when true, the file argument will be treated as a [http://en.wikipedia.org/wiki/Regular_expression regular expression].
	* '''returned value:''' an array that contains all the loaded files (a single one usually, many files if you did use a regular expression).		* '''returned value:''' an array that contains all the loaded files (a single one usually, many files if you did use a regular expression).


	<div class="civ5-example"><syntaxhighlight lang="lua">		<div class="civ5-example"><syntaxhighlight lang="lua">

DonQuich at 10:44, 24 September 2012

2012-09-24T10:44:06Z

← Older revision		Revision as of 10:44, 24 September 2012
Line 42:		Line 42:


	<~~syntaxhighlight lang="lua"~~ class="civ5-example">		<div class="civ5-example"><syntaxhighlight lang="lua">
	include("CityBannerManager")		include("CityBannerManager")
	include("CityBannerManager.lua")		include("CityBannerManager.lua")
Line 54:		Line 54:
	print("Loaded Popup - "..v);		print("Loaded Popup - "..v);
	end		end
	</syntaxhighlight>		</syntaxhighlight></div>

DonQuich at 10:31, 24 September 2012

2012-09-24T10:31:53Z

← Older revision		Revision as of 10:31, 24 September 2012
Line 2:		Line 2:


	The Civ5 implementation is based on Lua 5.1. However it has been modified, mainly for sandboxing purposes.		The Civ5 implementation is based on Lua 5.1.4. However it has been modified, mainly for sandboxing purposes.

	== Missing elements ==		== Missing elements ==

DonQuich at 11:13, 21 September 2012

2012-09-21T11:13:41Z

← Older revision		Revision as of 11:13, 21 September 2012
Line 1:		Line 1:
			''This page is a part of the [[Lua and UI Reference (Civ5)\|Lua and UI Reference]].''


	The Civ5 implementation is based on Lua 5.1. However it has been modified, mainly for sandboxing purposes.		The Civ5 implementation is based on Lua 5.1. However it has been modified, mainly for sandboxing purposes.

DonQuich at 11:32, 20 September 2012

2012-09-20T11:32:53Z

← Older revision		Revision as of 11:32, 20 September 2012
Line 25:		Line 25:
	* '''io'''		* '''io'''
	* '''package'''		* '''package'''
	* '''os''': it still exists but only contains the clock, date, time and difftime functions.		* '''os''': it still exists but only contains the '''clock''', '''date''', '''time''' and '''difftime''' functions.
	* <s>debug</s>: fortunately it has been added by Firaxis in May 2012. See [[Lua Debugging (Civ5)]]		* <s>debug</s>: fortunately it has been added by Firaxis in May 2012. See [[Lua Debugging (Civ5)]]

DonQuich at 11:31, 20 September 2012

2012-09-20T11:31:50Z

← Older revision		Revision as of 11:31, 20 September 2012
Line 9:		Line 9:

	====Missing functions====		====Missing functions====
	Use ''include'' instead of the "load*~~" "~~module" and "require" functions. See the next section for more informations.		Use '''include''' instead of the '''load*''', '''module''' and '''require''' functions. See the next section for more informations.
	* '''getfenv'''		* '''getfenv'''
	* '''load'''		* '''load'''
Line 31:		Line 31:
	== Includes ==		== Includes ==
	Instead of the usual functions for loading and requiring a Lua file from another, Civ5 provides a custom function to do so: '''include'''.		Instead of the usual functions for loading and requiring a Lua file from another, Civ5 provides a custom function to do so: '''include'''.

	====Usage====		====Usage====
	<code>table('''int''' => '''string''') include('''string''' file, '''bool''' useRegex = false)</code>		<code>table('''int''' => '''string''') include('''string''' file, '''bool''' useRegex = false)</code>

DonQuich: Created page with "The Civ5 implementation is based on Lua 5.1. However it has been modified, mainly for sandboxing purposes. == Missing elements == Those items do not exist in the Civ5 implmentat..."

2012-09-20T11:30:45Z

Created page with "The Civ5 implementation is based on Lua 5.1. However it has been modified, mainly for sandboxing purposes. == Missing elements == Those items do not exist in the Civ5 implmentat..."

New page

The Civ5 implementation is based on Lua 5.1. However it has been modified, mainly for sandboxing purposes.

== Missing elements ==
Those items do not exist in the Civ5 implmentation of Lua. See [http://www.lua.org/manual/5.1/#index Lua Reference#Index] if you want to learn what they are for.

====Missing globals====
* '''__G'''

====Missing functions====
Use ''include'' instead of the "load*" "module" and "require" functions. See the next section for more informations.
* '''getfenv'''
* '''load'''
* '''loadfile'''
* '''loadstring'''
* '''module'''
* '''require'''
* '''setfenv'''
* '''setfenv'''

====Missing objects====
For I/O, use the methods from {{Type5|UI}} and {{Type5|Modding}} instead.
* '''file'''
* '''io'''
* '''package'''
* '''os''': it still exists but only contains the clock, date, time and difftime functions.
* <s>debug</s>: fortunately it has been added by Firaxis in May 2012. See [[Lua Debugging (Civ5)]]

== Includes ==
Instead of the usual functions for loading and requiring a Lua file from another, Civ5 provides a custom function to do so: '''include'''.
====Usage====
<code>table('''int''' => '''string''') include('''string''' file, '''bool''' useRegex = false)</code>
* '''file''': the name of the file, with or without extension. It can also be a local path starting from "Assets\UI" (see examples). Finally, if useRegex is true, it can be a regular expression where the '''%''' character is used instead of '''\'''.
* '''useRegex''': when true, the file argument will be treated as a [http://en.wikipedia.org/wiki/Regular_expression regular expression].
* '''returned value:''' an array that contains all the loaded files (a single one usually, many files if you did use a regular expression).

<syntaxhighlight lang="lua" class="civ5-example">
include("CityBannerManager")
include("CityBannerManager.lua")
include("Ingame\\CityBannerManager.lua") -- loads Assets/UI/Ingame/CityBannerManager.lua
include("CityBanner%w+.lua", true) -- loads all files starting with "CityBanner" and ending with ".lua".

-- Loads all "*Popup.lua" files in Assets/UI/Ingame/PopupsGeneric.
-- Then we print a statement for each one of the included files.
local files = include("InGame\\PopupsGeneric\\%w+Popup.lua", true);
for i, v in ipairs(files) do
print("Loaded Popup - "..v);
end
</syntaxhighlight>

====Restrictions====
* Only the files that have been imported into the [[VFS (Civ5)|VFS]] may be included.
* Usually only the first eight characters are checked. This is likely only true if you do not specify the path. This means that if you registered two files named ''MapScannerA.lua'' and ''MapScannerB.lua'', using <code>include("MapScannerA")</code> could either load the A file or the B file!
* When called in reaction to an UI event, include can silently fail. For example if you use it inside a function and this function is called in reaction to a click on a button, include will report it has been successful but the globals declared in the included file will not be included. This does not happen if you call this function after a Context update or at the time the mod is loaded.

[[Category:Civ5 API]]