Luna Engine Configuration Guide - Revision history

Archeia: /* Part 4: Block 3 - Events/Animations */

2019-07-26T20:15:39Z

‎Part 4: Block 3 - Events/Animations

Archeia: /* Lunatic Specific Commands and Types */

2019-07-26T20:15:17Z

‎Lunatic Specific Commands and Types

Archeia: /* Common Config Commands */

2019-07-26T20:14:14Z

‎Common Config Commands

Archeia: /* Common Config Commands */

2019-06-25T15:41:54Z

‎Common Config Commands

Archeia: /* Common Config Commands */

2019-06-25T15:40:55Z

‎Common Config Commands

Archeia: /* Common Config Commands */

2019-06-25T15:40:34Z

‎Common Config Commands

Archeia at 10:45, 22 June 2019

2019-06-22T10:45:23Z

Archeia at 10:38, 22 June 2019

2019-06-22T10:38:30Z

Archeia: /* Anatomy of Block 4 - Lunatic: */

2019-06-22T10:37:38Z

‎Anatomy of Block 4 - Lunatic:

Show changes

Archeia: /* Anatomy of Block 4 - Lunatic: */

2019-06-22T10:31:33Z

‎Anatomy of Block 4 - Lunatic:

@@ Line 351: / Line 351: @@
 Targeting the “HpBar” component defined for the “BattleStatus” window in Block 4: Lunatic.
-  <nowiki>target: BattleStatusHpBar <nowiki>
+  <nowiki>target: BattleStatusHpBar </nowiki>
 Targeting Lunatic item 0 in the “BattleStatus” window as defined in Block 4: Lunatic.

@@ Line 528: / Line 528: @@
            x: 0
            y: 0
-         imageName: "battle_hud/Actor${data.actorId}" # Source file of image
+         imageName: "battle_hud/Actor${data.actorId}" # Source file of image</nowiki>
 Defines the component as text. Standard configuration format for fonts applies. Used for rendering predetermined text generally.

@@ Line 64: / Line 64: @@
 ==Common Config Commands==
   <nowiki>type: <string> </nowiki>
@@ Line 72: / Line 73: @@
 Version, also known as Version History, is to keep track what version your Luna Config is. It is useful for Version Control and keep track of changes.
   <nowiki>Window Extend: WindowName </nowiki>
-Window extend means use that window's configuration and add your own configuration. It's similar to the concept of aliasing in programming.
+Window extend means use that window's luna configuration and add your own configuration.
   <nowiki>x: <number> </nowiki>

@@ Line 72: / Line 72: @@
 Version, also known as Version History, is to keep track what version your Luna Config is. It is useful for Version Control and keep track of changes.
   <nowiki>x: <number> </nowiki>
@@ Line 82: / Line 85: @@
   <nowiki>image: <string> </nowiki>
   <nowiki>image: "battlehud\cursor" </nowiki>
 ==Global Templates==

@@ Line 85: / Line 85: @@
 Specifies the source image file. By default, Luna looks for all source files in the “systems” folder. Via encasing the filename (without file extension) in quotation marks, it’s possible to direct Luna to a subfolder. For Example:
   <nowiki>image: "battlehud\cursor" </nowiki>
   <nowiki>Window Extend: WindowName </nowiki>
 ==Global Templates==

