Lua scripting - Revision history

Sonic260: /* Inventory injection */

2022-01-25T18:38:08Z

Inventory injection

← Older revision		Revision as of 18:38, 25 January 2022
Line 44:		Line 44:

	=== <u>Inventory injection</u> ===		=== <u>Inventory injection</u> ===
	Raw Lua scripts written and saved in the game's ''%appdata%/Prasetto/Bonfire//Mods/lua'' can be directly injected into the console @target character's inventory as an item that will be saved within their data, much like the classic macros, using the following command:		Raw Lua scripts written and saved in the game's ''%appdata%/Prasetto/Bonfire/Mods/lua'' can be directly injected into the console @target character's inventory as an item that will be saved within their data, much like the classic macros, using the following command:

	<pre>oluainj luaScriptName</pre>		<pre>oluainj luaScriptName</pre>

Bonfirewikiadmin: 19 revisions imported

2021-06-19T02:32:57Z

19 revisions imported

← Older revision		Revision as of 02:32, 19 June 2021
(No difference)

bonfire-wiki>Sonic260: Adding categories

2021-04-25T19:14:07Z

Adding categories

← Older revision		Revision as of 19:14, 25 April 2021
Line 68:		Line 68:

	Invoked iterators will also create an inventory entry on the character that represents their ongoing process, meaning that they save with the character and will automatically resume their process upon spawning on the scene. Iterators will also remember their elapsed execution time, unless they were set to run for an "Infinity" amount of seconds, in which case they will last forever unless manually removed.		Invoked iterators will also create an inventory entry on the character that represents their ongoing process, meaning that they save with the character and will automatically resume their process upon spawning on the scene. Iterators will also remember their elapsed execution time, unless they were set to run for an "Infinity" amount of seconds, in which case they will last forever unless manually removed.
			[[Category:Tutorials]]

bonfire-wiki>Sonic260 at 02:24, 12 April 2020

2020-04-12T02:24:26Z

← Older revision		Revision as of 02:24, 12 April 2020
Line 39:		Line 39:

	== Bonfire Lua API ==		== Bonfire Lua API ==
	An up-to-date documentation for all the known commands is available at the [[Lua API Reference]].''<nowiki/>''		An up-to-date documentation for all the known commands is available at on the [[Lua API Reference]]. page.''<nowiki/>''
	== Stepping up: Advanced Lua execution (for 0.36.0) ==		== Stepping up: Advanced Lua execution (for 0.36.0) ==
	So far we've read on how to use Lua from within a macro or dialogue structure. However, if your wish is to directly use Lua and advanced iterators without needing to wrap everything using an old school macro and timed console tricks, a more advanced implementation is available.		So far we've read on how to use Lua from within a macro or dialogue structure. However, if your wish is to directly use Lua and advanced iterators without needing to wrap everything using an old school macro and timed console tricks, a more advanced implementation is available.

bonfire-wiki>Sonic260: /* Lua commands */ Adds a link to the API Reference

2020-04-12T02:23:24Z

Lua commands: Adds a link to the API Reference

Show changes

bonfire-wiki>Hogswild at 19:31, 6 October 2019

2019-10-06T19:31:43Z

← Older revision		Revision as of 19:31, 6 October 2019
Line 196:		Line 196:
	...where "luaScriptName" is the name of the script file that is saved on the aforementioned %appdata% location in your computer. The name has to be provided as is, without a directory path nor a file extension. If successful, a new item in the form of a Lua parchment will be visible on the character's inventory. It will attempt to initialize and execute any code in your script that isn't wrapped inside a function scope upon first injection.		...where "luaScriptName" is the name of the script file that is saved on the aforementioned %appdata% location in your computer. The name has to be provided as is, without a directory path nor a file extension. If successful, a new item in the form of a Lua parchment will be visible on the character's inventory. It will attempt to initialize and execute any code in your script that isn't wrapped inside a function scope upon first injection.

	=== Iterated execution ===		=== <u>Iterated execution</u> ===
	Once a Lua script is injected, it will remain in the character's inventory and active process memory for actual execution. The idea is to allow you to either call any of the script's functions directly at any given time, or to create a timed iterator that will execute any of its functions repeatedly for a given amount of time.		Once a Lua script is injected, it will remain in the character's inventory and active process memory for actual execution. The idea is to allow you to either call any of the script's functions directly at any given time, or to create a timed iterator that will execute any of its functions repeatedly for a given amount of time.

Line 211:		Line 211:
	<pre>oluaria luaScriptName,functionName</pre>		<pre>oluaria luaScriptName,functionName</pre>

	...Or simply write "oluaria" ~~with no commands~~ and it will remove all iterators currently running in the character.		...Or simply write "oluaria" without parameters and it will remove all iterators currently running in the character.

	Invoked iterators will also create an inventory entry on the character that represents their ongoing process, meaning that they save with the character and will automatically resume their process upon spawning on the scene. Iterators will also remember their elapsed execution time, unless they were set to run for an "Infinity" amount of seconds, in which case they will last forever unless manually removed.		Invoked iterators will also create an inventory entry on the character that represents their ongoing process, meaning that they save with the character and will automatically resume their process upon spawning on the scene. Iterators will also remember their elapsed execution time, unless they were set to run for an "Infinity" amount of seconds, in which case they will last forever unless manually removed.

