cohtml.Net.ScriptCompiler
Inherits from SystemIDisposable
Public Types
| Name | |
|---|---|
| enum class | ScriptType { ST_Classic, ST_Module} The enumeration tells the ScriptCompiler how to compile the provided source. |
Public Functions
| Name | |
|---|---|
| virtual void | Dispose() |
| virtual DataBuffer | Compile(DataBuffer utf8Source, ScriptCompiler.ScriptType scriptType) Compiles a script file synchronously. |
| virtual void | Destroy() Destroys the ScriptCompiler and frees memory. |
Protected Attributes
| Name | |
|---|---|
| bool | swigCMemOwn |
Public Types Documentation
enum ScriptType
| Enumerator | Value | Description |
|---|---|---|
| ST_Classic | Try to compile the provided source as a classic script. | |
| ST_Module | Try to compile the provided source as a module. |
The enumeration tells the ScriptCompiler how to compile the provided source.
Public Functions Documentation
function Dispose
virtual void Dispose()
function Compile
virtual DataBuffer Compile(
DataBuffer utf8Source,
ScriptCompiler.ScriptType scriptType
)
Compiles a script file synchronously.
Parameters:
- utf8Source a data buffer, containing an utf8 encoded script source
- scriptType specify if the provided source is classic script or module
Return: A data buffer, containing the compiled data.
Note: Scripts can be precompiled on Windows then later used on other platforms where Cohtml works with V8’s pointer compression feature enabled. Currently, those are only Microsoft Xbox consoles.
function Destroy
virtual void Destroy()
Destroys the ScriptCompiler and frees memory.
Protected Attributes Documentation
variable swigCMemOwn
bool swigCMemOwn;