s&box docs
API ReferenceSandbox.Volumes

VolumeComponentclass

object→Component→VolumeComponent
Namespace
Sandbox.Volumes
Assembly
Sandbox.Engine
Declaration
public abstract class Sandbox.Volumes.VolumeComponent : Sandbox.Component

Constructors1

Showing 1 constructors

Methods2

Showing 2 methods

protected virtual void DrawGizmos()PROTECTEDVIRTUAL

Returns:void—

public float GetEdgeDistance(Vector3 worldPosition)PUBLIC

Calculates the shortest distance from the specified world position to the nearest edge of the scene volume.

ParameterTypeDescription
worldPositionVector3—
Returns:float—

Properties2

Showing 2 properties

public bool Sandbox.Volumes.VolumeComponent.IsInfinite { get; set; }PUBLICGETSET

True if SceneVolume.Type == SceneVolume.VolumeTypes.Infinite

Returns:bool—

Test()

Previous Page

IsInfinite

Next Page

On this page

Constructorsprotected VolumeComponent()Methodsprotected virtual System.Void DrawGizmos()public System.Single GetEdgeDistance(Vector3 worldPosition)Propertiespublic System.Boolean Sandbox.Volumes.VolumeComponent.IsInfinite { get; set; }public virtual Sandbox.Volumes.SceneVolume Sandbox.Volumes.VolumeComponent.SceneVolume { get; set; }Metadata