Class AddScriptToEvaluateOnNewDocumentCommandSettings
Evaluates given script in every frame upon creation (before loading frame's scripts).
public sealed class AddScriptToEvaluateOnNewDocumentCommandSettings : ICommand
- Inheritance
-
AddScriptToEvaluateOnNewDocumentCommandSettings
- Implements
- Inherited Members
Properties
CommandName
Gets the name of the command.
[JsonIgnore]
public string CommandName { get; }
Property Value
IncludeCommandLineAPI
Specifies whether command line API should be available to the script, defaults to false.
[JsonPropertyName("includeCommandLineAPI")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool? IncludeCommandLineAPI { get; set; }
Property Value
- bool?
RunImmediately
If true, runs the script immediately on existing execution contexts or worlds. Default: false.
[JsonPropertyName("runImmediately")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool? RunImmediately { get; set; }
Property Value
- bool?
Source
Gets or sets the source
[JsonPropertyName("source")]
public string Source { get; set; }
Property Value
WorldName
If specified, creates an isolated world with the given name and evaluates given script in it. This world name will be used as the ExecutionContextDescription::name when the corresponding event is emitted.
[JsonPropertyName("worldName")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? WorldName { get; set; }