G1R AngelScript
Scripting reference for the Gothic 1 Remake
Loading...
Searching...
No Matches
UAngelscriptSettings Class Reference

Static Public Member Functions

Static Functions
static UClass StaticClass ()
Static Public Member Functions inherited from UObject
static UClass StaticClass ()

Public Attributes

Angelscript
float32 EditorMaximumScriptExecutionTime
 Only in editor: If a script function takes longer than this time to execute, kill it with an exception. This allows the editor to recover from accidental infinite loops, but does not work in cooked games!
bool bAllowImplicitPropertyAccessors
 Whether to allow any C++ function that starts with Get...() to be accessed as a property. (Requires editor restart).
bool bScriptFloatIsFloat64
 In order to avoid confusion with blueprints, make the 'float' type in script resolve to 'float64'.
bool bMarkNonUpropertyPropertiesAsTransient
 Some properties are implicitly treated as UPROPERTY:s to be seen correctly by the GC, if true this ensures such properties are marked as transient to avoid unintentional serialization.
EAngelscriptStaticClassMode StaticClassDeprecation
 Whether to deprecate or disallow the usage of AAnyClass::StaticClass(). The newer alternative does not require the StaticClass call, the class name can be used directly.
bool bDefaultFunctionBlueprintCallable
 Whether UFUNCTION()s should be BlueprintCallable by default without explicit BlueprintCallable specifier.
EAngelscriptPropertyEditSpecifier DefaultPropertyEditSpecifier
 Default Edit access specifier for script UPROPERTY()s without explicit Edit specifier on classes.
EAngelscriptPropertyEditSpecifier DefaultPropertyEditSpecifierForStructs
 Default Edit access specifier for script UPROPERTY()s without explicit Edit specifier on structs.
EAngelscriptPropertyBlueprintSpecifier DefaultPropertyBlueprintSpecifier
 Default Blueprint access specifier for script UPROPERTY()s without explicit Blueprint specifier.
TArray< FString > PreprocessorFlags
 Additional preprocessor flags which will be defined when preprocessing angelscript files. Add them e.g. to BaseEngine.ini: [/Script/AngelscriptCode.AngelscriptSettings] +PreprocessorFlags="FOO" +PreprocessorFlags="BAR".
TArray< FString > BlueprintLibraryNamespacePrefixesToStrip
 Strip these prefixes from namespaced binds. For example, when stripping "Kismet": UKismetSystemLibrary::IsStandalone() becomes SystemLibrary::IsStandalone().
bool bForceConstWithinDevelopmentOnlyFunctions
 Whether any code that is placed within check() asserts, Print() statements and other development-only functions should only be allowed to call const methods. This is intended to help catch issues with side-effects being placed inside expressions that get compiled out in shipping builds.
TArray< FString > BlueprintLibraryNamespaceSuffixesToStrip
 Strip these suffixes from namespaced binds. For example, when stripping "Library": SystemLibrary::IsStandalone() becomes System::IsStandalone().
Backwards Compatibility
bool bAllowRawConstructorsForComponentsAndActors
 Whether to allow actor and component classes to be instantiated using their raw constructor, instead of forcing SpawnActor or UComponent::Create() calls.
bool bUseScriptNameForBlueprintLibraryNamespaces
 Whether we should use the ScriptName meta tag for namespaced binds if available.
EAngelscriptMathNamespace MathNamespace
 Namespace to use for math library functions in angelscript.
bool bAutomaticImports
 Whether to use the new automatic import system (explicit import statements no longer used).
bool bWarnOnManualImportStatements
 Emit warnings when import statements are used while automatic imports are turned on.
JIT
uint NeverJITFunctionsLargerThan
 Never JIT functions that have more Bytecode than this threshold.
TArray< FString > NeverJITFunctionNames
 Function names to never include in JIT. (Wildcard string).
TArray< FString > NeverJITModules
 Full module path to never include in JIT. (Wildcard string).
TArray< FString > NeverJITClassNames
 Class names to never include in JIT. (Wildcard string).
Warnings and Errors
bool bErrorWhenUsingInvalidWorldContext
 Throw an exception when calling a function that requires a World Context to be set, but the current object is not in a world. Note: this error is only checked in editor for performance reasons.
bool bWarnOnUnusedReturnValueForConstMethods
 Show a warning when the result of a const method is not used.
bool bWarnOnFloatConstantsForDoubleValues
 Emit a warning when using a float constant (eg 0.f) to initialize a double value.
