TryLocalize
Declaration
Summary
Remarks
Localizes against the site's production-deployed VPS assets only. Asynchronous:
observe the outcome via TryGetLatestLocalization's localized asset
and tracking state. Requests are additive, and submitted assets stay in the
localization set until TryStopLocalize removes them; stopping and
restarting the subsystem does not remove them. This manager must be enabled;
a request made while it is disabled is rejected.
Returns
true if the request was started; otherwise false.
Parameters
| Name | Type | Summary |
|---|---|---|
| siteId | string | The identifier of the site to localize to. |
Overload 1
Summary
Requests localization to one VPS map asset of a site.
Remarks
Like TryLocalize, but assetId
narrows it to that single asset of any deployment, including non-production ones.
assetId is the VPS map asset's ID, as a UUID (32 hex digits,
optionally 0x-prefixed, or the canonical 8-4-4-4-12 form), not the ID of the
asset group's mesh or splat. An empty string localizes against the site's
production-deployed assets, exactly as TryLocalize does. Any
other value is rejected. When the site has no localizable asset with that ID, the
request fails asynchronously. TryStopLocalize with the site's ID
stops it. This manager must be enabled.
Returns
true if the request was started; otherwise false.
Parameters
| Name | Type | Summary |
|---|---|---|
| siteId | string | The identifier of the site the asset belongs to. |
| assetId | string | The VPS map asset's ID, or empty for the site's production assets. |
Overload 2
Summary
Requests localization near a geographic coordinate.
Remarks
Looks up every site holding VPS assets within radiusMeters of the
coordinate and localizes against their production-deployed assets only.
Asynchronous: observe the
outcome via TryGetLatestLocalization's localized asset and tracking
state. Requests are additive, and submitted assets stay in the localization set until
TryStopLocalize removes them; stopping and restarting the subsystem
does not remove them. This manager must be enabled; a request made while it
is disabled is rejected.
Returns
true if the request was started; otherwise false.
Requests localization to a site, identified by its site ID.