Keen:GUI Category - Revision history

CptTwinkie at 20:17, 18 July 2022

2022-07-18T20:17:24Z

← Older revision		Revision as of 20:17, 18 July 2022
Line 36:		Line 36:
	# Save the file in our mod's Data folder as ExampleMod_SearchCategory.sbc. The extension is mandatory, but the name can be anything you want. Prepending the name of the mod on the file name can also help avoid confusion with vanilla files and other mods.		# Save the file in our mod's Data folder as ExampleMod_SearchCategory.sbc. The extension is mandatory, but the name can be anything you want. Prepending the name of the mod on the file name can also help avoid confusion with vanilla files and other mods.

	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false" line>
	<?xml version="1.0"?>		<?xml version="1.0"?>
	<Definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">		<Definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
Line 48:		Line 48:
	</Definition>		</Definition>
	</Definitions>		</Definitions>
	</~~source~~>		</syntaxhighlight>


Line 58:		Line 58:
	== Explanation ==		== Explanation ==
	The XML prolog. Don't mess with it.		The XML prolog. Don't mess with it.
	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false" line>
	<?xml version="1.0"?>		<?xml version="1.0"?>
	</~~source~~>		</syntaxhighlight>
	<br>		<br>
	There are two sets of tags that are used by every definition file. ''Definitions'' opens and closes the file, while ''Definition'' opens and closes each definition.		There are two sets of tags that are used by every definition file. ''Definitions'' opens and closes the file, while ''Definition'' opens and closes each definition.
Line 66:		Line 66:
	*<code>xsi:type="MyObjectBuilder_SearchCategoryDefinition"</code> how this code tells the game what kind of data the definition contains. Without this, the definition cannot be used.		*<code>xsi:type="MyObjectBuilder_SearchCategoryDefinition"</code> how this code tells the game what kind of data the definition contains. Without this, the definition cannot be used.
	* Notice the ''/>'' at the end. This is a self-contained tag which is completely valid syntax in XML when no value exists within the tag. The "Type" and "Subtype" are specified as attributes.		* Notice the ''/>'' at the end. This is a self-contained tag which is completely valid syntax in XML when no value exists within the tag. The "Type" and "Subtype" are specified as attributes.
	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false">
	<Definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">		<Definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<Definition xsi:type="MyObjectBuilder_SearchCategoryDefinition">		<Definition xsi:type="MyObjectBuilder_SearchCategoryDefinition">
Line 72:		Line 72:
	</Definition>		</Definition>
	</Definitions>		</Definitions>
	</~~source~~>		</syntaxhighlight>
	<br>		<br>
	This is a standard definition ID. All definitions are loaded into a definition manager that serves as a temporary internal database while the world is loaded. ID's are the only way to identify definitions.		This is a standard definition ID. All definitions are loaded into a definition manager that serves as a temporary internal database while the world is loaded. ID's are the only way to identify definitions.
	* Type serves as a data category, there will be multiple ''SearchCategoryDefinition'' stored.		* Type serves as a data category, there will be multiple ''SearchCategoryDefinition'' stored.
	* Subtype serves as a unique identifier, there can only ever be one ''stockpiles''. This requirement is what makes modding of existing content possible. Created a duplicate definition ID will allow a modder to override a definition, e.g. by using <code>Subtype="arches'</code>, the arches category could be changed.		* Subtype serves as a unique identifier, there can only ever be one ''stockpiles''. This requirement is what makes modding of existing content possible. Created a duplicate definition ID will allow a modder to override a definition, e.g. by using <code>Subtype="arches'</code>, the arches category could be changed.
	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false">
	<Id Type="SearchCategoryDefinition" Subtype="stockpiles" />		<Id Type="SearchCategoryDefinition" Subtype="stockpiles" />
	</~~source~~>		</syntaxhighlight>
	<br>		<br>
	This is the name of the category that can be displayed on the GUI. Currently this is not being used but the GUI is not final so this should not be left out.		This is the name of the category that can be displayed on the GUI. Currently this is not being used but the GUI is not final so this should not be left out.
	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false">
	<DisplayName>Stockpiles</DisplayName>		<DisplayName>Stockpiles</DisplayName>
	</~~source~~>		</syntaxhighlight>
	<br>		<br>
	These are the items that will appear in this category.		These are the items that will appear in this category.
	* They use the standard ID format and must have the correct ''Type'' and ''Subtype''. It is not possible to substitute ''Tag'' ID's at this time.		* They use the standard ID format and must have the correct ''Type'' and ''Subtype''. It is not possible to substitute ''Tag'' ID's at this time.
	* These are self-contained tags that use the ''/>'' closing.		* These are self-contained tags that use the ''/>'' closing.
	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false">
	<Entry Type="CubeBlock" Subtype="StockpileTimber" />		<Entry Type="CubeBlock" Subtype="StockpileTimber" />
	<Entry Type="CubeBlock" Subtype="StockpileLog" />		<Entry Type="CubeBlock" Subtype="StockpileLog" />
	<Entry Type="CubeBlock" Subtype="StockpileStone" />		<Entry Type="CubeBlock" Subtype="StockpileStone" />
	</~~source~~>		</syntaxhighlight>