bool bWarnOnDivergentComparisonOperatorOverloads
 Show a warning when a comparison operator overload is implemented targeting a different type than the containing type.
bool bWarnOnIncrementDecrementInComplexExpression
 Show a warning when an increment or decrement (++ / –) expression is used within a complex expression. Side effects are not usually expected for longer expressions and can be hard to read.
bool bTreatWarningsAsErrors
 If set, warnings are treated as errors. If not set, warnings will be reported but will still allow the game to start.
bool bWarnIntegerDivision
 Emit a warning for precision loss when integer division is used.
bool bDeprecateDoubleType
 Deprecate usage of the 'double' type in script, in favor of 'float64' or just 'float' when bScriptFloatIsFloat64.
bool bWarnOnImplicitSignedUnsignedConversion
 Show a warning when an implicit conversion between signed/unsigned integers can cause incorrect results.
bool bErrorOnIncorrectEditorOnlyCode
 Show an error when a function or property that is editor-only is used outside of an EDITOR block or editor-only script module.
Public Attributes inherited from UObject
const UClass Class
const UObject Outer
const UPackage Outermost
const UPackage Package
const UWorld World
const FName Name
const bool IsRooted

Additional Inherited Members

Public Member Functions inherited from UObject
bool MarkPackageDirty () const
void RemoveFromRoot ()
bool GetIsRooted () const
bool IsTransient () const
bool Modify (bool bAlwaysMarkDirty=true)
void SetTransactional (bool bTransactional)
bool IsSupportedForNetworking () const
UClass GetClass () const
UObject GetOuter () const
UObject GetTypedOuter (TSubclassOf< UObject > Target) const
 Traverses the outer chain searching for the next object of a certain type.
UPackage GetOutermost () const
UPackage GetPackage () const
void AddToRoot ()
UWorld GetWorld () const
FName GetName () const
FString GetFullName (const UObject StopOuter=nullptr) const
FString GetPathName (const UObject StopOuter=nullptr) const
bool IsA (const UClass Class) const
 Returns true if this object is of the specified type, or a child of that type.
void SaveConfig ()
void LoadConfig ()
void ReloadConfig ()
void CopyScriptPropertiesFrom (const UObject OtherObject)
void opCast (?&Address) const
FString ToString () const

Member Function Documentation

◆ StaticClass()

UClass StaticClass ( )
static

Member Data Documentation

◆ bAllowImplicitPropertyAccessors

bool bAllowImplicitPropertyAccessors

Whether to allow any C++ function that starts with Get...() to be accessed as a property. (Requires editor restart).

◆ bAllowRawConstructorsForComponentsAndActors

bool bAllowRawConstructorsForComponentsAndActors

Whether to allow actor and component classes to be instantiated using their raw constructor, instead of forcing SpawnActor or UComponent::Create() calls.

◆ bAutomaticImports

bool bAutomaticImports

Whether to use the new automatic import system (explicit import statements no longer used).

◆ bDefaultFunctionBlueprintCallable

bool bDefaultFunctionBlueprintCallable

Whether UFUNCTION()s should be BlueprintCallable by default without explicit BlueprintCallable specifier.

◆ bDeprecateDoubleType

bool bDeprecateDoubleType

Deprecate usage of the 'double' type in script, in favor of 'float64' or just 'float' when bScriptFloatIsFloat64.

◆ bErrorOnIncorrectEditorOnlyCode

bool bErrorOnIncorrectEditorOnlyCode

Show an error when a function or property that is editor-only is used outside of an EDITOR block or editor-only script module.

Note: Can cause false positives if a function or property is declared separately in editor-only and not-editor-only blocks. In that case, put the preprocessor directives inside the function body, instead of around the whole function.

◆ bErrorWhenUsingInvalidWorldContext

bool bErrorWhenUsingInvalidWorldContext

Throw an exception when calling a function that requires a World Context to be set, but the current object is not in a world. Note: this error is only checked in editor for performance reasons.

◆ bForceConstWithinDevelopmentOnlyFunctions

bool bForceConstWithinDevelopmentOnlyFunctions

Whether any code that is placed within check() asserts, Print() statements and other development-only functions should only be allowed to call const methods. This is intended to help catch issues with side-effects being placed inside expressions that get compiled out in shipping builds.

◆ BlueprintLibraryNamespacePrefixesToStrip

TArray<FString> BlueprintLibraryNamespacePrefixesToStrip

Strip these prefixes from namespaced binds. For example, when stripping "Kismet": UKismetSystemLibrary::IsStandalone() becomes SystemLibrary::IsStandalone().

