Feature

import SwiftGodot

Framework to write Godot Game Extensions using the Swift Programming Language.

class EditorFeatureProfile

An editor feature profile which can be used to disable specific features.

case feature3d

The 3D editor. If this feature is disabled, the 3D editor won’t display but 3D nodes will still display in the Create New Node dialog.

case script

The Script tab, which contains the script editor and class reference browser. If this feature is disabled, the Script tab won’t display.

case assetLib

The AssetLib tab. If this feature is disabled, the AssetLib tab won’t display.

case sceneTree

Scene tree editing. If this feature is disabled, the Scene tree dock will still be visible but will be read-only.

case nodeDock

The Node dock. If this feature is disabled, signals and groups won’t be visible and modifiable from the editor.

case filesystemDock

The FileSystem dock. If this feature is disabled, the FileSystem dock won’t be visible.

case importDock

The Import dock. If this feature is disabled, the Import dock won’t be visible.

case historyDock

The History dock. If this feature is disabled, the History dock won’t be visible.

case max

Represents the size of the Feature enum.

override class var godotClassName: StringName { get }

final func getFeatureName(feature: EditorFeatureProfile.Feature) -> String

Returns the specified feature’s human-readable name.

final func isClassDisabled(className: StringName) -> Bool

Returns true if the class specified by className is disabled. When disabled, the class won’t appear in the Create New Node dialog.

final func isClassEditorDisabled(className: StringName) -> Bool

Returns true if editing for the class specified by className is disabled. When disabled, the class will still appear in the Create New Node dialog but the Inspector will be read-only when selecting a node that extends the class.

final func isClassPropertyDisabled(className: StringName, property: StringName) -> Bool

Returns true if property is disabled in the class specified by className. When a property is disabled, it won’t appear in the Inspector when selecting a node that extends the class specified by className.

final func isFeatureDisabled(feature: EditorFeatureProfile.Feature) -> Bool

Returns true if the feature is disabled. When a feature is disabled, it will disappear from the editor entirely.

final func loadFromFile(path: String) -> GodotError

Loads an editor feature profile from a file. The file must follow the JSON format obtained by using the feature profile manager’s Export button or the saveToFile(path:) method.

final func saveToFile(path: String) -> GodotError

Saves the editor feature profile to a file in JSON format. It can then be imported using the feature profile manager’s Import button or the loadFromFile(path:) method.

final func setDisableClass(className: StringName, disable: Bool)

If disable is true, disables the class specified by className. When disabled, the class won’t appear in the Create New Node dialog.

final func setDisableClassEditor(className: StringName, disable: Bool)

If disable is true, disables editing for the class specified by className. When disabled, the class will still appear in the Create New Node dialog but the Inspector will be read-only when selecting a node that extends the class.

final func setDisableClassProperty(className: StringName, property: StringName, disable: Bool)

If disable is true, disables editing for property in the class specified by className. When a property is disabled, it won’t appear in the Inspector when selecting a node that extends the class specified by className.

final func setDisableFeature(_ feature: EditorFeatureProfile.Feature, disable: Bool)

If disable is true, disables the editor feature specified in feature. When a feature is disabled, it will disappear from the editor entirely.

protocol CaseIterable

A type that provides a collection of all of its values.

protocol CustomDebugStringConvertible

A type with a customized textual representation suitable for debugging purposes.

protocol Equatable

A type that can be compared for value equality.

protocol Hashable : Equatable

A type that can be hashed into a Hasher to produce an integer hash value.

protocol RawRepresentable<RawValue>

A type that can be converted to and from an associated raw value.

init?(rawValue: Int64)

var debugDescription: String { get }

A textual representation of this instance, suitable for debugging

var hashValue: Int { get }

static func != (lhs: Self, rhs: Self) -> Bool

Returns a Boolean value indicating whether two values are not equal.

func hash(into hasher: inout Hasher)