CompileGroupclass

object→CompileGroup
Namespace
Sandbox
Assembly
Sandbox.Compiling
Declaration
public class Sandbox.CompileGroup

Constructors1

Showing 1 constructors

public CompileGroup(string name)PUBLICCONSTRUCTOR

ParameterTypeDescription
namestring—

Methods6

Showing 6 methods

public System.Threading.Tasks.Task`1<bool> BuildAsync()PUBLIC

Build the compilers

Returns:Task<bool>—

public virtual sealed void Dispose()PUBLICVIRTUAL

Shut everything down

Returns:void—

public Sandbox.Compiler GetOrCreateCompiler(string name)PUBLIC

ParameterTypeDescription
namestring—
Returns:Compiler—

public void Reset()PUBLIC

Reset the compile group. Clear errors and outputs.

Returns:void—

public System.Threading.Tasks.Task WaitForCompile(System.Threading.CancellationToken token)PUBLIC

ParameterTypeDescription
tokenCancellationToken—
Returns:Task—

Properties13

Showing 13 properties

public Sandbox.AccessControl Sandbox.CompileGroup.AccessControl { get; set; }PUBLICGETSET

AccessControl instance to use when verifying whitelist. Must be set to enable compile-time access control.

Returns:AccessControl—

public bool Sandbox.CompileGroup.AllowFastHotload { get; set; }PUBLICGETSET

True if we want to use fast hotloading with this compile group

Returns:bool—

public System.Collections.Generic.IEnumerable`1<Sandbox.Compiler> Sandbox.CompileGroup.Compilers { get; set; }PUBLICGETSET

The compilers within the group

Returns:IEnumerable<Compiler>—

public bool Sandbox.CompileGroup.IsBuilding { get; set; }PUBLICGETSET

Returns true if we are currently in the process of building

Returns:bool—

public string Sandbox.CompileGroup.Name { get; set; }PUBLICGETSET

The name of this compile group, for debugging/display purposes

Returns:string—

public bool Sandbox.CompileGroup.NeedsBuild { get; set; }PUBLICGETSET

Returns true if we have compiles pending

Returns:bool—

public System.Action Sandbox.CompileGroup.OnCompileFinished { get; set; }PUBLICGETSET

Called when a compiling ends

Returns:Action—

public System.Action Sandbox.CompileGroup.OnCompileStarted { get; set; }PUBLICGETSETLIFECYCLE

Called when a compiling starts

Returns:Action—

public System.Action Sandbox.CompileGroup.OnCompileSuccess { get; set; }PUBLICGETSET

Called when a compile completes successfully. Can access the result from BuildResult.

Returns:Action—

public bool Sandbox.CompileGroup.PrintErrorsInConsole { get; set; }PUBLICGETSET

True if we want to print errors in the console when compiling

Returns:bool—

public static bool Sandbox.CompileGroup.SuppressBuildNotifications { get; set; }PUBLICSTATICGETSET

Build notifications start of suppressed until after startup proper. That way we don't get 4 build notification windows popping up on startup.

Returns:bool—

On this page