Table of Contents

Class ScriptLanguageExtension

Namespace
Godot
Assembly
GodotSharp.dll
public class ScriptLanguageExtension : ScriptLanguage, IDisposable
Inheritance
ScriptLanguageExtension
Implements
Inherited Members

Constructors

ScriptLanguageExtension()

public ScriptLanguageExtension()

Methods

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

_AddGlobalConstant(StringName, Variant)

public virtual void _AddGlobalConstant(StringName name, Variant value)

Parameters

name StringName
value Variant

_AddNamedGlobalConstant(StringName, Variant)

public virtual void _AddNamedGlobalConstant(StringName name, Variant value)

Parameters

name StringName
value Variant

_AutoIndentCode(string, int, int)

public virtual string _AutoIndentCode(string code, int fromLine, int toLine)

Parameters

code string
fromLine int
toLine int

Returns

string

_CanInheritFromFile()

public virtual bool _CanInheritFromFile()

Returns

bool

_CompleteCode(string, string, GodotObject)

public virtual Dictionary _CompleteCode(string code, string path, GodotObject owner)

Parameters

code string
path string
owner GodotObject

Returns

Dictionary

_CreateScript()

public virtual GodotObject _CreateScript()

Returns

GodotObject

_DebugGetCurrentStackInfo()

public virtual Array<Dictionary> _DebugGetCurrentStackInfo()

Returns

Array<Dictionary>

_DebugGetError()

public virtual string _DebugGetError()

Returns

string

_DebugGetGlobals(int, int)

public virtual Dictionary _DebugGetGlobals(int maxSubitems, int maxDepth)

Parameters

maxSubitems int
maxDepth int

Returns

Dictionary

_DebugGetStackLevelCount()

public virtual int _DebugGetStackLevelCount()

Returns

int

_DebugGetStackLevelFunction(int)

public virtual string _DebugGetStackLevelFunction(int level)

Parameters

level int

Returns

string

_DebugGetStackLevelLine(int)

public virtual int _DebugGetStackLevelLine(int level)

Parameters

level int

Returns

int

_DebugGetStackLevelLocals(int, int, int)

public virtual Dictionary _DebugGetStackLevelLocals(int level, int maxSubitems, int maxDepth)

Parameters

level int
maxSubitems int
maxDepth int

Returns

Dictionary

_DebugGetStackLevelMembers(int, int, int)

public virtual Dictionary _DebugGetStackLevelMembers(int level, int maxSubitems, int maxDepth)

Parameters

level int
maxSubitems int
maxDepth int

Returns

Dictionary

_DebugParseStackLevelExpression(int, string, int, int)

public virtual string _DebugParseStackLevelExpression(int level, string expression, int maxSubitems, int maxDepth)

Parameters

level int
expression string
maxSubitems int
maxDepth int

Returns

string

_FindFunction(string, string)

public virtual int _FindFunction(string className, string functionName)

Parameters

className string
functionName string

Returns

int

_Finish()

public virtual void _Finish()

_Frame()

public virtual void _Frame()

_GetBuiltInTemplates(StringName)

public virtual Array<Dictionary> _GetBuiltInTemplates(StringName @object)

Parameters

object StringName

Returns

Array<Dictionary>

_GetCommentDelimiters()

public virtual string[] _GetCommentDelimiters()

Returns

string[]

_GetDocCommentDelimiters()

public virtual string[] _GetDocCommentDelimiters()

Returns

string[]

_GetExtension()

public virtual string _GetExtension()

Returns

string

_GetGlobalClassName(string)

public virtual Dictionary _GetGlobalClassName(string path)

Parameters

path string

Returns

Dictionary

_GetName()

public virtual string _GetName()

Returns

string

_GetPublicAnnotations()

public virtual Array<Dictionary> _GetPublicAnnotations()

Returns

Array<Dictionary>

_GetPublicConstants()

public virtual Dictionary _GetPublicConstants()

Returns

Dictionary

_GetPublicFunctions()

public virtual Array<Dictionary> _GetPublicFunctions()

Returns

Array<Dictionary>

_GetRecognizedExtensions()

public virtual string[] _GetRecognizedExtensions()

Returns

string[]

_GetReservedWords()

public virtual string[] _GetReservedWords()

Returns

string[]

_GetStringDelimiters()

public virtual string[] _GetStringDelimiters()

Returns

string[]

_GetType()

public virtual string _GetType()

Returns

string

_HandlesGlobalClassType(string)

public virtual bool _HandlesGlobalClassType(string type)

Parameters

type string

Returns

bool

_HasNamedClasses()

Deprecated. This method is not called by the engine.

[Obsolete("This method is deprecated.")]
public virtual bool _HasNamedClasses()

Returns

bool

_Init()

public virtual void _Init()

_IsControlFlowKeyword(string)

public virtual bool _IsControlFlowKeyword(string keyword)

Parameters

keyword string

Returns

bool

_IsUsingTemplates()

public virtual bool _IsUsingTemplates()

Returns

bool

_LookupCode(string, string, string, GodotObject)

public virtual Dictionary _LookupCode(string code, string symbol, string path, GodotObject owner)

Parameters

code string
symbol string
path string
owner GodotObject

Returns

Dictionary

_MakeFunction(string, string, string[])

public virtual string _MakeFunction(string className, string functionName, string[] functionArgs)

Parameters

className string
functionName string
functionArgs string[]

Returns

string

_MakeTemplate(string, string, string)

public virtual Script _MakeTemplate(string template, string className, string baseClassName)

Parameters

template string
className string
baseClassName string

Returns

Script

_OpenInExternalEditor(Script, int, int)

public virtual Error _OpenInExternalEditor(Script script, int line, int column)

Parameters

script Script
line int
column int

Returns

Error

_OverridesExternalEditor()

public virtual bool _OverridesExternalEditor()

Returns

bool

_ProfilingStart()

public virtual void _ProfilingStart()

_ProfilingStop()

public virtual void _ProfilingStop()

_ReloadAllScripts()

public virtual void _ReloadAllScripts()

_ReloadToolScript(Script, bool)

public virtual void _ReloadToolScript(Script script, bool softReload)

Parameters

script Script
softReload bool

_RemoveNamedGlobalConstant(StringName)

public virtual void _RemoveNamedGlobalConstant(StringName name)

Parameters

name StringName

_SupportsBuiltinMode()

public virtual bool _SupportsBuiltinMode()

Returns

bool

_SupportsDocumentation()

public virtual bool _SupportsDocumentation()

Returns

bool

_ThreadEnter()

public virtual void _ThreadEnter()

_ThreadExit()

public virtual void _ThreadExit()

_Validate(string, string, bool, bool, bool, bool)

public virtual Dictionary _Validate(string script, string path, bool validateFunctions, bool validateErrors, bool validateWarnings, bool validateSafeLines)

Parameters

script string
path string
validateFunctions bool
validateErrors bool
validateWarnings bool
validateSafeLines bool

Returns

Dictionary

_ValidatePath(string)

public virtual string _ValidatePath(string path)

Parameters

path string

Returns

string