Keen:Search Conditions - Revision history

CptTwinkie at 20:32, 18 July 2022

2022-07-18T20:32:10Z

← Older revision		Revision as of 20:32, 18 July 2022
Line 11:		Line 11:

	'''Example:'''		'''Example:'''
	<~~source~~ lang="csharp">		<syntaxhighlight lang="csharp" line>
	public void SearchForStuff()		public void SearchForStuff()
	{		{
Line 20:		Line 20:
	var results = search.Search("Hello, is it me you're looking for?");		var results = search.Search("Hello, is it me you're looking for?");
	}		}
	</~~source~~>		</syntaxhighlight>

	==Search Conditions==		==Search Conditions==
Line 41:		Line 41:

	'''Example Category:'''		'''Example Category:'''
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml" line>
	<Definition xsi:type="MyObjectBuilder_SearchCategoryDefinition">		<Definition xsi:type="MyObjectBuilder_SearchCategoryDefinition">
	<Id Type="SearchCategoryDefinition" Subtype="Coins" />		<Id Type="SearchCategoryDefinition" Subtype="Coins" />
Line 52:		Line 52:
	<Entry Type="CubeBlock" Subtype="PressMechanical" />		<Entry Type="CubeBlock" Subtype="PressMechanical" />
	</Definition>		</Definition>
	</~~source~~>		</syntaxhighlight>

	'''Id:''' definition Id of the category. All categories are of type <code>SearchCategoryDefinition</code>.		'''Id:''' definition Id of the category. All categories are of type <code>SearchCategoryDefinition</code>.
Line 88:		Line 88:
	There a possibility to implement custom search conditions in a mod, by implementing the <code>IMySearchCondition</code> interface.		There a possibility to implement custom search conditions in a mod, by implementing the <code>IMySearchCondition</code> interface.

	<~~source~~ lang="csharp">		<syntaxhighlight lang="csharp" line>
	public interface IMySearchCondition		public interface IMySearchCondition
	{		{
Line 99:		Line 99:
	string Description { get; }		string Description { get; }
	}		}
	</~~source~~>		</syntaxhighlight>

	'''Init:''' This is called each time the ''search term'' is changed. It is the best place to set inner variables, that need to be changed for each search.		'''Init:''' This is called each time the ''search term'' is changed. It is the best place to set inner variables, that need to be changed for each search.
Line 114:		Line 114:
	'''Example:'''		'''Example:'''

	<~~source~~ lang="csharp">		<syntaxhighlight lang="csharp" line>
	public class CustomSearchCondition: IMySearchCondition {		public class CustomSearchCondition: IMySearchCondition {
	...		...
Line 127:		Line 127:
	search.RegisterSearchCondition('^', condition);		search.RegisterSearchCondition('^', condition);
	}		}
	</~~source~~>		</syntaxhighlight>


Line 137:		Line 137:
	'''Example:'''		'''Example:'''

	<~~source~~ lang="csharp">		<syntaxhighlight lang="csharp" line>
	public void UnregisterSearch() {		public void UnregisterSearch() {
	var search = MySession.Static.Components.Get<MySearchSystem>();		var search = MySession.Static.Components.Get<MySearchSystem>();
Line 145:		Line 145:
	search.UnregisterSearchCondition('^');		search.UnregisterSearchCondition('^');
	}		}
	</~~source~~>		</syntaxhighlight>

CptTwinkie at 12:51, 7 July 2018

2018-07-07T12:51:26Z

← 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=The search system is a Session Component, and it powers the general search screen (also known as G-Screen).}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/b/b7/KeenLogoBig.png\|description=The search system is a Session Component, and it powers the general search screen (also known as G-Screen).}}
	{{Keen:OCH}}		{{Keen:OCH}}

CptTwinkie at 12:32, 7 July 2018

2018-07-07T12:32:30Z

← 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=The search system is a Session Component, and it powers the general search screen (also known as G-Screen).}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/eb/KeenLogo.png\|description=The search system is a Session Component, and it powers the general search screen (also known as G-Screen).}}
	{{Keen:OCH}}		{{Keen:OCH}}

CptTwinkie at 10:54, 29 June 2018

2018-06-29T10:54:04Z

← 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=The search system is a Session Component, and it powers the general search screen (also known as G-Screen).}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/KEEN_COMPASS_ONLY.png\|description=The search system is a Session Component, and it powers the general search screen (also known as G-Screen).}}
	{{:~~Official Content/~~OCH}}		{{Keen:OCH}}

