Click or drag to resize

ArticyDatabaseFilterObjects Method

Returns a list of all objects that match the given search string.

Namespace:  Articy.Unity
Assembly:  ArticyRuntime (in ArticyRuntime.dll) Version: 1.0.3
Syntax
C#
Copy
public static IList<ArticyObject> FilterObjects(
	string aFilter
)

Parameters

aFilter
Type: SystemString
A string that is used to filter all available objects. This can be numeric string.

Return Value

Type: IListArticyObject
All found objects or an empty list if the filter does not match any objects.
Remarks

The main purpose of this method is to provide an implementation for a search bar in editor scripts.

All currently loaded objects are searched. The filter is used against the TechnicalName, the Id or the DisplayName if the object has one.

Note Note
When this is called from editor code, it contains all objects from all packages. When called in a standalone it can only filter objects in currently loaded packages.
Note Note
When filtering by id, only the hex notation is supported and must start with "0x".
See Also