LuaWML/Files - Revision history

Celtic Minstrel: Formatting fix

2021-02-12T13:33:23Z

Formatting fix

2021-02-12T13:32:58Z

Add move notice

2018-08-05T08:40:26Z

‎wesnoth.have_file(file_path, restrict_regular_file)

2018-08-05T08:39:49Z

‎wesnoth.have_file

2017-05-04T14:51:58Z

Update version notes (seems those were added earlier than I thought)

2017-05-04T14:51:17Z

Add read_file

2017-05-04T14:49:39Z

Document recently-added features

2016-03-11T03:43:00Z

2011-03-06T03:16:27Z

categorizing

2010-07-17T14:09:24Z

Clarified wording

← Older revision		Revision as of 13:33, 12 February 2021
Line 1:		Line 1:
−	{{~~Templaste:~~LuaMove}}	+	{{LuaMove}}

	This page describes the [[LuaWML]] functions for handling Lua files.		This page describes the [[LuaWML]] functions for handling Lua files.

← Older revision		Revision as of 13:32, 12 February 2021
Line 1:		Line 1:
		+	{{Templaste:LuaMove}}
		+
	This page describes the [[LuaWML]] functions for handling Lua files.		This page describes the [[LuaWML]] functions for handling Lua files.

@@ Line 51: / Line 51: @@
   wesnoth.require "~add-ons/MyEra/lua/unit-utils"
-==== wesnoth.have_file(file_path, restrict_regular_file) ====
+==== wesnoth.have_file (file_path, restrict_regular_file) ====
 {{DevFeature1.13|5}}

@@ Line 51: / Line 51: @@
   wesnoth.require "~add-ons/MyEra/lua/unit-utils"
-==== wesnoth.have_file ====
+==== wesnoth.have_file(file_path, restrict_regular_file) ====
 {{DevFeature1.13|5}}

@@ Line 53: / Line 53: @@
 ==== wesnoth.have_file ====
-{{DevFeature1.13|7}}
+{{DevFeature1.13|5}}
 Tests if a file exists. Files are resolved in the same way as by dofile. {{DevFeature1.13|8}} If you pass true as the second argument, it returns true only if the file is a regular file — otherwise, it returns true if the path is valid, whether it is a file, directory, or some other type of object.
@@ Line 59: / Line 59: @@
 ==== wesnoth.read_file ====
-{{DevFeature1.13|7}}
+{{DevFeature1.13|5}}
 Reads a file into a string. {{DevFeature1.13|8}} If the path is a directory, this instead returns an array of the directory contents, with directories first, followed by files. The special key ndirs contains the number of directories.
 [[Category: Lua Reference]]

← Older revision		Revision as of 14:51, 4 May 2017
Line 56:		Line 56:

	Tests if a file exists. Files are resolved in the same way as by dofile. {{DevFeature1.13\|8}} If you pass true as the second argument, it returns true only if the file is a regular file — otherwise, it returns true if the path is valid, whether it is a file, directory, or some other type of object.		Tests if a file exists. Files are resolved in the same way as by dofile. {{DevFeature1.13\|8}} If you pass true as the second argument, it returns true only if the file is a regular file — otherwise, it returns true if the path is valid, whether it is a file, directory, or some other type of object.
		+
		+	==== wesnoth.read_file ====
		+
		+	{{DevFeature1.13\|7}}
		+
		+	Reads a file into a string. {{DevFeature1.13\|8}} If the path is a directory, this instead returns an array of the directory contents, with directories first, followed by files. The special key ndirs contains the number of directories.

	[[Category: Lua Reference]]		[[Category: Lua Reference]]

@@ Line 18: / Line 18: @@
 If the same files need to be loaded for all the scenarios, the [lua] tag above can be directly put inside the '''_main.cfg''' file (or equivalent file). The Lua code will then be executed at the start of each scenario.
 ==== wesnoth.require ====
@@ Line 43: / Line 45: @@
       [/event]
   [/unit_type]
 [[Category: Lua Reference]]

← Older revision	Revision as of 03:43, 11 March 2016
(No difference)

@@ Line 32: / Line 32: @@
   return library
-It can also be helpful when writing eras, since you may not have the opportunity to call [[#wesnoth.dofile]] during a ''preload'' event:
+It can also be helpful when writing unit types with events, since unit types are not necessarily available at ''preload'' time, hence preventing the usage of [[#wesnoth.dofile]] for precompiling code:
   [unit_type]