ProjectConfigclass
Configuration of a `Sandbox.Project`.
Constructors1
Showing 1 constructors
public ProjectConfig()
No results match this filter.
Methods4
Showing 4 methods
public T GetMetaOrDefault(string keyname, T defaultValue)
Get the package's meta value. If it's missing or the wrong type then use the default value.
| Parameter | Type | Description |
|---|---|---|
| keyname | string | — |
| defaultValue | T | — |
T—public bool SetMeta(string keyname, object outvalue)
Store custom data at given key in the `Sandbox.DataModel.ProjectConfig.Metadata`.
| Parameter | Type | Description |
|---|---|---|
| keyname | string | The key for the data. |
| outvalue | object | The data itself to store. |
boolAlways true.public string ToJson()
Serialize the entire config to a JSON string.
string—public bool TryGetMeta(string keyname, T outvalue)
Try to get a value at given key in `Sandbox.DataModel.ProjectConfig.Metadata`.
| Parameter | Type | Description |
|---|---|---|
| keyname | string | The key to retrieve the value of. |
| outvalue | T | The value, if it was present in the metadata storage. |
boolWhether the value was successfully retrieved.No results match this filter.
Properties16
Showing 16 properties
public System.IO.DirectoryInfo Sandbox.DataModel.ProjectConfig.AssetsDirectory { get; set; }
The directory housing this addon (TODO)
DirectoryInfo—public System.IO.DirectoryInfo Sandbox.DataModel.ProjectConfig.Directory { get; set; }
The directory housing this addon (TODO)
DirectoryInfo—public System.Collections.Generic.List`1<string> Sandbox.DataModel.ProjectConfig.EditorReferences { get; set; }
A list of packages that this package uses but there is no need to install. For example, a map package might use a model package - but there is no need to download that model package because any usage will organically be included in the manifest. However, when loading this item in the editor, it'd make sense to install these 'cloud' packages.
List<string>—public string Sandbox.DataModel.ProjectConfig.FullIdent { get; set; }
Returns a combination of Org and Ident - for example "facepunch.sandbox" or "valve.cs".
string—public string Sandbox.DataModel.ProjectConfig.Ident { get; set; }
The ident of this addon. For example "sandbox", "cs" or "dm98"
string—public bool Sandbox.DataModel.ProjectConfig.IncludeSourceFiles { get; set; }
If true then we'll include all the source files
bool—public bool Sandbox.DataModel.ProjectConfig.IsStandaloneOnly { get; set; }
Whether or not this project is standalone-only, and supports disabling the whitelist, compiling with /unsafe, etc.
bool—public System.Collections.Generic.Dictionary`2<string,object> Sandbox.DataModel.ProjectConfig.Metadata { get; set; }
Custom key-value storage for this project.
Dictionary<string,object>—public System.Collections.Generic.List`1<string> Sandbox.DataModel.ProjectConfig.Mounts { get; set; }
A list of mounts that are required
List<string>—public string Sandbox.DataModel.ProjectConfig.Org { get; set; }
The ident of the org that owns this addon. For example "facepunch", "valve".
string—public System.Collections.Generic.List`1<string> Sandbox.DataModel.ProjectConfig.PackageReferences { get; set; }
A list of packages that this package depends on. These should be installed alongside this package.
List<string>—public Sandbox.Package.Type Sandbox.DataModel.ProjectConfig.PackageType { get; set; }
Type of the package.
Obsolete: Compare string Type instead
public string Sandbox.DataModel.ProjectConfig.Resources { get; set; }
A list of paths in which to look for extra assets to upload with the addon. Note that compiled asset files are automatically included.
string—public int Sandbox.DataModel.ProjectConfig.Schema { get; set; }
The version of the addon file. Allows us to upgrade internally.
int—public string Sandbox.DataModel.ProjectConfig.Title { get; set; }
The human readable title, for example "Sandbox", "Counter-Strike"
string—public string Sandbox.DataModel.ProjectConfig.Type { get; set; }
The type of addon. Current valid values are "game"
string—No results match this filter.