CptTwinkie at 12:51, 7 July 2018

2018-07-07T12:51:22Z

← Older revision		Revision as of 12:51, 7 July 2018
Line 1:		Line 1:
	{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/eb/~~KeenLogo~~.png\|description=This guide shows you how to add custom search categories into Medieval Engineers.}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/b/b7/KeenLogoBig.png\|description=This guide shows you how to add custom search categories into Medieval Engineers.}}
	{{Keen:OCH}}		{{Keen:OCH}}

CptTwinkie at 12:32, 7 July 2018

2018-07-07T12:32:52Z

← Older revision		Revision as of 12:32, 7 July 2018
Line 1:		Line 1:
	{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/~~KEEN_COMPASS_ONLY~~.png\|description=This guide shows you how to add custom search categories into Medieval Engineers.}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/eb/KeenLogo.png\|description=This guide shows you how to add custom search categories into Medieval Engineers.}}
	{{Keen:OCH}}		{{Keen:OCH}}

CptTwinkie at 10:54, 29 June 2018

2018-06-29T10:54:12Z

← Older revision		Revision as of 10:54, 29 June 2018
Line 1:		Line 1:
	{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/KEEN_COMPASS_ONLY.png\|description=This guide shows you how to add custom search categories into Medieval Engineers.}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/KEEN_COMPASS_ONLY.png\|description=This guide shows you how to add custom search categories into Medieval Engineers.}}
	{{:~~Official Content/~~OCH}}		{{Keen:OCH}}

CptTwinkie: CptTwinkie moved page Official Content/GUI Category to Keen:GUI Category

2018-06-29T10:25:51Z

CptTwinkie moved page Official Content/GUI Category to Keen:GUI Category

← Older revision		Revision as of 10:25, 29 June 2018
(No difference)

CptTwinkie at 21:46, 1 June 2018

2018-06-01T21:46:03Z

← Older revision		Revision as of 21:46, 1 June 2018
Line 1:		Line 1:
			{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/KEEN_COMPASS_ONLY.png\|description=This guide shows you how to add custom search categories into Medieval Engineers.}}
	{{:Official Content/OCH}}		{{:Official Content/OCH}}

CptTwinkie at 14:58, 30 May 2018

2018-05-30T14:58:32Z

← Older revision		Revision as of 14:58, 30 May 2018
Line 1:		Line 1:
			{{:Official Content/OCH}}


	This guide shows you how to add custom search categories into Medieval Engineers. Categories in 0.6 have much of the same functionality as they did in 0.5 but the way the GUI uses them is different. Fundamentally, they are still a group of similar blocks, nothing more and nothing less. The differences are subtle but ultimately confusing for anyone looking for the simple functionality in previous versions of the game.		This guide shows you how to add custom search categories into Medieval Engineers. Categories in 0.6 have much of the same functionality as they did in 0.5 but the way the GUI uses them is different. Fundamentally, they are still a group of similar blocks, nothing more and nothing less. The differences are subtle but ultimately confusing for anyone looking for the simple functionality in previous versions of the game.

CptTwinkie: CptTwinkie moved page Official Content//GUI Category to Official Content/GUI Category without leaving a redirect

2018-05-29T07:39:36Z

CptTwinkie moved page Official Content//GUI Category to Official Content/GUI Category without leaving a redirect

← Older revision		Revision as of 07:39, 29 May 2018
(No difference)

CptTwinkie: CptTwinkie moved page Official Content//GUI Category Modding Guide to Official Content//GUI Category without leaving a redirect

2018-05-29T07:39:25Z

CptTwinkie moved page Official Content//GUI Category Modding Guide to Official Content//GUI Category without leaving a redirect

← Older revision		Revision as of 07:39, 29 May 2018
(No difference)

CptTwinkie at 07:39, 29 May 2018

2018-05-29T07:39:01Z

← Older revision		Revision as of 07:39, 29 May 2018
Line 10:		Line 10:
	{{Version <!-- Do not change the version until the entire page is up-to-date -->		{{Version <!-- Do not change the version until the entire page is up-to-date -->
	\|release=0\|major=6\|minor=2}}		\|release=0\|major=6\|minor=2}}
	~~{{HistorySub\|0.5}}~~
	== Tools Used ==		== Tools Used ==
	* [https://notepad-plus-plus.org/ Notepad++]: This, any other advanced text editor, or a full [https://en.wikipedia.org/wiki/Integrated_development_environment IDE], are recommended. While these tools offer seemingly endless ways to manipulate text, perhaps the most important feature for this simple kind of mod is [https://en.wikipedia.org/wiki/Syntax_highlighting syntax highlighting]. This will make it easier to identify different parts of the code and to more easily see if you have made any syntax mistakes.		* [https://notepad-plus-plus.org/ Notepad++]: This, any other advanced text editor, or a full [https://en.wikipedia.org/wiki/Integrated_development_environment IDE], are recommended. While these tools offer seemingly endless ways to manipulate text, perhaps the most important feature for this simple kind of mod is [https://en.wikipedia.org/wiki/Syntax_highlighting syntax highlighting]. This will make it easier to identify different parts of the code and to more easily see if you have made any syntax mistakes.