bonfire-wiki>Hogswild at 19:30, 6 October 2019

2019-10-06T19:30:07Z

← Older revision		Revision as of 19:30, 6 October 2019
Line 196:		Line 196:
	...where "luaScriptName" is the name of the script file that is saved on the aforementioned %appdata% location in your computer. The name has to be provided as is, without a directory path nor a file extension. If successful, a new item in the form of a Lua parchment will be visible on the character's inventory. It will attempt to initialize and execute any code in your script that isn't wrapped inside a function scope upon first injection.		...where "luaScriptName" is the name of the script file that is saved on the aforementioned %appdata% location in your computer. The name has to be provided as is, without a directory path nor a file extension. If successful, a new item in the form of a Lua parchment will be visible on the character's inventory. It will attempt to initialize and execute any code in your script that isn't wrapped inside a function scope upon first injection.

	Iterated execution		=== Iterated execution ===

	Once a Lua script is injected, it will remain in the character's inventory and active process memory for actual execution. The idea is to allow you to either call any of the script's functions directly at any given time, or to create a timed iterator that will execute any of its functions repeatedly for a given amount of time.		Once a Lua script is injected, it will remain in the character's inventory and active process memory for actual execution. The idea is to allow you to either call any of the script's functions directly at any given time, or to create a timed iterator that will execute any of its functions repeatedly for a given amount of time.

bonfire-wiki>Hogswild: Added advanced lua execution stuff for the upcoming version

2019-10-06T19:27:11Z

Added advanced lua execution stuff for the upcoming version

← Older revision		Revision as of 19:27, 6 October 2019
Line 185:		Line 185:
	\|		\|
	\|}		\|}

			== Stepping up: Advanced Lua execution (for 0.36.0) ==
			So far we've read on how to use Lua from within a macro or dialogue structure. However, if your wish is to directly use Lua and advanced iterators without needing to wrap everything using an old school macro and timed console tricks, a more advanced implementation is available.

			=== <u>Inventory injection</u> ===
			Raw Lua scripts written and saved in the game's ''%appdata%/Prasetto/Bonfire//Mods/lua'' can be directly injected into the console @target character's inventory as an item that will be saved within their data, much like the classic macros, using the following command:

			<pre>oluainj luaScriptName</pre>

			...where "luaScriptName" is the name of the script file that is saved on the aforementioned %appdata% location in your computer. The name has to be provided as is, without a directory path nor a file extension. If successful, a new item in the form of a Lua parchment will be visible on the character's inventory. It will attempt to initialize and execute any code in your script that isn't wrapped inside a function scope upon first injection.

			Iterated execution

			Once a Lua script is injected, it will remain in the character's inventory and active process memory for actual execution. The idea is to allow you to either call any of the script's functions directly at any given time, or to create a timed iterator that will execute any of its functions repeatedly for a given amount of time.

			Immediate and single execution of an injected Lua script function can be achieved by writing:

			<pre>oluacf luaScriptName,functionName</pre>

			While iterated execution can be achieved by writing:

			<pre>oluaiifr luaScriptName,functionName,executionTime</pre>

			Additionally, if you wish to stop execution of any previously invoked function iterators from a script, use:

			<pre>oluaria luaScriptName,functionName</pre>

			...Or simply write "oluaria" with no commands and it will remove all iterators currently running in the character.

			Invoked iterators will also create an inventory entry on the character that represents their ongoing process, meaning that they save with the character and will automatically resume their process upon spawning on the scene. Iterators will also remember their elapsed execution time, unless they were set to run for an "Infinity" amount of seconds, in which case they will last forever unless manually removed.

bonfire-wiki>Sonic260: /* Lua Functions*/ Adds getclosespureorc() and walktoorc() commands from the genieagent.lua file

2019-09-03T03:30:19Z

Lua Functions: Adds getclosespureorc() and walktoorc() commands from the genieagent.lua file

← Older revision		Revision as of 03:30, 3 September 2019
Line 80:		Line 80:
	\|endsex()		\|endsex()
	\|Ends sex		\|Ends sex
			\|-
			\|getclosestpureorc
			\|orc.getclosestpureorc()
			\|
			\|-
			\|walktoorc
			\|orc.walktoorc()
			\|
	\|}		\|}

Line 168:		Line 176:
	\|string		\|string
	\|The name of the character.		\|The name of the character.
			\|-
			\|
			\|
			\|
	\|-		\|-
	\|More to come later!		\|More to come later!

bonfire-wiki>Hogswild: /* Lua commands */

2019-08-03T17:22:24Z

Lua commands

← Older revision		Revision as of 17:22, 3 August 2019
Line 53:		Line 53:
	\|ifitemflag		\|ifitemflag
	\|ifitemflag(''name'',''data'')		\|ifitemflag(''name'',''data'')
	\|Checks if the orc has the specified flag and data. Both parameters are strings.		\|Checks if the orc has the specified flag of given '''''name''''' and '''''data'''''. Both parameters are strings.
			\|-
			\|setitemflag
			\|setitemflag(''flagname, flagdata'')
			\|Sets or changes a flag of given '''''flagname''''' with given '''''flagdata'''''
	\|-		\|-
	\|orcobjset		\|orcobjset