Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
Public Member Functions | Static Public Member Functions | Properties | List of all members
SiliconStudio.BuildEngine.BuildScript Class Reference

Public Member Functions

bool Compile (PluginResolver pluginResolver)
 
IEnumerable< string > GetErrors ()
 
IEnumerable< string > GetWarnings ()
 
void Execute (Builder builder)
 
void Execute (ListBuildStep root)
 

Static Public Member Functions

static BuildScript LoadFromFile (string paradoxSdkDir, string filePath)
 

Properties

string ScriptPath [get, set]
 Indicate the location of this BuildScript. More...
 
string SourceBaseDirectory [get, set]
 Indicate source base directory, which is used as working directory for the Build Engine. The path of every file accessed by the build script must be relative to this directory. More...
 
IEnumerable< KeyValuePair
< string, string > > 		SourceFolders [get, set]
 List of every source folders used in this script, relative to the SourceBaseDirectory. The key describe the variable name, and the value is the relative path. More...
 
string BuildDirectory [get, set]
 Indicate the build directory. This is where the Build Engine will write its cache information as well as the asset database (if used and if OutputDirectory is null) More...
 
string OutputDirectory [get, set]
 Indicate the output directory. This is where the Build Engine will output the asset database files. If null, BuildDirectory value is used. More...
 
string MetadataDatabaseDirectory [get, set]
 Indicate wheither the BuildScript generated errors while it was compiled or loaded More...
 
bool HasErrors [get]
 Indicate wheither the BuildScript generated errors while it was compiled More...
 
bool IsCompiled [get, set]
 Indicate wheither the BuildScript has been compiled More...
 

Detailed Description

Definition at line 15 of file BuildScript.cs.

Member Function Documentation

bool SiliconStudio.BuildEngine.BuildScript.Compile ( PluginResolver  pluginResolver)

Definition at line 99 of file BuildScript.cs.

void SiliconStudio.BuildEngine.BuildScript.Execute ( Builder  builder)

Definition at line 212 of file BuildScript.cs.

void SiliconStudio.BuildEngine.BuildScript.Execute ( ListBuildStep  root)

Definition at line 221 of file BuildScript.cs.

IEnumerable<string> SiliconStudio.BuildEngine.BuildScript.GetErrors ( )

Definition at line 192 of file BuildScript.cs.

IEnumerable<string> SiliconStudio.BuildEngine.BuildScript.GetWarnings ( )

Definition at line 202 of file BuildScript.cs.

static BuildScript SiliconStudio.BuildEngine.BuildScript.LoadFromFile ( string  paradoxSdkDir,
string  filePath 
)
static

Definition at line 69 of file BuildScript.cs.

Property Documentation

string SiliconStudio.BuildEngine.BuildScript.BuildDirectory
getset

Indicate the build directory. This is where the Build Engine will write its cache information as well as the asset database (if used and if OutputDirectory is null)

Definition at line 35 of file BuildScript.cs.

bool SiliconStudio.BuildEngine.BuildScript.HasErrors
get

Indicate wheither the BuildScript generated errors while it was compiled

Definition at line 50 of file BuildScript.cs.

bool SiliconStudio.BuildEngine.BuildScript.IsCompiled
getset

Indicate wheither the BuildScript has been compiled

Definition at line 55 of file BuildScript.cs.

string SiliconStudio.BuildEngine.BuildScript.MetadataDatabaseDirectory
getset

Indicate wheither the BuildScript generated errors while it was compiled or loaded

Definition at line 45 of file BuildScript.cs.

string SiliconStudio.BuildEngine.BuildScript.OutputDirectory
getset

Indicate the output directory. This is where the Build Engine will output the asset database files. If null, BuildDirectory value is used.

Definition at line 40 of file BuildScript.cs.

string SiliconStudio.BuildEngine.BuildScript.ScriptPath
getset

Indicate the location of this BuildScript.

Definition at line 20 of file BuildScript.cs.

string SiliconStudio.BuildEngine.BuildScript.SourceBaseDirectory
getset

Indicate source base directory, which is used as working directory for the Build Engine. The path of every file accessed by the build script must be relative to this directory.

Definition at line 25 of file BuildScript.cs.

IEnumerable<KeyValuePair<string, string> > SiliconStudio.BuildEngine.BuildScript.SourceFolders
getset

List of every source folders used in this script, relative to the SourceBaseDirectory. The key describe the variable name, and the value is the relative path.

Definition at line 30 of file BuildScript.cs.

The documentation for this class was generated from the following file: