Class AsyncObjectSearchResult - Revision history

Pw3r: /* GetResults */

2022-03-03T03:09:31Z

GetResults

← Older revision		Revision as of 03:09, 3 March 2022
Line 36:		Line 36:
	;Syntax		;Syntax
	NamedObjectInfo[] results = searchObj.GetResults();		NamedObjectInfo[] results = searchObj.GetResults();
	for (int i = 0; i < results.size(); ++i) {		for (int i = 0; i < results.size(); ++i)
	NamedObjectInfo result = results[i];		{
	Interface.Log("Result " + i + ": '" + result.localisedUsername + "'");		NamedObjectInfo result = results[i];
	// Process each result in some useful way...		Interface.Log("Result " + i + ": '" + result.localisedUsername + "'");
			// Process each result in some useful way...
	}		}
	;Notes		;Notes

Pw3r: /* GetSearchErrorCode */

2022-03-03T03:09:02Z

GetSearchErrorCode

← Older revision		Revision as of 03:09, 3 March 2022
Line 58:		Line 58:
	*Error code for the query		*Error code for the query
	;Syntax		;Syntax
	wait() {		wait()
			{
	on "ObjectSearch", "Failure", msg:		on "ObjectSearch", "Failure", msg:
	if (msg.src == searchObj) {		if (msg.src != searchObj)
	Interface.Log("Search error " + searchObj.GetSearchErrorCode();		continue;
	}		Interface.Log("Search error " + searchObj.GetSearchErrorCode();
			break;
	}		}
	;Notes		;Notes

Danny252: /* Code Examples */ Correct example to wait for AsyncResult, not AsyncLoadComplete

2020-12-28T20:05:57Z

Code Examples: Correct example to wait for AsyncResult, not AsyncLoadComplete

← Older revision		Revision as of 20:05, 28 December 2020
Line 86:		Line 86:
	continue;		continue;

	on "ObjectSearch", "~~AsyncLoadComplete~~", msg:		on "ObjectSearch", "AsyncResult", msg:
	if (msg.src == searchObj)		if (msg.src == searchObj)
	break;		break;

Danny252: /* Related Messages */ Fix table formatting

2020-12-28T19:43:40Z

Related Messages: Fix table formatting

← Older revision		Revision as of 19:43, 28 December 2020
Line 15:		Line 15:
	{{TableHeader\|width=50%\|margin=15px}}		{{TableHeader\|width=50%\|margin=15px}}
	\|-		\|-
	\|bgcolor="#EEEEEE"\|'''Major'''\|\|bgcolor="#EEEEEE"\|'''Minor'''\|\|bgcolor="#EEEEEE"\|'''Source'''\|\|bgcolor="#EEEEEE" \|'''Destination'''\|bgcolor="#EEEEEE"\|'''Description'''		\|bgcolor="#EEEEEE"\|'''Major'''\|\|bgcolor="#EEEEEE"\|'''Minor'''\|\|bgcolor="#EEEEEE"\|'''Source'''\|\|bgcolor="#EEEEEE" \|'''Destination'''\|\|bgcolor="#EEEEEE"\|'''Description'''
	\|-		\|-
	\|ObjectSearch\|\|AsyncResult\|\|AsyncObjectSearchResult\|\|Broadcast\|\|Search is complete, and [[#GetResults\|GetResults]] may be called.		\|ObjectSearch\|\|AsyncResult\|\|AsyncObjectSearchResult\|\|Broadcast\|\|Search is complete, and [[#GetResults\|GetResults]] may be called.

Danny252: Add GetQueryErrorCode

2020-12-28T19:42:42Z

Add GetQueryErrorCode

← Older revision		Revision as of 19:42, 28 December 2020
Line 44:		Line 44:
	*The caller must wait for the search to complete, indicated by the ObjectSearch/AsyncResult message.		*The caller must wait for the search to complete, indicated by the ObjectSearch/AsyncResult message.
	*If the search is not complete, calling this method will result in an exception.		*If the search is not complete, calling this method will result in an exception.
			<br>

			===GetQueryErrorCode===
			{{MethodHeader\|public native int GetQueryErrorCode(void)}}
			See [[#GetSearchErrorCode\|GetSearchErrorCode]]
	<br>		<br>

Danny252: Create AsyncObjectSearchResult

2020-12-28T19:31:36Z

Create AsyncObjectSearchResult

New page

*[[TrainzScript Library Reference|API Hierarchy]]
**[[Class GSObject|GSObject]] *
***[[Class GameObject|GameObject]]
****[[Class AsyncQueryHelper|AsyncQueryHelper]]
*****[[Class AsyncObjectSearchResult|AsyncObjectSearchResult]]
 

*An AsyncObjectSearchResult represents an asynchronous search of objects in the game world.
*[[HowTo/Search for objects in the world]] provides a detailed tutorial on asynchronous searches.
 

==Related Messages==
*Messages sent to and from TrackMark objects are listed below:
 
{{TableHeader|width=50%|margin=15px}}
|-
|bgcolor="#EEEEEE"|'''Major'''||bgcolor="#EEEEEE"|'''Minor'''||bgcolor="#EEEEEE"|'''Source'''||bgcolor="#EEEEEE" |'''Destination'''|bgcolor="#EEEEEE"|'''Description'''
|-
|ObjectSearch||AsyncResult||AsyncObjectSearchResult||Broadcast||Search is complete, and [[#GetResults|GetResults]] may be called.
|-
|ObjectSearch||AsyncLoadComplete||AsyncObjectSearchResult||Broadcast||Loading of search result has been completed. See [[Class World#GetGameObjectByID|World.GetGameObjectByID()]].
|-
|ObjectSearch||Failure||AsyncObjectSearchResult||Broadcast||Search has failed, call [[#GetSearchErrorCode|GetSearchErrorCode]] for more information.
|-
|ObjectSearch||Expired||AsyncObjectSearchResult||Broadcast||New search results are available, and this result has expired. Not posted by default - see [[Class World#GetNamedObjectList|World.GetNamedObjectList()]].
|}

==Methods==
 
===GetResults===
{{MethodHeader|public native [[Class NamedObjectInfo|NamedObjectInfo]][] GetResults(void)}}
;Parameters
*None
;Returned Value
*Array of search results
;Syntax
NamedObjectInfo[] results = searchObj.GetResults();
for (int i = 0; i < results.size(); ++i) {
NamedObjectInfo result = results[i];
Interface.Log("Result " + i + ": '" + result.localisedUsername + "'");
// Process each result in some useful way...
}
;Notes
*The caller must wait for the search to complete, indicated by the ObjectSearch/AsyncResult message.
*If the search is not complete, calling this method will result in an exception.
 

===GetSearchErrorCode===
{{MethodHeader|public native int GetSearchErrorCode(void)}}
;Parameters
*None
;Returned Value
*Error code for the query
;Syntax
wait() {
on "ObjectSearch", "Failure", msg:
if (msg.src == searchObj) {
Interface.Log("Search error " + searchObj.GetSearchErrorCode();
}
}
;Notes
*When a ObjectSearch/Failure message is posted, this method will return an error code.
*Error codes are defined in the ERROR_ constants for [[Class AsyncQueryHelper|AsyncQueryHelper]].
 

==Code Examples==
 
thread void SearchForTrains()
{
// Start a search for any traincars within the world
AsyncObjectSearchResult searchObj = World.GetNamedObjectList(AssetCategory.TrainCar, "");

// Sniff for search related messages, and then wait for either completion or failure
Sniff(searchObj, "ObjectSearch", "", true);
Message msg;
wait()
{
on "ObjectSearch", "Failure", msg:
if (msg.src == searchObj)
break;
continue;

on "ObjectSearch", "AsyncLoadComplete", msg:
if (msg.src == searchObj)
break;
continue;
};

// Check the results
int errCode = searchObj.GetSearchErrorCode();
if (errCode != AsyncObjectSearchResult.ERROR_NONE)
{
// TODO: Add any error handling here, such as waiting and reattempting the
// search later, showing an error message, throwing script exceptions, etc.
return;
}

// Get the search results
NamedObjectInfo[] results = searchObj.GetResults();

// TODO: Add any processing of the results here
}

==Related Methods==
*[[Class World#GetGameObjectByID|World.GetGameObjectByID()]]
*[[Class World#GetNamedObjectList|World.GetNamedObjectList()]]
 
 

==Categories==
[[Category:Script Class]]