CptTwinkie: CptTwinkie moved page Official Content/Search Conditions to Keen:Search Conditions

2018-06-29T10:39:13Z

CptTwinkie moved page Official Content/Search Conditions to Keen:Search Conditions

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

CptTwinkie at 10:26, 29 June 2018

2018-06-29T10:26:53Z

← Older revision		Revision as of 10:26, 29 June 2018
Line 63:		Line 63:
	'''Prefix:''' #		'''Prefix:''' #

	Tag condition allows you to search for items based on their [[~~Official_Content/~~Item_Tags\|Tag]]. An item matches this condition when one of its tags contains the ''search term'' in its subtype or display name.		Tag condition allows you to search for items based on their [[Keen:Item_Tags\|Tag]]. An item matches this condition when one of its tags contains the ''search term'' in its subtype or display name.

	===Block Condition===		===Block Condition===

CptTwinkie at 21:33, 1 June 2018

2018-06-01T21:33:46Z

← Older revision		Revision as of 21:33, 1 June 2018
Line 1:		Line 1:
			{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/KEEN_COMPASS_ONLY.png\|description=The search system is a Session Component, and it powers the general search screen (also known as G-Screen).}}
	{{:Official Content/OCH}}		{{:Official Content/OCH}}

CptTwinkie at 15:00, 30 May 2018

2018-05-30T15:00:49Z

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


	The search system is a ''Session Component'', and it powers the general search screen (also known as G-Screen). It is, however, completely detached from the actual screen, and can be used just about anywhere. The system works by loading all relevant definitions, extracting whatever data it needs from the (tag, recipes, items, etc.), and then constructing internal searchable definition database. Since the database is constructed during loading, it works with mods out-of-the-box.		The search system is a ''Session Component'', and it powers the general search screen (also known as G-Screen). It is, however, completely detached from the actual screen, and can be used just about anywhere. The system works by loading all relevant definitions, extracting whatever data it needs from the (tag, recipes, items, etc.), and then constructing internal searchable definition database. Since the database is constructed during loading, it works with mods out-of-the-box.

CptTwinkie at 17:56, 27 December 2017

2017-12-27T17:56:43Z

← Older revision		Revision as of 17:56, 27 December 2017
Line 2:		Line 2:

	{{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		\|release=0\|major=6\|minor=1\|suppress=true}}
	\|major=6
	\|minor=1
	}}
	==Script Access==		==Script Access==
	You can access the search system from your scripts, to find whatever it is that you need. The string you send to the search system can also include a prefix for the various search conditions, including a custom one if you happen to have one. The Search method returns a collection of <code>MyVisualDefinitionBase</code>, which is a common base class used for all searchable definitions.		You can access the search system from your scripts, to find whatever it is that you need. The string you send to the search system can also include a prefix for the various search conditions, including a custom one if you happen to have one. The Search method returns a collection of <code>MyVisualDefinitionBase</code>, which is a common base class used for all searchable definitions.

CptTwinkie at 21:35, 15 December 2017

2017-12-15T21:35:29Z

← Older revision		Revision as of 21:35, 15 December 2017
Line 1:		Line 1:
	The search system is a ''Session Component'', and it powers the general search screen (also known as G-Screen). It is, however, completely detached from the actual screen, and can be used just about anywhere. The system works by loading all relevant definitions, extracting whatever data it needs from the (tag, recipes, items, etc.), and then constructing internal searchable definition database. Since the database is constructed during loading, it works with mods out-of-the-box.		The search system is a ''Session Component'', and it powers the general search screen (also known as G-Screen). It is, however, completely detached from the actual screen, and can be used just about anywhere. The system works by loading all relevant definitions, extracting whatever data it needs from the (tag, recipes, items, etc.), and then constructing internal searchable definition database. Since the database is constructed during loading, it works with mods out-of-the-box.

			{{Version <!-- Do not change the version until the entire page is up-to-date -->
			\|release=0
			\|major=6
			\|minor=1
			}}
	==Script Access==		==Script Access==
	You can access the search system from your scripts, to find whatever it is that you need. The string you send to the search system can also include a prefix for the various search conditions, including a custom one if you happen to have one. The Search method returns a collection of <code>MyVisualDefinitionBase</code>, which is a common base class used for all searchable definitions.		You can access the search system from your scripts, to find whatever it is that you need. The string you send to the search system can also include a prefix for the various search conditions, including a custom one if you happen to have one. The Search method returns a collection of <code>MyVisualDefinitionBase</code>, which is a common base class used for all searchable definitions.