Entity Tutorial 2: Simple Script - Revision history

SkyCorp at 02:11, 14 July 2023

2023-07-14T02:11:06Z

← Older revision		Revision as of 02:11, 14 July 2023
Line 44:		Line 44:
	</syntaxhighlight>		</syntaxhighlight>

	Now, let's put this into the JSON. We will need to escape this source code so it can be pasted in the lua field. ~~You can get~~ a ~~program to do this~~, or use a website like [https://www.freeformatter.com/json-escape.html this]. Doing so will result in a very long line of text like so:		Now, let's put this into the JSON. We will need to escape this source code so it can be pasted in the lua field. Some advanced text editors will have a "JSON Escape" feature, or just use a website like [https://www.freeformatter.com/json-escape.html this].

			Doing so will result in a very long line of text like so:

	<code>-- Description is called when an object's description is shown to the\r\n-- player or otherwise requested. The object should return a string\r\n-- containing the description.\r\n\r\nfunction description()\r\n\r\n -- Create a descriptive string\r\n local descriptiveText = \"The gem shines programatically as you look at it.\";\r\n\r\n -- Return it\r\n return descriptiveText;\r\n\r\nend</code>		<code>-- Description is called when an object's description is shown to the\r\n-- player or otherwise requested. The object should return a string\r\n-- containing the description.\r\n\r\nfunction description()\r\n\r\n -- Create a descriptive string\r\n local descriptiveText = \"The gem shines programatically as you look at it.\";\r\n\r\n -- Return it\r\n return descriptiveText;\r\n\r\nend</code>

	Now, let's copy/paste that text into the ~~luac~~ json...		Now, let's copy/paste that text into the lua json...

	<syntaxhighlight lang="json">		<syntaxhighlight lang="json">
Line 68:		Line 70:

	That's the finished JSON, ready for testing in-game! Use the UGC Control Panel as in the last tutorial, and when you look at the object in-game, the description should be "The gem shines programatically as you look at it." You just made a LUA object!		That's the finished JSON, ready for testing in-game! Use the UGC Control Panel as in the last tutorial, and when you look at the object in-game, the description should be "The gem shines programatically as you look at it." You just made a LUA object!

	~~== Video Guide ==~~
	~~See [[Entity Tutorial Appendix A: Setup, Compile, and Run Video Demonstration\|this page]] to see a video demonstrating the steps on Windows.~~

SkyCorp: new lua steps

2023-07-14T01:58:23Z

new lua steps

@@ Line 7: / Line 7: @@
 Now for '''description''', we set the parameter '''programString''' to true, to indicate that there is a description() function in the lua code that can be called for the description.  It is a 'string' because that is the return type of '''description()'''.  Other parameters might be '''programBoolean''', '''programVoid''', etc.  See the reference docs for the return type.
-There is one other new parameter in the JSON, something called '''luac'''.  That is the base64 version of the compiled lua program.  Let's generate that in the next step.
+There is one other new parameter in the JSON, something called '''lua'''.  That is the json escaped version of the lua source code.  Let's generate that in the next step.
 <syntaxhighlight lang="json">
@@ Line 20: / Line 20: @@
 		"programString": true
 	},
-	"luac": "???"
+	"lua": "???"
+}
 </syntaxhighlight>
@@ Line 44: / Line 44: @@
 </syntaxhighlight>
-What the game will do is see that description has a programString available, and when requesting description will call description() and use its return value for the description.
+Now, let's put this into the JSON.  We will need to escape this source code so it can be pasted in the lua field.  You can get a program to do this, or use a website like [https://www.freeformatter.com/json-escape.html this].  Doing so will result in a very long line of text like so:
-If we just try to run this code from the command line, it won't be overly interesting:
+  <code>-- Description is called when an object's description is shown to the\r\n-- player or otherwise requested.  The object should return a string\r\n-- containing the description.\r\n\r\nfunction description()\r\n\r\n   -- Create a descriptive string\r\n   local descriptiveText = \"The gem shines programatically as you look at it.\";\r\n\r\n   -- Return it\r\n   return descriptiveText;\r\n\r\nend</code>
 Now, let's copy/paste that text into the luac json...
