Method RemoveEnvironmentProbe
RemoveEnvironmentProbe(AREnvironmentProbe)
Remove an existing environment probe. Support for this feature is provider-specific. Check for support with
the descriptor's
supportsRemovalOfManual
and supportsRemovalOfAutomatic
properties.
Declaration
[Obsolete("Call Destroy() on the AREnvironmentProbe component to remove it. (2020-10-06)")]
public bool RemoveEnvironmentProbe(AREnvironmentProbe probe)
Parameters
Type | Name | Description |
---|---|---|
AREnvironment |
probe | The environment probe to remove |
Returns
Type | Description |
---|---|
bool |
|
Exceptions
Type | Condition |
---|---|
Invalid |
Thrown if this manager is not enabled. |
Invalid |
Thrown if
subsystem is |
Argument |
Thrown if |
Invalid |
Thrown if the environment probe was manually placed, but removal of manually placed probes is not supported.
You can check for this case with placement |
Invalid |
Thrown if the environment probe was automatically placed, but removal of automatically placed probes is not supported.
You can check for this case with placement |