ResourceCompileContextclass
Constructors1
Showing 1 constructors
protected ResourceCompileContext()
No results match this filter.
Methods12
Showing 12 methods
public virtual void AddCompileReference(string path)
Add a reference that is needed to compile this resource, but isn't actually needed once compiled.
| Parameter | Type | Description |
|---|---|---|
| path | string | — |
void—public virtual void AddGameFileReference(string path)
Add a game file reference. This file will be included in packages but is not a native resource. Use this for arbitrary data files that are loaded by managed code (e.g. navdata files).
| Parameter | Type | Description |
|---|---|---|
| path | string | — |
void—public virtual void AddRuntimeReference(string path)
Add a reference. This means that the resource we're compiling depends on this resource.
| Parameter | Type | Description |
|---|---|---|
| path | string | — |
void—public virtual Sandbox.Resources.ResourceCompileContext.Child CreateChild(string absolutePath)
Create a child resource
| Parameter | Type | Description |
|---|---|---|
| absolutePath | string | — |
public virtual byte[] ReadSource()
Read the source, either from in memory, or from disk
byte[]—public System.Text.Json.Nodes.JsonObject ReadSourceAsJson()
Read the source, either from in memory, or from disk
JsonObject—public string ReadSourceAsString()
Read the source, either from in memory, or from disk
string—public virtual string ScanJson(string json)
Load the json and scan it for paths or any embedded resources
| Parameter | Type | Description |
|---|---|---|
| json | string | — |
string—public void WriteBlock(string blockName, System.ReadOnlySpan`1<byte> data)
| Parameter | Type | Description |
|---|---|---|
| blockName | string | — |
| data | ReadOnlySpan<byte> | — |
void—public void WriteBlockJson(string blockName, object obj)
Serialize an object to json and write it to a named block in the compiled resource. Read it back at runtime in `Sandbox.Resource.OnLoaded(Sandbox.ResourceLoadContext)`.
| Parameter | Type | Description |
|---|---|---|
| blockName | string | — |
| obj | object | — |
void—No results match this filter.
Properties5
Showing 5 properties
public virtual string Sandbox.Resources.ResourceCompileContext.AbsolutePath { get; set; }
The absolute path to the resource on disk
string—public Sandbox.Resources.ResourceCompileContext.DataStream Sandbox.Resources.ResourceCompileContext.Data { get; set; }
Get the data to write to
public virtual string Sandbox.Resources.ResourceCompileContext.RelativePath { get; set; }
The path relative to the assets folder
string—public virtual int Sandbox.Resources.ResourceCompileContext.ResourceVersion { get; set; }
The resource version can be important
int—public Sandbox.Resources.ResourceCompileContext.DataStream Sandbox.Resources.ResourceCompileContext.StreamingData { get; set; }
Get the streaming data to write to
No results match this filter.