FunctionProxies

public static class FunctionProxies
Collection of all loaded function proxies.

Properties

Count

#
public static int Count { get; }
Gets the number of proxies in this server.

DefaultRules

#
public static Rules DefaultRules { get; }
Gets the default rules used for function organisation.

Proxies

#
public static IEnumerable<FunctionProxy> Proxies { get; }
Enumerate over all proxies which the user is allowed to browse. Functions belonging to a fleeting plugin are omitted — see FleetingPlugins.

Methods

FindById

#
public static FunctionProxy FindById(Guid id)
Try and get a proxy based on ID.
Parameters:
id (Guid)

FindByType

#
public static FunctionProxy FindByType(Type type)
Try and get a proxy based on a function type.
Parameters:
type (Type)

IsKnownId

#
public static bool IsKnownId(Guid id)
Gets whether a specific ObjectId has been registered with this server.
Parameters:
id (Guid)

RegisterObject

#
public static bool RegisterObject(Type functionType, Plugin plugin)
Add a new function type to this server.
Parameters:
functionType (Type)Object type, must be a constructible type which is assignable to Function.
plugin (Plugin)Plugin which owns this object.
Returns: True if type was added.

Search

#
public static FunctionProxy[] Search(string query, int maxResults)
Search the server for a specific query.
Parameters:
query (string)Text query.
maxResults (int)Maximum number of returned results.
Returns: Array of search results, sorted from most relevant to least relevant.