@@ Line 115: / Line 61: @@
 		"programString": true
 	},
-	"luac": "G0x1YVEAAQQEBAgAEAAAAEBzaGluaWVyR2VtLmx1YQAAAAAAAAAAAAAAAgIDAAAAJAAAAAcAAAAeAIAAAQAAAAQMAAAAZGVzY3JpcHRpb24AAQAAAAAAAAAFAAAADQAAAAAAAAIDAAAAAQAAAB4AAAEeAIAAAQAAAAQyAAAAVGhlIGdlbSBzaGluZXMgcHJvZ3JhbWF0aWNhbGx5IGFzIHlvdSBsb29rIGF0IGl0LgAAAAAAAwAAAAgAAAALAAAADQAAAAEAAAAQAAAAZGVzY3JpcHRpdmVUZXh0AAEAAAACAAAAAAAAAAMAAAANAAAABQAAAA0AAAAAAAAAAAAAAA=="
+	"lua": "-- Description is called when an object's description is shown to the\r\n-- player or otherwise requested.  The object should return a string\r\n-- containing the description.\r\n\r\nfunction description()\r\n\r\n   -- Create a descriptive string\r\n   local descriptiveText = \"The gem shines programatically as you look at it.\";\r\n\r\n   -- Return it\r\n   return descriptiveText;\r\n\r\nend"
+}
 </syntaxhighlight>
@@ Line 124: / Line 70: @@
 == Video Guide ==
-See [[Entity Tutorial Appendix A: Setup, Compile, and Run Video Demonstration|this page]] to see a video demonstrating the compile/base64/run steps on Windows.
+See [[Entity Tutorial Appendix A: Setup, Compile, and Run Video Demonstration|this page]] to see a video demonstrating the steps on Windows.

SkyCorp at 02:03, 4 February 2018

2018-02-04T02:03:34Z

← Older revision		Revision as of 02:03, 4 February 2018
Line 122:		Line 122:

	That's the finished JSON, ready for testing in-game! Use the UGC Control Panel as in the last tutorial, and when you look at the object in-game, the description should be "The gem shines programatically as you look at it." You just made a LUA object!		That's the finished JSON, ready for testing in-game! Use the UGC Control Panel as in the last tutorial, and when you look at the object in-game, the description should be "The gem shines programatically as you look at it." You just made a LUA object!

			== Video Guide ==
			See [[Entity Tutorial Appendix A: Setup, Compile, and Run Video Demonstration\|this page]] to see a video demonstrating the compile/base64/run steps on Windows.

SkyCorp at 05:19, 21 December 2017

2017-12-21T05:19:01Z

← Older revision		Revision as of 05:19, 21 December 2017
Line 51:		Line 51:
	Nothing happens. This is because the game calls the description() function, whereas nothing is calling the description function for the command line version of lua. We could quickly hack this just for quick testing purposes by adding a call to description():		Nothing happens. This is because the game calls the description() function, whereas nothing is calling the description function for the command line version of lua. We could quickly hack this just for quick testing purposes by adding a call to description():

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua" highlight="15-16">
	-- Description is called when an object's description is shown to the		-- Description is called when an object's description is shown to the
	-- player or otherwise requested. The object should return a string		-- player or otherwise requested. The object should return a string

SkyCorp: /* Writing the LUA code */

2017-12-21T05:04:32Z

Writing the LUA code

← Older revision		Revision as of 05:04, 21 December 2017
Line 43:		Line 43:
	end		end
	</syntaxhighlight>		</syntaxhighlight>

			What the game will do is see that description has a programString available, and when requesting description will call description() and use its return value for the description.

	If we just try to run this code from the command line, it won't be overly interesting:		If we just try to run this code from the command line, it won't be overly interesting:
	> lua shinierGem.lua		> lua shinierGem.lua

	Nothing happens. This is because the game calls the description() function, whereas nothing is calling the description function. We could quickly hack this just for quick testing purposes by adding a call to description():		Nothing happens. This is because the game calls the description() function, whereas nothing is calling the description function for the command line version of lua. We could quickly hack this just for quick testing purposes by adding a call to description():

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