← Older revision		Revision as of 10:45, 22 June 2019
Line 1:		Line 1:
	{{TOCright}}		{{TOCright}}
		+
		+	=== Understanding YAML (.yml) Files ===
		+	Due to the nature of yaml files, format and indentation of lines is highly important for Luna to understand what is being customized. As a result, many errors can be caused by mistakes in syntax.
		+
		+	====Indentation====
		+	As a rule, all indented lines under an un-indented line are “nested” and properties of the un-indented line. As lines can be nested under already nested lines, it becomes very easy to see the configuration as done in tiers.
		+	<html><a href="https://imgur.com/DHMSq90"><img src="https://i.imgur.com/DHMSq90.png" title="source: imgur.com" /></a></html>
		+	'''Nesting Visualized'''
		+	As everything under “components” is more indented than components, it is considered to be nested under it in the blue box.
		+
		+	The purple box outlines what’s considered to be nested under “Background”. However, as “x” and “type” are on the same level of indentation, they both form their individual red boxes.
		+	As “type: Background” doesn’t have a line directly under it that is more indented, nothing is nested under it. “X” on the other hand has “type: percentage” is more indented than “x”, thus meaning it is nested under “x”.
		+
		+	====Syntax====
		+	As yaml is technically a coding language, it is extremely picky with syntax. Something as simple as wrong capitalization or missing/extra spaces will cause errors. Usually, your Text IDE will suggest the correct term/word with the correct capitalization, but it is still important to take note of the following syntax rules.
		+
		+	* ''' Lines must be separated properly:'''
		+	Both nested and un-nested lines must have their own individual line. Accidentally crowding into the above line will cause errors. Empty lines are allowed and recommended for help with organization.
		+	<html><a href="https://imgur.com/TCsBWuT"><img src="https://i.imgur.com/TCsBWuT.png" title="source: imgur.com" /></a></html>
		+
		+	* ''' The format must be:'''
		+	<nowiki><parameter>: <string> OR - <component name></nowiki>
		+	There must be a space between “:” and <string>. No more, no less. The text should display in the correct colours if the syntax is correct.
		+	<html><a href="https://imgur.com/Mr8xdGN"><img src="https://i.imgur.com/Mr8xdGN.png" title="source: imgur.com" /></a></html>
		+	For component lists, there must be a space between “-” and <component name>. It will not display the wrong colour if incorrect, but will produce an error when run.
		+
		+	* ''' Names used must be consistent across all instances referring to the same thing: '''
		+	This includes capitalization, spacing, spelling, etc. They must be completely the same when referring to the same window/object/item, otherwise Luna give an error stating that the referenced object is undefined.
		+	<html><a href="https://imgur.com/KNMQo1G"><img src="https://i.imgur.com/KNMQo1G.png" title="source: imgur.com" /></a></html>

	==Common Terms==		==Common Terms==

← Older revision		Revision as of 10:38, 22 June 2019
Line 651:		Line 651:
	value: 11		value: 11
	</nowiki>		</nowiki>
−
−	~~=== test ===~~
−	~~=== test ===~~
−
−	~~==Common Config Commands==~~
−
−	~~==Common Config Commands==~~
−
−	~~==Common Config Commands==~~
−
−	~~==Common Config Commands==~~
−
−	~~==Common Config Commands==~~
−
−	~~==Common Config Commands==~~
−
−	~~==Common Config Commands==~~
−
−	~~==Common Config Commands==~~
−
−	~~==Common Config Commands==~~
−
−	~~==Common Config Commands==~~
−
−	~~==Common Config Commands==~~

@@ Line 375: / Line 375: @@
 '''Protip:''' It is also possible to move the Lunatic configurations for a window to a separate file for the sake of organization. Identically to how it’s done in block 1, the engine must be pointed to the correct file:
   <nowiki>lunatic: # Marks this as the Lunatic section
-   TitleCommand: Title_TitleCommand.Lunatic # The lunatic configurations for the window "TitleCommand" are in the file "Title_TitleCommand.Lunatic".  </nowiki>
+   TitleCommand: Title_TitleCommand.Lunatic # The lunatic configurations for the window "TitleCommand" are in the file "Title_TitleCommand.Lunatic".
 Below is an example of the basic Lunatic block for two different windows in the same scene.
@@ Line 402: / Line 403: @@
 	- TypeSelector1
 	- TypeSelector2
    lunaticItems: # Lunatic items that render for every instance of data for the window. Lunatic items as a whole can be further customized with position and dimension, but it's not recommended.
@@ Line 432: / Line 432: @@
    	type: FreeLayout
    	components:
-    	- TypeIcon <nowiki>
+    	- TypeIcon
 === test ===