◆ BlueprintLibraryNamespaceSuffixesToStrip

TArray<FString> BlueprintLibraryNamespaceSuffixesToStrip

Strip these suffixes from namespaced binds. For example, when stripping "Library": SystemLibrary::IsStandalone() becomes System::IsStandalone().

◆ bMarkNonUpropertyPropertiesAsTransient

bool bMarkNonUpropertyPropertiesAsTransient

Some properties are implicitly treated as UPROPERTY:s to be seen correctly by the GC, if true this ensures such properties are marked as transient to avoid unintentional serialization.

◆ bScriptFloatIsFloat64

bool bScriptFloatIsFloat64

In order to avoid confusion with blueprints, make the 'float' type in script resolve to 'float64'.

◆ bTreatWarningsAsErrors

bool bTreatWarningsAsErrors

If set, warnings are treated as errors. If not set, warnings will be reported but will still allow the game to start.

◆ bUseScriptNameForBlueprintLibraryNamespaces

bool bUseScriptNameForBlueprintLibraryNamespaces

Whether we should use the ScriptName meta tag for namespaced binds if available.

◆ bWarnIntegerDivision

bool bWarnIntegerDivision

Emit a warning for precision loss when integer division is used.

◆ bWarnOnDivergentComparisonOperatorOverloads

bool bWarnOnDivergentComparisonOperatorOverloads

Show a warning when a comparison operator overload is implemented targeting a different type than the containing type.

◆ bWarnOnFloatConstantsForDoubleValues

bool bWarnOnFloatConstantsForDoubleValues

Emit a warning when using a float constant (eg 0.f) to initialize a double value.

◆ bWarnOnImplicitSignedUnsignedConversion

bool bWarnOnImplicitSignedUnsignedConversion

Show a warning when an implicit conversion between signed/unsigned integers can cause incorrect results.

◆ bWarnOnIncrementDecrementInComplexExpression

bool bWarnOnIncrementDecrementInComplexExpression

Show a warning when an increment or decrement (++ / –) expression is used within a complex expression. Side effects are not usually expected for longer expressions and can be hard to read.

◆ bWarnOnManualImportStatements

bool bWarnOnManualImportStatements

Emit warnings when import statements are used while automatic imports are turned on.

◆ bWarnOnUnusedReturnValueForConstMethods

bool bWarnOnUnusedReturnValueForConstMethods

Show a warning when the result of a const method is not used.

◆ DefaultPropertyBlueprintSpecifier

EAngelscriptPropertyBlueprintSpecifier DefaultPropertyBlueprintSpecifier

Default Blueprint access specifier for script UPROPERTY()s without explicit Blueprint specifier.

◆ DefaultPropertyEditSpecifier

EAngelscriptPropertyEditSpecifier DefaultPropertyEditSpecifier

Default Edit access specifier for script UPROPERTY()s without explicit Edit specifier on classes.

◆ DefaultPropertyEditSpecifierForStructs

EAngelscriptPropertyEditSpecifier DefaultPropertyEditSpecifierForStructs

Default Edit access specifier for script UPROPERTY()s without explicit Edit specifier on structs.

◆ EditorMaximumScriptExecutionTime

float32 EditorMaximumScriptExecutionTime

Only in editor: If a script function takes longer than this time to execute, kill it with an exception. This allows the editor to recover from accidental infinite loops, but does not work in cooked games!

◆ MathNamespace

Namespace to use for math library functions in angelscript.

◆ NeverJITClassNames

TArray<FString> NeverJITClassNames

Class names to never include in JIT. (Wildcard string).

◆ NeverJITFunctionNames

TArray<FString> NeverJITFunctionNames

Function names to never include in JIT. (Wildcard string).

◆ NeverJITFunctionsLargerThan

uint NeverJITFunctionsLargerThan

Never JIT functions that have more Bytecode than this threshold.

◆ NeverJITModules

TArray<FString> NeverJITModules

Full module path to never include in JIT. (Wildcard string).

◆ PreprocessorFlags

TArray<FString> PreprocessorFlags

Additional preprocessor flags which will be defined when preprocessing angelscript files. Add them e.g. to BaseEngine.ini: [/Script/AngelscriptCode.AngelscriptSettings] +PreprocessorFlags="FOO" +PreprocessorFlags="BAR".

◆ StaticClassDeprecation

EAngelscriptStaticClassMode StaticClassDeprecation

Whether to deprecate or disallow the usage of AAnyClass::StaticClass(). The newer alternative does not require the StaticClass call, the class name can be used directly.