SkyCorp at 05:02, 21 December 2017

2017-12-21T05:02:22Z

← Older revision		Revision as of 05:02, 21 December 2017
Line 63:		Line 63:

	end		end

			-- NEW! Output return value of description() for quick test:
			io.write("Just for testing on the command line purposes, description returns: " .. description() .. "\n");
	</syntaxhighlight>		</syntaxhighlight>

SkyCorp at 04:59, 21 December 2017

2017-12-21T04:59:10Z

@@ Line 3: / Line 3: @@
 Generally, if only returning a static string, a string literal like in the previous tutorial should be used due to performance reasons.  However, this will demonstrate the simplest possible LUA code before we expand upon it in the next tutorial.
-Definition Upgrade
+== Definition Upgrade ==
 Now for '''description''', we set the parameter '''programString''' to true, to indicate that there is a description() function in the lua code that can be called for the description.  It is a 'string' because that is the return type of '''description()'''.  Other parameters might be '''programBoolean''', '''programVoid''', etc.  See the reference docs for the return type.
-There is one other new parameter in the JSON, something called '''luac'''.  That is the base64 version of the compiled lua program.  Let's generate that next.
+There is one other new parameter in the JSON, something called '''luac'''.  That is the base64 version of the compiled lua program.  Let's generate that in the next step.
-JSON before LUAC
+<syntaxhighlight lang="json">
-Writing the LUA code
+== Writing the LUA code ==
 We create a simple LUA program in a folder on our HDD and name it shinierGem.lua:
-LUA Code
+<syntaxhighlight lang="lua">
 If we just try to run this code from the command line, it won't be overly interesting:
   > lua shinierGem.lua
-Nothing happens.  This is because the game calls the description() function, whereas nothing is calling the description function.  We could quickly hack this just for quick testing purposes by adding a call to description()
+Nothing happens.  This is because the game calls the description() function, whereas nothing is calling the description function.  We could quickly hack this just for quick testing purposes by adding a call to description():
-JSON after LUAC
+== Testing ==
-That will be
+That's the finished JSON, ready for testing in-game!  Use the UGC Control Panel as in the last tutorial, and when you look at the object in-game, the description should be "The gem shines programatically as you look at it."  You just made a LUA object!

SkyCorp at 04:47, 21 December 2017

2017-12-21T04:47:48Z

← Older revision		Revision as of 04:47, 21 December 2017
Line 1:		Line 1:
	.		In this tutorial, we will upgrade the Shiny Gem object from Tutorial 1. Now instead of using a literal string for the description, the description will be generated by LUA code.

			Generally, if only returning a static string, a string literal like in the previous tutorial should be used due to performance reasons. However, this will demonstrate the simplest possible LUA code before we expand upon it in the next tutorial.

			Definition Upgrade

			Now for '''description''', we set the parameter '''programString''' to true, to indicate that there is a description() function in the lua code that can be called for the description. It is a 'string' because that is the return type of '''description()'''. Other parameters might be '''programBoolean''', '''programVoid''', etc. See the reference docs for the return type.

			There is one other new parameter in the JSON, something called '''luac'''. That is the base64 version of the compiled lua program. Let's generate that next.

			JSON before LUAC

			Writing the LUA code

			We create a simple LUA program in a folder on our HDD and name it shinierGem.lua:

			LUA Code

			If we just try to run this code from the command line, it won't be overly interesting:
			> lua shinierGem.lua
			>
			Nothing happens. This is because the game calls the description() function, whereas nothing is calling the description function. We could quickly hack this just for quick testing purposes by adding a call to description()

			JSON after LUAC

			That will be

SkyCorp: Created page with "."

2017-12-21T04:35:49Z

Created page with "."

New page