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
AREnvironmentProbe	probe	The environment probe to remove

Returns

Type	Description
bool	true if the environment probe was removed, otherwise false.

Exceptions

Type	Condition
InvalidOperationException	Thrown if this manager is not enabled.
InvalidOperationException	Thrown if subsystem is null.
ArgumentNullException	Thrown if probe is null.
InvalidOperationException	Thrown if the environment probe was manually placed, but removal of manually placed probes is not supported. You can check for this case with placementType and the descriptor's 'supportsRemovalOfManual` property.
InvalidOperationException	Thrown if the environment probe was automatically placed, but removal of automatically placed probes is not supported. You can check for this case with placementType and the descriptor's supportsRemovalOfAutomatic property.