s&box docs
API ReferenceSandbox

SceneMapclass

Map geometry that can be rendered within a `Sandbox.SceneWorld`.

object→SceneMap
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public sealed class Sandbox.SceneMap

Constructors1

Showing 1 constructors

public SceneMap(Sandbox.SceneWorld sceneWorld, string map)PUBLICCONSTRUCTOR

Create a scene map within a scene world.

ParameterTypeDescription
sceneWorldSceneWorld—
mapstring—

Methods2

Showing 2 methods

public static System.Threading.Tasks.Task`1<Sandbox.SceneMap> CreateAsync(Sandbox.SceneWorld sceneWorld, string map, System.Threading.CancellationToken cancelToken = null)PUBLICSTATIC

Create scene map asynchronously for when large maps take time to load.

ParameterTypeDescription
sceneWorldSceneWorld—
mapstring—
cancelToken = nullCancellationToken—
Returns:Task<SceneMap>—

public void Delete()PUBLIC

Delete this scene map. You shouldn't access it anymore.

Returns:void—

Properties6

Showing 6 properties

public BBox Sandbox.SceneMap.Bounds { get; set; }PUBLICGETSET

Bounds of the map.

Returns:BBox—

public virtual sealed bool Sandbox.SceneMap.IsValid { get; set; }PUBLICVIRTUALGETSET

Is the map valid.

Returns:bool—

public string Sandbox.SceneMap.MapFolder { get; set; }PUBLICGETSET

maps/davej/cs_assault

Returns:string—

public string Sandbox.SceneMap.MapName { get; set; }PUBLICGETSET

cs_assault

Returns:string—

SetScene()

Previous Page

Bounds

Next Page

On this page

Constructorspublic SceneMap(Sandbox.SceneWorld sceneWorld, System.String map)Methodspublic static System.Threading.Tasks.Task`1<Sandbox.SceneMap> CreateAsync(Sandbox.SceneWorld sceneWorld, System.String map, System.Threading.CancellationToken cancelToken = null)public System.Void Delete()Propertiespublic BBox Sandbox.SceneMap.Bounds { get; set; }public virtual sealed System.Boolean Sandbox.SceneMap.IsValid { get; set; }public System.String Sandbox.SceneMap.MapFolder { get; set; }public System.String Sandbox.SceneMap.MapName { get; set; }public Sandbox.SceneWorld Sandbox.SceneMap.World { get; set; }public Vector3 Sandbox.SceneMap.WorldOrigin { get; set; }Metadata