11969 lines
681 KiB
XML
11969 lines
681 KiB
XML
<?xml version="1.0"?>
|
||
<doc>
|
||
<assembly>
|
||
<name>GodotSharpEditor</name>
|
||
</assembly>
|
||
<members>
|
||
<member name="T:Godot.EditorUndoRedoManager">
|
||
<summary>
|
||
<para><see cref="T:Godot.EditorUndoRedoManager"/> is a manager for <see cref="T:Godot.UndoRedo"/> objects associated with edited scenes. Each scene has its own undo history and <see cref="T:Godot.EditorUndoRedoManager"/> ensures that each action performed in the editor gets associated with a proper scene. For actions not related to scenes (<see cref="T:Godot.ProjectSettings"/> edits, external resources, etc.), a separate global history is used.</para>
|
||
<para>The usage is mostly the same as <see cref="T:Godot.UndoRedo"/>. You create and commit actions and the manager automatically decides under-the-hood what scenes it belongs to. The scene is deduced based on the first operation in an action, using the object from the operation. The rules are as follows:</para>
|
||
<para>- If the object is a <see cref="T:Godot.Node"/>, use the currently edited scene;</para>
|
||
<para>- If the object is a built-in resource, use the scene from its path;</para>
|
||
<para>- If the object is external resource or anything else, use global history.</para>
|
||
<para>This guessing can sometimes yield false results, so you can provide a custom context object when creating an action.</para>
|
||
<para><see cref="T:Godot.EditorUndoRedoManager"/> is intended to be used by Godot editor plugins. You can obtain it using <see cref="M:Godot.EditorPlugin.GetUndoRedo"/>. For non-editor uses or plugins that don't need to integrate with the editor's undo history, use <see cref="T:Godot.UndoRedo"/> instead.</para>
|
||
<para>The manager's API is mostly the same as in <see cref="T:Godot.UndoRedo"/>, so you can refer to its documentation for more examples. The main difference is that <see cref="T:Godot.EditorUndoRedoManager"/> uses object + method name for actions, instead of <see cref="T:Godot.Callable"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.CreateAction(System.String,Godot.UndoRedo.MergeMode,Godot.GodotObject)">
|
||
<inheritdoc cref="M:Godot.EditorUndoRedoManager.CreateAction(System.String,Godot.UndoRedo.MergeMode,Godot.GodotObject,System.Boolean)"/>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.SpecialHistory.GlobalHistory">
|
||
<summary>
|
||
<para>Global history not associated with any scene, but with external resources etc.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.SpecialHistory.RemoteHistory">
|
||
<summary>
|
||
<para>History associated with remote inspector. Used when live editing a running project.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.SpecialHistory.InvalidHistory">
|
||
<summary>
|
||
<para>Invalid "null" history. It's a special value, not associated with any object.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.CreateAction(System.String,Godot.UndoRedo.MergeMode,Godot.GodotObject,System.Boolean)">
|
||
<summary>
|
||
<para>Create a new action. After this is called, do all your calls to <see cref="M:Godot.EditorUndoRedoManager.AddDoMethod(Godot.GodotObject,Godot.StringName,Godot.Variant[])"/>, <see cref="M:Godot.EditorUndoRedoManager.AddUndoMethod(Godot.GodotObject,Godot.StringName,Godot.Variant[])"/>, <see cref="M:Godot.EditorUndoRedoManager.AddDoProperty(Godot.GodotObject,Godot.StringName,Godot.Variant)"/>, and <see cref="M:Godot.EditorUndoRedoManager.AddUndoProperty(Godot.GodotObject,Godot.StringName,Godot.Variant)"/>, then commit the action with <see cref="M:Godot.EditorUndoRedoManager.CommitAction(System.Boolean)"/>.</para>
|
||
<para>The way actions are merged is dictated by the <paramref name="mergeMode"/> argument. See <see cref="T:Godot.UndoRedo.MergeMode"/> for details.</para>
|
||
<para>If <paramref name="customContext"/> object is provided, it will be used for deducing target history (instead of using the first operation).</para>
|
||
<para>The way undo operation are ordered in actions is dictated by <paramref name="backwardUndoOps"/>. When <paramref name="backwardUndoOps"/> is <see langword="false"/> undo option are ordered in the same order they were added. Which means the first operation to be added will be the first to be undone.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.CommitAction(System.Boolean)">
|
||
<summary>
|
||
<para>Commits the action. If <paramref name="execute"/> is <see langword="true"/> (default), all "do" methods/properties are called/set when this function is called.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.IsCommittingAction">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if the <see cref="T:Godot.EditorUndoRedoManager"/> is currently committing the action, i.e. running its "do" method or property change (see <see cref="M:Godot.EditorUndoRedoManager.CommitAction(System.Boolean)"/>).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.ForceFixedHistory">
|
||
<summary>
|
||
<para>Forces the next operation (e.g. <see cref="M:Godot.EditorUndoRedoManager.AddDoMethod(Godot.GodotObject,Godot.StringName,Godot.Variant[])"/>) to use the action's history rather than guessing it from the object. This is sometimes needed when a history can't be correctly determined, like for a nested resource that doesn't have a path yet.</para>
|
||
<para>This method should only be used when absolutely necessary, otherwise it might cause invalid history state. For most of complex cases, the <c>custom_context</c> parameter of <see cref="M:Godot.EditorUndoRedoManager.CreateAction(System.String,Godot.UndoRedo.MergeMode,Godot.GodotObject,System.Boolean)"/> is sufficient.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.AddDoMethod(Godot.GodotObject,Godot.StringName,Godot.Variant[])">
|
||
<summary>
|
||
<para>Register a method that will be called when the action is committed (i.e. the "do" action).</para>
|
||
<para>If this is the first operation, the <paramref name="object"/> will be used to deduce target undo history.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.AddDoMethod(Godot.GodotObject,Godot.StringName,System.ReadOnlySpan{Godot.Variant})">
|
||
<summary>
|
||
<para>Register a method that will be called when the action is committed (i.e. the "do" action).</para>
|
||
<para>If this is the first operation, the <paramref name="object"/> will be used to deduce target undo history.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.AddUndoMethod(Godot.GodotObject,Godot.StringName,Godot.Variant[])">
|
||
<summary>
|
||
<para>Register a method that will be called when the action is undone (i.e. the "undo" action).</para>
|
||
<para>If this is the first operation, the <paramref name="object"/> will be used to deduce target undo history.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.AddUndoMethod(Godot.GodotObject,Godot.StringName,System.ReadOnlySpan{Godot.Variant})">
|
||
<summary>
|
||
<para>Register a method that will be called when the action is undone (i.e. the "undo" action).</para>
|
||
<para>If this is the first operation, the <paramref name="object"/> will be used to deduce target undo history.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.AddDoProperty(Godot.GodotObject,Godot.StringName,Godot.Variant)">
|
||
<summary>
|
||
<para>Register a property value change for "do".</para>
|
||
<para>If this is the first operation, the <paramref name="object"/> will be used to deduce target undo history.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.AddUndoProperty(Godot.GodotObject,Godot.StringName,Godot.Variant)">
|
||
<summary>
|
||
<para>Register a property value change for "undo".</para>
|
||
<para>If this is the first operation, the <paramref name="object"/> will be used to deduce target undo history.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.AddDoReference(Godot.GodotObject)">
|
||
<summary>
|
||
<para>Register a reference for "do" that will be erased if the "do" history is lost. This is useful mostly for new nodes created for the "do" call. Do not use for resources.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.AddUndoReference(Godot.GodotObject)">
|
||
<summary>
|
||
<para>Register a reference for "undo" that will be erased if the "undo" history is lost. This is useful mostly for nodes removed with the "do" call (not the "undo" call!).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.GetObjectHistoryId(Godot.GodotObject)">
|
||
<summary>
|
||
<para>Returns the history ID deduced from the given <paramref name="object"/>. It can be used with <see cref="M:Godot.EditorUndoRedoManager.GetHistoryUndoRedo(System.Int32)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.GetHistoryUndoRedo(System.Int32)">
|
||
<summary>
|
||
<para>Returns the <see cref="T:Godot.UndoRedo"/> object associated with the given history <paramref name="id"/>.</para>
|
||
<para><paramref name="id"/> above <c>0</c> are mapped to the opened scene tabs (but it doesn't match their order). <paramref name="id"/> of <c>0</c> or lower have special meaning (see <see cref="T:Godot.EditorUndoRedoManager.SpecialHistory"/>).</para>
|
||
<para>Best used with <see cref="M:Godot.EditorUndoRedoManager.GetObjectHistoryId(Godot.GodotObject)"/>. This method is only provided in case you need some more advanced methods of <see cref="T:Godot.UndoRedo"/> (but keep in mind that directly operating on the <see cref="T:Godot.UndoRedo"/> object might affect editor's stability).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.ClearHistory(System.Int32,System.Boolean)">
|
||
<summary>
|
||
<para>Clears the given undo history. You can clear history for a specific scene, global history, or for all scenes at once if <paramref name="id"/> is <see cref="F:Godot.EditorUndoRedoManager.SpecialHistory.InvalidHistory"/>.</para>
|
||
<para>If <paramref name="increaseVersion"/> is <see langword="true"/>, the undo history version will be increased, marking it as unsaved. Useful for operations that modify the scene, but don't support undo.</para>
|
||
<para><code>
|
||
var scene_root = EditorInterface.get_edited_scene_root()
|
||
var undo_redo = EditorInterface.get_editor_undo_redo()
|
||
undo_redo.clear_history(undo_redo.get_object_history_id(scene_root))
|
||
</code></para>
|
||
<para><b>Note:</b> If you want to mark an edited scene as unsaved without clearing its history, use <see cref="M:Godot.EditorInterface.MarkSceneAsUnsaved"/> instead.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorUndoRedoManager.HistoryChanged">
|
||
<summary>
|
||
<para>Emitted when the list of actions in any history has changed, either when an action is committed or a history is cleared.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorUndoRedoManager.VersionChanged">
|
||
<summary>
|
||
<para>Emitted when the version of any history has changed as a result of undo or redo call.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorUndoRedoManager.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorUndoRedoManager.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorUndoRedoManager.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.MethodName.CreateAction">
|
||
<summary>
|
||
Cached name for the 'create_action' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.MethodName.CommitAction">
|
||
<summary>
|
||
Cached name for the 'commit_action' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.MethodName.IsCommittingAction">
|
||
<summary>
|
||
Cached name for the 'is_committing_action' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.MethodName.ForceFixedHistory">
|
||
<summary>
|
||
Cached name for the 'force_fixed_history' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.MethodName.AddDoMethod">
|
||
<summary>
|
||
Cached name for the 'add_do_method' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.MethodName.AddUndoMethod">
|
||
<summary>
|
||
Cached name for the 'add_undo_method' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.MethodName.AddDoProperty">
|
||
<summary>
|
||
Cached name for the 'add_do_property' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.MethodName.AddUndoProperty">
|
||
<summary>
|
||
Cached name for the 'add_undo_property' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.MethodName.AddDoReference">
|
||
<summary>
|
||
Cached name for the 'add_do_reference' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.MethodName.AddUndoReference">
|
||
<summary>
|
||
Cached name for the 'add_undo_reference' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.MethodName.GetObjectHistoryId">
|
||
<summary>
|
||
Cached name for the 'get_object_history_id' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.MethodName.GetHistoryUndoRedo">
|
||
<summary>
|
||
Cached name for the 'get_history_undo_redo' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.MethodName.ClearHistory">
|
||
<summary>
|
||
Cached name for the 'clear_history' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorUndoRedoManager.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.SignalName.HistoryChanged">
|
||
<summary>
|
||
Cached name for the 'history_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorUndoRedoManager.SignalName.VersionChanged">
|
||
<summary>
|
||
Cached name for the 'version_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorCommandPalette">
|
||
<summary>
|
||
<para>Object that holds all the available Commands and their shortcuts text. These Commands can be accessed through <b>Editor > Command Palette</b> menu.</para>
|
||
<para>Command key names use slash delimiters to distinguish sections, for example: <c>"example/command1"</c> then <c>example</c> will be the section name.</para>
|
||
<para><code>
|
||
EditorCommandPalette commandPalette = EditorInterface.Singleton.GetCommandPalette();
|
||
// ExternalCommand is a function that will be called with the command is executed.
|
||
Callable commandCallable = new Callable(this, MethodName.ExternalCommand);
|
||
commandPalette.AddCommand("command", "test/command", commandCallable)
|
||
</code></para>
|
||
<para><b>Note:</b> This class shouldn't be instantiated directly. Instead, access the singleton using <see cref="M:Godot.EditorInterface.GetCommandPalette"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorCommandPalette.AddCommand(System.String,System.String,Godot.Callable,System.String)">
|
||
<summary>
|
||
<para>Adds a custom command to EditorCommandPalette.</para>
|
||
<para>- <paramref name="commandName"/>: <see cref="T:System.String"/> (Name of the <b>Command</b>. This is displayed to the user.)</para>
|
||
<para>- <paramref name="keyName"/>: <see cref="T:System.String"/> (Name of the key for a particular <b>Command</b>. This is used to uniquely identify the <b>Command</b>.)</para>
|
||
<para>- <paramref name="bindedCallable"/>: <see cref="T:Godot.Callable"/> (Callable of the <b>Command</b>. This will be executed when the <b>Command</b> is selected.)</para>
|
||
<para>- <paramref name="shortcutText"/>: <see cref="T:System.String"/> (Shortcut text of the <b>Command</b> if available.)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorCommandPalette.RemoveCommand(System.String)">
|
||
<summary>
|
||
<para>Removes the custom command from EditorCommandPalette.</para>
|
||
<para>- <paramref name="keyName"/>: <see cref="T:System.String"/> (Name of the key for a particular <b>Command</b>.)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorCommandPalette.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorCommandPalette.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorCommandPalette.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorCommandPalette.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorCommandPalette.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorCommandPalette.MethodName.AddCommand">
|
||
<summary>
|
||
Cached name for the 'add_command' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorCommandPalette.MethodName.RemoveCommand">
|
||
<summary>
|
||
Cached name for the 'remove_command' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorCommandPalette.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorContextMenuPlugin">
|
||
<summary>
|
||
<para><see cref="T:Godot.EditorContextMenuPlugin"/> allows for the addition of custom options in the editor's context menu.</para>
|
||
<para>Currently, context menus are supported for three commonly used areas: the file system, scene tree, and editor script list panel.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorContextMenuPlugin.ContextMenuSlot.SceneTree">
|
||
<summary>
|
||
<para>Context menu of Scene dock. <see cref="M:Godot.EditorContextMenuPlugin._PopupMenu(System.String[])"/> will be called with a list of paths to currently selected nodes, while option callback will receive the list of currently selected nodes.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorContextMenuPlugin.ContextMenuSlot.Filesystem">
|
||
<summary>
|
||
<para>Context menu of FileSystem dock. <see cref="M:Godot.EditorContextMenuPlugin._PopupMenu(System.String[])"/> and option callback will be called with list of paths of the currently selected files.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorContextMenuPlugin.ContextMenuSlot.FilesystemCreate">
|
||
<summary>
|
||
<para>The "Create..." submenu of FileSystem dock's context menu. <see cref="M:Godot.EditorContextMenuPlugin._PopupMenu(System.String[])"/> and option callback will be called with list of paths of the currently selected files.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorContextMenuPlugin.ContextMenuSlot.ScriptEditor">
|
||
<summary>
|
||
<para>Context menu of Scene dock. <see cref="M:Godot.EditorContextMenuPlugin._PopupMenu(System.String[])"/> will be called with the path to the currently edited script, while option callback will receive reference to that script.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorContextMenuPlugin._PopupMenu(System.String[])">
|
||
<summary>
|
||
<para>Called when creating a context menu, custom options can be added by using the <see cref="M:Godot.EditorContextMenuPlugin.AddContextMenuItem(System.String,Godot.Callable,Godot.Texture2D)"/> or <see cref="M:Godot.EditorContextMenuPlugin.AddContextMenuItemFromShortcut(System.String,Godot.Shortcut,Godot.Texture2D)"/> functions. <paramref name="paths"/> contains currently selected paths (depending on menu), which can be used to conditionally add options.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorContextMenuPlugin.AddMenuShortcut(Godot.Shortcut,Godot.Callable)">
|
||
<summary>
|
||
<para>Registers a shortcut associated with the plugin's context menu. This method should be called once (e.g. in plugin's <see cref="M:Godot.GodotObject.#ctor"/>). <paramref name="callback"/> will be called when user presses the specified <paramref name="shortcut"/> while the menu's context is in effect (e.g. FileSystem dock is focused). Callback should take single <see cref="T:Godot.Collections.Array"/> argument; array contents depend on context menu slot.</para>
|
||
<para><code>
|
||
func _init():
|
||
add_menu_shortcut(SHORTCUT, handle)
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorContextMenuPlugin.AddContextMenuItem(System.String,Godot.Callable,Godot.Texture2D)">
|
||
<summary>
|
||
<para>Add custom option to the context menu of the plugin's specified slot. When the option is activated, <paramref name="callback"/> will be called. Callback should take single <see cref="T:Godot.Collections.Array"/> argument; array contents depend on context menu slot.</para>
|
||
<para><code>
|
||
func _popup_menu(paths):
|
||
add_context_menu_item("File Custom options", handle, ICON)
|
||
</code></para>
|
||
<para>If you want to assign shortcut to the menu item, use <see cref="M:Godot.EditorContextMenuPlugin.AddContextMenuItemFromShortcut(System.String,Godot.Shortcut,Godot.Texture2D)"/> instead.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorContextMenuPlugin.AddContextMenuItemFromShortcut(System.String,Godot.Shortcut,Godot.Texture2D)">
|
||
<summary>
|
||
<para>Add custom option to the context menu of the plugin's specified slot. The option will have the <paramref name="shortcut"/> assigned and reuse its callback. The shortcut has to be registered beforehand with <see cref="M:Godot.EditorContextMenuPlugin.AddMenuShortcut(Godot.Shortcut,Godot.Callable)"/>.</para>
|
||
<para><code>
|
||
func _init():
|
||
add_menu_shortcut(SHORTCUT, handle)
|
||
|
||
func _popup_menu(paths):
|
||
add_context_menu_item_from_shortcut("File Custom options", SHORTCUT, ICON)
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorContextMenuPlugin.AddContextSubmenuItem(System.String,Godot.PopupMenu,Godot.Texture2D)">
|
||
<summary>
|
||
<para>Add a submenu to the context menu of the plugin's specified slot. The submenu is not automatically handled, you need to connect to its signals yourself. Also the submenu is freed on every popup, so provide a new <see cref="T:Godot.PopupMenu"/> every time.</para>
|
||
<para><code>
|
||
func _popup_menu(paths):
|
||
var popup_menu = PopupMenu.new()
|
||
popup_menu.add_item("Blue")
|
||
popup_menu.add_item("White")
|
||
popup_menu.id_pressed.connect(_on_color_submenu_option)
|
||
|
||
add_context_menu_item("Set Node Color", popup_menu)
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorContextMenuPlugin.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorContextMenuPlugin.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorContextMenuPlugin.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorContextMenuPlugin.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorContextMenuPlugin.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorContextMenuPlugin.MethodName._PopupMenu">
|
||
<summary>
|
||
Cached name for the '_popup_menu' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorContextMenuPlugin.MethodName.AddMenuShortcut">
|
||
<summary>
|
||
Cached name for the 'add_menu_shortcut' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorContextMenuPlugin.MethodName.AddContextMenuItem">
|
||
<summary>
|
||
Cached name for the 'add_context_menu_item' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorContextMenuPlugin.MethodName.AddContextMenuItemFromShortcut">
|
||
<summary>
|
||
Cached name for the 'add_context_menu_item_from_shortcut' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorContextMenuPlugin.MethodName.AddContextSubmenuItem">
|
||
<summary>
|
||
Cached name for the 'add_context_submenu_item' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorContextMenuPlugin.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorDebuggerPlugin">
|
||
<summary>
|
||
<para><see cref="T:Godot.EditorDebuggerPlugin"/> provides functions related to the editor side of the debugger.</para>
|
||
<para>To interact with the debugger, an instance of this class must be added to the editor via <see cref="M:Godot.EditorPlugin.AddDebuggerPlugin(Godot.EditorDebuggerPlugin)"/>.</para>
|
||
<para>Once added, the <see cref="M:Godot.EditorDebuggerPlugin._SetupSession(System.Int32)"/> callback will be called for every <see cref="T:Godot.EditorDebuggerSession"/> available to the plugin, and when new ones are created (the sessions may be inactive during this stage).</para>
|
||
<para>You can retrieve the available <see cref="T:Godot.EditorDebuggerSession"/>s via <see cref="M:Godot.EditorDebuggerPlugin.GetSessions"/> or get a specific one via <see cref="M:Godot.EditorDebuggerPlugin.GetSession(System.Int32)"/>.</para>
|
||
<para></para>
|
||
<para>To connect on the running game side, use the <see cref="T:Godot.EngineDebugger"/> singleton:</para>
|
||
<para></para>
|
||
<para><b>Note:</b> While the game is running, <c>@GlobalScope.print</c> and similar functions <i>called in the editor</i> do not print anything, the Output Log prints only game messages.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerPlugin._BreakpointSetInTree(Godot.Script,System.Int32,System.Boolean)">
|
||
<summary>
|
||
<para>Override this method to be notified when a breakpoint is set in the editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerPlugin._BreakpointsClearedInTree">
|
||
<summary>
|
||
<para>Override this method to be notified when all breakpoints are cleared in the editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerPlugin._Capture(System.String,Godot.Collections.Array,System.Int32)">
|
||
<summary>
|
||
<para>Override this method to process incoming messages. The <paramref name="sessionId"/> is the ID of the <see cref="T:Godot.EditorDebuggerSession"/> that received the <paramref name="message"/>. Use <see cref="M:Godot.EditorDebuggerPlugin.GetSession(System.Int32)"/> to retrieve the session. This method should return <see langword="true"/> if the message is recognized.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerPlugin._GotoScriptLine(Godot.Script,System.Int32)">
|
||
<summary>
|
||
<para>Override this method to be notified when a breakpoint line has been clicked in the debugger breakpoint panel.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerPlugin._HasCapture(System.String)">
|
||
<summary>
|
||
<para>Override this method to enable receiving messages from the debugger. If <paramref name="capture"/> is "my_message" then messages starting with "my_message:" will be passes to the <see cref="M:Godot.EditorDebuggerPlugin._Capture(System.String,Godot.Collections.Array,System.Int32)"/> method.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerPlugin._SetupSession(System.Int32)">
|
||
<summary>
|
||
<para>Override this method to be notified whenever a new <see cref="T:Godot.EditorDebuggerSession"/> is created. Note that the session may be inactive during this stage.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerPlugin.GetSession(System.Int32)">
|
||
<summary>
|
||
<para>Returns the <see cref="T:Godot.EditorDebuggerSession"/> with the given <paramref name="id"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerPlugin.GetSessions">
|
||
<summary>
|
||
<para>Returns an array of <see cref="T:Godot.EditorDebuggerSession"/> currently available to this debugger plugin.</para>
|
||
<para><b>Note:</b> Sessions in the array may be inactive, check their state via <see cref="M:Godot.EditorDebuggerSession.IsActive"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerPlugin.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerPlugin.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerPlugin.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorDebuggerPlugin.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorDebuggerPlugin.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerPlugin.MethodName._BreakpointSetInTree">
|
||
<summary>
|
||
Cached name for the '_breakpoint_set_in_tree' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerPlugin.MethodName._BreakpointsClearedInTree">
|
||
<summary>
|
||
Cached name for the '_breakpoints_cleared_in_tree' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerPlugin.MethodName._Capture">
|
||
<summary>
|
||
Cached name for the '_capture' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerPlugin.MethodName._GotoScriptLine">
|
||
<summary>
|
||
Cached name for the '_goto_script_line' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerPlugin.MethodName._HasCapture">
|
||
<summary>
|
||
Cached name for the '_has_capture' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerPlugin.MethodName._SetupSession">
|
||
<summary>
|
||
Cached name for the '_setup_session' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerPlugin.MethodName.GetSession">
|
||
<summary>
|
||
Cached name for the 'get_session' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerPlugin.MethodName.GetSessions">
|
||
<summary>
|
||
Cached name for the 'get_sessions' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorDebuggerPlugin.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorDebuggerSession">
|
||
<summary>
|
||
<para>This class cannot be directly instantiated and must be retrieved via a <see cref="T:Godot.EditorDebuggerPlugin"/>.</para>
|
||
<para>You can add tabs to the session UI via <see cref="M:Godot.EditorDebuggerSession.AddSessionTab(Godot.Control)"/>, send messages via <see cref="M:Godot.EditorDebuggerSession.SendMessage(System.String,Godot.Collections.Array)"/>, and toggle <see cref="T:Godot.EngineProfiler"/>s via <see cref="M:Godot.EditorDebuggerSession.ToggleProfiler(System.String,System.Boolean,Godot.Collections.Array)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerSession.SendMessage(System.String,Godot.Collections.Array)">
|
||
<summary>
|
||
<para>Sends the given <paramref name="message"/> to the attached remote instance, optionally passing additionally <paramref name="data"/>. See <see cref="T:Godot.EngineDebugger"/> for how to retrieve those messages.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerSession.ToggleProfiler(System.String,System.Boolean,Godot.Collections.Array)">
|
||
<summary>
|
||
<para>Toggle the given <paramref name="profiler"/> on the attached remote instance, optionally passing additionally <paramref name="data"/>. See <see cref="T:Godot.EngineProfiler"/> for more details.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerSession.IsBreaked">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if the attached remote instance is currently in the debug loop.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerSession.IsDebuggable">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if the attached remote instance can be debugged.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerSession.IsActive">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if the debug session is currently attached to a remote instance.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerSession.AddSessionTab(Godot.Control)">
|
||
<summary>
|
||
<para>Adds the given <paramref name="control"/> to the debug session UI in the debugger bottom panel. The <paramref name="control"/>'s node name will be used as the tab title.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerSession.RemoveSessionTab(Godot.Control)">
|
||
<summary>
|
||
<para>Removes the given <paramref name="control"/> from the debug session UI in the debugger bottom panel.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerSession.SetBreakpoint(System.String,System.Int32,System.Boolean)">
|
||
<summary>
|
||
<para>Enables or disables a specific breakpoint based on <paramref name="enabled"/>, updating the Editor Breakpoint Panel accordingly.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorDebuggerSession.Started">
|
||
<summary>
|
||
<para>Emitted when a remote instance is attached to this session (i.e. the session becomes active).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorDebuggerSession.Stopped">
|
||
<summary>
|
||
<para>Emitted when a remote instance is detached from this session (i.e. the session becomes inactive).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorDebuggerSession.BreakedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorDebuggerSession.Breaked"/> event of a <see cref="T:Godot.EditorDebuggerSession"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorDebuggerSession.Breaked">
|
||
<summary>
|
||
<para>Emitted when the attached remote instance enters a break state. If <c>canDebug</c> is <see langword="true"/>, the remote instance will enter the debug loop.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorDebuggerSession.Continued">
|
||
<summary>
|
||
<para>Emitted when the attached remote instance exits a break state.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerSession.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerSession.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorDebuggerSession.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorDebuggerSession.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorDebuggerSession.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerSession.MethodName.SendMessage">
|
||
<summary>
|
||
Cached name for the 'send_message' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerSession.MethodName.ToggleProfiler">
|
||
<summary>
|
||
Cached name for the 'toggle_profiler' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerSession.MethodName.IsBreaked">
|
||
<summary>
|
||
Cached name for the 'is_breaked' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerSession.MethodName.IsDebuggable">
|
||
<summary>
|
||
Cached name for the 'is_debuggable' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerSession.MethodName.IsActive">
|
||
<summary>
|
||
Cached name for the 'is_active' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerSession.MethodName.AddSessionTab">
|
||
<summary>
|
||
Cached name for the 'add_session_tab' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerSession.MethodName.RemoveSessionTab">
|
||
<summary>
|
||
Cached name for the 'remove_session_tab' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerSession.MethodName.SetBreakpoint">
|
||
<summary>
|
||
Cached name for the 'set_breakpoint' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorDebuggerSession.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerSession.SignalName.Started">
|
||
<summary>
|
||
Cached name for the 'started' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerSession.SignalName.Stopped">
|
||
<summary>
|
||
Cached name for the 'stopped' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerSession.SignalName.Breaked">
|
||
<summary>
|
||
Cached name for the 'breaked' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorDebuggerSession.SignalName.Continued">
|
||
<summary>
|
||
Cached name for the 'continued' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatform">
|
||
<summary>
|
||
<para>Base resource that provides the functionality of exporting a release build of a project to a platform, from the editor. Stores platform-specific metadata such as the name and supported features of the platform, and performs the exporting of projects, PCK files, and ZIP files. Uses an export template for the platform provided at the time of project exporting.</para>
|
||
<para>Used in scripting by <see cref="T:Godot.EditorExportPlugin"/> to configure platform-specific customization of scenes and resources. See <see cref="M:Godot.EditorExportPlugin._BeginCustomizeScenes(Godot.EditorExportPlatform,System.String[])"/> and <see cref="M:Godot.EditorExportPlugin._BeginCustomizeResources(Godot.EditorExportPlatform,System.String[])"/> for more details.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.ExportMessageType.None">
|
||
<summary>
|
||
<para>Invalid message type used as the default value when no type is specified.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.ExportMessageType.Info">
|
||
<summary>
|
||
<para>Message type for informational messages that have no effect on the export.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.ExportMessageType.Warning">
|
||
<summary>
|
||
<para>Message type for warning messages that should be addressed but still allow to complete the export.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.ExportMessageType.Error">
|
||
<summary>
|
||
<para>Message type for error messages that must be addressed and fail the export.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.DebugFlags.DumbClient">
|
||
<summary>
|
||
<para>Flag is set if remotely debugged project is expected to use remote file system. If set, <see cref="M:Godot.EditorExportPlatform.GenExportFlags(Godot.EditorExportPlatform.DebugFlags)"/> will add <c>--remove-fs</c> and <c>--remote-fs-password</c> (if password is set in the editor settings) command line arguments to the list.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.DebugFlags.RemoteDebug">
|
||
<summary>
|
||
<para>Flag is set if remote debug is enabled. If set, <see cref="M:Godot.EditorExportPlatform.GenExportFlags(Godot.EditorExportPlatform.DebugFlags)"/> will add <c>--remote-debug</c> and <c>--breakpoints</c> (if breakpoints are selected in the script editor or added by the plugin) command line arguments to the list.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.DebugFlags.RemoteDebugLocalhost">
|
||
<summary>
|
||
<para>Flag is set if remotely debugged project is running on the localhost. If set, <see cref="M:Godot.EditorExportPlatform.GenExportFlags(Godot.EditorExportPlatform.DebugFlags)"/> will use <c>localhost</c> instead of <c>EditorSettings.network/debug/remote_host</c> as remote debugger host.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.DebugFlags.ViewCollisions">
|
||
<summary>
|
||
<para>Flag is set if "Visible Collision Shapes" remote debug option is enabled. If set, <see cref="M:Godot.EditorExportPlatform.GenExportFlags(Godot.EditorExportPlatform.DebugFlags)"/> will add <c>--debug-collisions</c> command line arguments to the list.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.DebugFlags.ViewNavigation">
|
||
<summary>
|
||
<para>Flag is set if Visible Navigation" remote debug option is enabled. If set, <see cref="M:Godot.EditorExportPlatform.GenExportFlags(Godot.EditorExportPlatform.DebugFlags)"/> will add <c>--debug-navigation</c> command line arguments to the list.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.GetOsName">
|
||
<summary>
|
||
<para>Returns the name of the export operating system handled by this <see cref="T:Godot.EditorExportPlatform"/> class, as a friendly string. Possible return values are <c>Windows</c>, <c>Linux</c>, <c>macOS</c>, <c>Android</c>, <c>iOS</c>, and <c>Web</c>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.CreatePreset">
|
||
<summary>
|
||
<para>Create a new preset for this platform.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.FindExportTemplate(System.String)">
|
||
<summary>
|
||
<para>Locates export template for the platform, and returns <see cref="T:Godot.Collections.Dictionary"/> with the following keys: <c>path: String</c> and <c>error: String</c>. This method is provided for convenience and custom export platforms aren't required to use it or keep export templates stored in the same way official templates are.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.GetCurrentPresets">
|
||
<summary>
|
||
<para>Returns array of <see cref="T:Godot.EditorExportPreset"/>s for this platform.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.SavePack(Godot.EditorExportPreset,System.Boolean,System.String,System.Boolean)">
|
||
<summary>
|
||
<para>Saves PCK archive and returns <see cref="T:Godot.Collections.Dictionary"/> with the following keys: <c>result: Error</c>, <c>so_files: Array</c> (array of the shared/static objects which contains dictionaries with the following keys: <c>path: String</c>, <c>tags: PackedStringArray</c>, and <c>target_folder: String</c>).</para>
|
||
<para>If <paramref name="embed"/> is <see langword="true"/>, PCK content is appended to the end of <paramref name="path"/> file and return <see cref="T:Godot.Collections.Dictionary"/> additionally include following keys: <c>embedded_start: int</c> (embedded PCK offset) and <c>embedded_size: int</c> (embedded PCK size).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.SaveZip(Godot.EditorExportPreset,System.Boolean,System.String)">
|
||
<summary>
|
||
<para>Saves ZIP archive and returns <see cref="T:Godot.Collections.Dictionary"/> with the following keys: <c>result: Error</c>, <c>so_files: Array</c> (array of the shared/static objects which contains dictionaries with the following keys: <c>path: String</c>, <c>tags: PackedStringArray</c>, and <c>target_folder: String</c>).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.SavePackPatch(Godot.EditorExportPreset,System.Boolean,System.String)">
|
||
<summary>
|
||
<para>Saves patch PCK archive and returns <see cref="T:Godot.Collections.Dictionary"/> with the following keys: <c>result: Error</c>, <c>so_files: Array</c> (array of the shared/static objects which contains dictionaries with the following keys: <c>path: String</c>, <c>tags: PackedStringArray</c>, and <c>target_folder: String</c>).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.SaveZipPatch(Godot.EditorExportPreset,System.Boolean,System.String)">
|
||
<summary>
|
||
<para>Saves patch ZIP archive and returns <see cref="T:Godot.Collections.Dictionary"/> with the following keys: <c>result: Error</c>, <c>so_files: Array</c> (array of the shared/static objects which contains dictionaries with the following keys: <c>path: String</c>, <c>tags: PackedStringArray</c>, and <c>target_folder: String</c>).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.GenExportFlags(Godot.EditorExportPlatform.DebugFlags)">
|
||
<summary>
|
||
<para>Generates array of command line arguments for the default export templates for the debug flags and editor settings.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.ExportProjectFiles(Godot.EditorExportPreset,System.Boolean,Godot.Callable,Godot.Callable)">
|
||
<summary>
|
||
<para>Exports project files for the specified preset. This method can be used to implement custom export format, other than PCK and ZIP. One of the callbacks is called for each exported file.</para>
|
||
<para><paramref name="saveCb"/> is called for all exported files and have the following arguments: <c>file_path: String</c>, <c>file_data: PackedByteArray</c>, <c>file_index: int</c>, <c>file_count: int</c>, <c>encryption_include_filters: PackedStringArray</c>, <c>encryption_exclude_filters: PackedStringArray</c>, <c>encryption_key: PackedByteArray</c>.</para>
|
||
<para><paramref name="sharedCb"/> is called for exported native shared/static libraries and have the following arguments: <c>file_path: String</c>, <c>tags: PackedStringArray</c>, <c>target_folder: String</c>.</para>
|
||
<para><b>Note:</b> <c>file_index</c> and <c>file_count</c> are intended for progress tracking only and aren't necesserely unique and precise.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.ExportProject(Godot.EditorExportPreset,System.Boolean,System.String,Godot.EditorExportPlatform.DebugFlags)">
|
||
<summary>
|
||
<para>Creates a full project at <paramref name="path"/> for the specified <paramref name="preset"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.ExportPack(Godot.EditorExportPreset,System.Boolean,System.String,Godot.EditorExportPlatform.DebugFlags)">
|
||
<summary>
|
||
<para>Creates a PCK archive at <paramref name="path"/> for the specified <paramref name="preset"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.ExportZip(Godot.EditorExportPreset,System.Boolean,System.String,Godot.EditorExportPlatform.DebugFlags)">
|
||
<summary>
|
||
<para>Create a ZIP archive at <paramref name="path"/> for the specified <paramref name="preset"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.ExportPackPatch(Godot.EditorExportPreset,System.Boolean,System.String,System.String[],Godot.EditorExportPlatform.DebugFlags)">
|
||
<summary>
|
||
<para>Creates a patch PCK archive at <paramref name="path"/> for the specified <paramref name="preset"/>, containing only the files that have changed since the last patch.</para>
|
||
<para><b>Note:</b> <paramref name="patches"/> is an optional override of the set of patches defined in the export preset. When empty the patches defined in the export preset will be used instead.</para>
|
||
</summary>
|
||
<param name="patches">If the parameter is null, then the default value is <c>Array.Empty<string>()</c>.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.ExportPackPatch(Godot.EditorExportPreset,System.Boolean,System.String,System.ReadOnlySpan{System.String},Godot.EditorExportPlatform.DebugFlags)">
|
||
<summary>
|
||
<para>Creates a patch PCK archive at <paramref name="path"/> for the specified <paramref name="preset"/>, containing only the files that have changed since the last patch.</para>
|
||
<para><b>Note:</b> <paramref name="patches"/> is an optional override of the set of patches defined in the export preset. When empty the patches defined in the export preset will be used instead.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.ExportZipPatch(Godot.EditorExportPreset,System.Boolean,System.String,System.String[],Godot.EditorExportPlatform.DebugFlags)">
|
||
<summary>
|
||
<para>Create a patch ZIP archive at <paramref name="path"/> for the specified <paramref name="preset"/>, containing only the files that have changed since the last patch.</para>
|
||
<para><b>Note:</b> <paramref name="patches"/> is an optional override of the set of patches defined in the export preset. When empty the patches defined in the export preset will be used instead.</para>
|
||
</summary>
|
||
<param name="patches">If the parameter is null, then the default value is <c>Array.Empty<string>()</c>.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.ExportZipPatch(Godot.EditorExportPreset,System.Boolean,System.String,System.ReadOnlySpan{System.String},Godot.EditorExportPlatform.DebugFlags)">
|
||
<summary>
|
||
<para>Create a patch ZIP archive at <paramref name="path"/> for the specified <paramref name="preset"/>, containing only the files that have changed since the last patch.</para>
|
||
<para><b>Note:</b> <paramref name="patches"/> is an optional override of the set of patches defined in the export preset. When empty the patches defined in the export preset will be used instead.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.ClearMessages">
|
||
<summary>
|
||
<para>Clears the export log.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.AddMessage(Godot.EditorExportPlatform.ExportMessageType,System.String,System.String)">
|
||
<summary>
|
||
<para>Adds a message to the export log that will be displayed when exporting ends.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.GetMessageCount">
|
||
<summary>
|
||
<para>Returns number of messages in the export log.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.GetMessageType(System.Int32)">
|
||
<summary>
|
||
<para>Returns message type, for the message with <paramref name="index"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.GetMessageCategory(System.Int32)">
|
||
<summary>
|
||
<para>Returns message category, for the message with <paramref name="index"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.GetMessageText(System.Int32)">
|
||
<summary>
|
||
<para>Returns message text, for the message with <paramref name="index"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.GetWorstMessageType">
|
||
<summary>
|
||
<para>Returns most severe message type currently present in the export log.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.SshRunOnRemote(System.String,System.String,System.String[],System.String,Godot.Collections.Array,System.Int32)">
|
||
<summary>
|
||
<para>Executes specified command on the remote host via SSH protocol and returns command output in the <paramref name="output"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.SshRunOnRemote(System.String,System.String,System.ReadOnlySpan{System.String},System.String,Godot.Collections.Array,System.Int32)">
|
||
<summary>
|
||
<para>Executes specified command on the remote host via SSH protocol and returns command output in the <paramref name="output"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.SshRunOnRemoteNoWait(System.String,System.String,System.String[],System.String,System.Int32)">
|
||
<summary>
|
||
<para>Executes specified command on the remote host via SSH protocol and returns process ID (on the remote host) without waiting for command to finish.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.SshRunOnRemoteNoWait(System.String,System.String,System.ReadOnlySpan{System.String},System.String,System.Int32)">
|
||
<summary>
|
||
<para>Executes specified command on the remote host via SSH protocol and returns process ID (on the remote host) without waiting for command to finish.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.SshPushToRemote(System.String,System.String,System.String[],System.String,System.String)">
|
||
<summary>
|
||
<para>Uploads specified file over SCP protocol to the remote host.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.SshPushToRemote(System.String,System.String,System.ReadOnlySpan{System.String},System.String,System.String)">
|
||
<summary>
|
||
<para>Uploads specified file over SCP protocol to the remote host.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.GetForcedExportFiles">
|
||
<summary>
|
||
<para>Returns array of core file names that always should be exported regardless of preset config.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.GetInternalExportFiles">
|
||
<summary>
|
||
<para>Returns additional files that should always be exported regardless of preset configuration, and are not part of the project source. The returned <see cref="T:Godot.Collections.Dictionary"/> contains filename keys (<see cref="T:System.String"/>) and their corresponding raw data (<see cref="T:System.Byte"/>[]).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatform.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatform.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatform.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.GetOsName">
|
||
<summary>
|
||
Cached name for the 'get_os_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.CreatePreset">
|
||
<summary>
|
||
Cached name for the 'create_preset' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.FindExportTemplate">
|
||
<summary>
|
||
Cached name for the 'find_export_template' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.GetCurrentPresets">
|
||
<summary>
|
||
Cached name for the 'get_current_presets' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.SavePack">
|
||
<summary>
|
||
Cached name for the 'save_pack' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.SaveZip">
|
||
<summary>
|
||
Cached name for the 'save_zip' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.SavePackPatch">
|
||
<summary>
|
||
Cached name for the 'save_pack_patch' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.SaveZipPatch">
|
||
<summary>
|
||
Cached name for the 'save_zip_patch' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.GenExportFlags">
|
||
<summary>
|
||
Cached name for the 'gen_export_flags' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.ExportProjectFiles">
|
||
<summary>
|
||
Cached name for the 'export_project_files' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.ExportProject">
|
||
<summary>
|
||
Cached name for the 'export_project' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.ExportPack">
|
||
<summary>
|
||
Cached name for the 'export_pack' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.ExportZip">
|
||
<summary>
|
||
Cached name for the 'export_zip' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.ExportPackPatch">
|
||
<summary>
|
||
Cached name for the 'export_pack_patch' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.ExportZipPatch">
|
||
<summary>
|
||
Cached name for the 'export_zip_patch' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.ClearMessages">
|
||
<summary>
|
||
Cached name for the 'clear_messages' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.AddMessage">
|
||
<summary>
|
||
Cached name for the 'add_message' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.GetMessageCount">
|
||
<summary>
|
||
Cached name for the 'get_message_count' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.GetMessageType">
|
||
<summary>
|
||
Cached name for the 'get_message_type' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.GetMessageCategory">
|
||
<summary>
|
||
Cached name for the 'get_message_category' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.GetMessageText">
|
||
<summary>
|
||
Cached name for the 'get_message_text' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.GetWorstMessageType">
|
||
<summary>
|
||
Cached name for the 'get_worst_message_type' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.SshRunOnRemote">
|
||
<summary>
|
||
Cached name for the 'ssh_run_on_remote' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.SshRunOnRemoteNoWait">
|
||
<summary>
|
||
Cached name for the 'ssh_run_on_remote_no_wait' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.SshPushToRemote">
|
||
<summary>
|
||
Cached name for the 'ssh_push_to_remote' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.GetForcedExportFiles">
|
||
<summary>
|
||
Cached name for the 'get_forced_export_files' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatform.MethodName.GetInternalExportFiles">
|
||
<summary>
|
||
Cached name for the 'get_internal_export_files' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatform.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformAndroid.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformAndroid.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformAndroid.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformAndroid.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformAndroid.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformAndroid.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformExtension">
|
||
<summary>
|
||
<para>External <see cref="T:Godot.EditorExportPlatform"/> implementations should inherit from this class.</para>
|
||
<para>To use <see cref="T:Godot.EditorExportPlatform"/>, register it using the <see cref="M:Godot.EditorPlugin.AddExportPlatform(Godot.EditorExportPlatform)"/> method first.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._CanExport(Godot.EditorExportPreset,System.Boolean)">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Returns <see langword="true"/>, if specified <paramref name="preset"/> is valid and can be exported. Use <see cref="M:Godot.EditorExportPlatformExtension.SetConfigError(System.String)"/> and <see cref="M:Godot.EditorExportPlatformExtension.SetConfigMissingTemplates(System.Boolean)"/> to set error details.</para>
|
||
<para>Usual implementation can call <see cref="M:Godot.EditorExportPlatformExtension._HasValidExportConfiguration(Godot.EditorExportPreset,System.Boolean)"/> and <see cref="M:Godot.EditorExportPlatformExtension._HasValidProjectConfiguration(Godot.EditorExportPreset)"/> to determine if export is possible.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._Cleanup">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Called by the editor before platform is unregistered.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._ExportPack(Godot.EditorExportPreset,System.Boolean,System.String,Godot.EditorExportPlatform.DebugFlags)">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Creates a PCK archive at <paramref name="path"/> for the specified <paramref name="preset"/>.</para>
|
||
<para>This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" disabled, and PCK is selected as a file type.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._ExportPackPatch(Godot.EditorExportPreset,System.Boolean,System.String,System.String[],Godot.EditorExportPlatform.DebugFlags)">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Creates a patch PCK archive at <paramref name="path"/> for the specified <paramref name="preset"/>, containing only the files that have changed since the last patch.</para>
|
||
<para>This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" enabled, and PCK is selected as a file type.</para>
|
||
<para><b>Note:</b> The patches provided in <paramref name="patches"/> have already been loaded when this method is called and are merely provided as context. When empty the patches defined in the export preset have been loaded instead.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._ExportProject(Godot.EditorExportPreset,System.Boolean,System.String,Godot.EditorExportPlatform.DebugFlags)">
|
||
<summary>
|
||
<para><b>Required.</b></para>
|
||
<para>Creates a full project at <paramref name="path"/> for the specified <paramref name="preset"/>.</para>
|
||
<para>This method is called when "Export" button is pressed in the export dialog.</para>
|
||
<para>This method implementation can call <see cref="M:Godot.EditorExportPlatform.SavePack(Godot.EditorExportPreset,System.Boolean,System.String,System.Boolean)"/> or <see cref="M:Godot.EditorExportPlatform.SaveZip(Godot.EditorExportPreset,System.Boolean,System.String)"/> to use default PCK/ZIP export process, or calls <see cref="M:Godot.EditorExportPlatform.ExportProjectFiles(Godot.EditorExportPreset,System.Boolean,Godot.Callable,Godot.Callable)"/> and implement custom callback for processing each exported file.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._ExportZip(Godot.EditorExportPreset,System.Boolean,System.String,Godot.EditorExportPlatform.DebugFlags)">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Create a ZIP archive at <paramref name="path"/> for the specified <paramref name="preset"/>.</para>
|
||
<para>This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" disabled, and ZIP is selected as a file type.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._ExportZipPatch(Godot.EditorExportPreset,System.Boolean,System.String,System.String[],Godot.EditorExportPlatform.DebugFlags)">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Create a ZIP archive at <paramref name="path"/> for the specified <paramref name="preset"/>, containing only the files that have changed since the last patch.</para>
|
||
<para>This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" enabled, and ZIP is selected as a file type.</para>
|
||
<para><b>Note:</b> The patches provided in <paramref name="patches"/> have already been loaded when this method is called and are merely provided as context. When empty the patches defined in the export preset have been loaded instead.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._GetBinaryExtensions(Godot.EditorExportPreset)">
|
||
<summary>
|
||
<para><b>Required.</b></para>
|
||
<para>Returns array of supported binary extensions for the full project export.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._GetDebugProtocol">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Returns protocol used for remote debugging. Default implementation return <c>tcp://</c>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._GetDeviceArchitecture(System.Int32)">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Returns device architecture for one-click deploy.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._GetExportOptionVisibility(Godot.EditorExportPreset,System.String)">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Validates <paramref name="option"/> and returns visibility for the specified <paramref name="preset"/>. Default implementation return <see langword="true"/> for all options.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._GetExportOptionWarning(Godot.EditorExportPreset,Godot.StringName)">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Validates <paramref name="option"/> and returns warning message for the specified <paramref name="preset"/>. Default implementation return empty string for all options.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._GetExportOptions">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Returns a property list, as an <see cref="T:Godot.Collections.Array"/> of dictionaries. Each <see cref="T:Godot.Collections.Dictionary"/> must at least contain the <c>name: StringName</c> and <c>type: Variant.Type</c> entries.</para>
|
||
<para>Additionally, the following keys are supported:</para>
|
||
<para>- <c>hint: PropertyHint</c></para>
|
||
<para>- <c>hint_string: String</c></para>
|
||
<para>- <c>usage: PropertyUsageFlags</c></para>
|
||
<para>- <c>class_name: StringName</c></para>
|
||
<para>- <c>default_value: Variant</c>, default value of the property.</para>
|
||
<para>- <c>update_visibility: bool</c>, if set to <see langword="true"/>, <see cref="M:Godot.EditorExportPlatformExtension._GetExportOptionVisibility(Godot.EditorExportPreset,System.String)"/> is called for each property when this property is changed.</para>
|
||
<para>- <c>required: bool</c>, if set to <see langword="true"/>, this property warnings are critical, and should be resolved to make export possible. This value is a hint for the <see cref="M:Godot.EditorExportPlatformExtension._HasValidExportConfiguration(Godot.EditorExportPreset,System.Boolean)"/> implementation, and not used by the engine directly.</para>
|
||
<para>See also <see cref="M:Godot.GodotObject._GetPropertyList"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._GetLogo">
|
||
<summary>
|
||
<para><b>Required.</b></para>
|
||
<para>Returns platform logo displayed in the export dialog, logo should be 32x32 adjusted to the current editor scale, see <see cref="M:Godot.EditorInterface.GetEditorScale"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._GetName">
|
||
<summary>
|
||
<para><b>Required.</b></para>
|
||
<para>Returns export platform name.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._GetOptionIcon(System.Int32)">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Returns one-click deploy menu item icon for the specified <paramref name="device"/>, icon should be 16x16 adjusted to the current editor scale, see <see cref="M:Godot.EditorInterface.GetEditorScale"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._GetOptionLabel(System.Int32)">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Returns one-click deploy menu item label for the specified <paramref name="device"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._GetOptionTooltip(System.Int32)">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Returns one-click deploy menu item tooltip for the specified <paramref name="device"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._GetOptionsCount">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Returns number one-click deploy devices (or other one-click option displayed in the menu).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._GetOptionsTooltip">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Returns tooltip of the one-click deploy menu button.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._GetOsName">
|
||
<summary>
|
||
<para><b>Required.</b></para>
|
||
<para>Returns target OS name.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._GetPlatformFeatures">
|
||
<summary>
|
||
<para><b>Required.</b></para>
|
||
<para>Returns array of platform specific features.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._GetPresetFeatures(Godot.EditorExportPreset)">
|
||
<summary>
|
||
<para><b>Required.</b></para>
|
||
<para>Returns array of platform specific features for the specified <paramref name="preset"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._GetRunIcon">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Returns icon of the one-click deploy menu button, icon should be 16x16 adjusted to the current editor scale, see <see cref="M:Godot.EditorInterface.GetEditorScale"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._HasValidExportConfiguration(Godot.EditorExportPreset,System.Boolean)">
|
||
<summary>
|
||
<para><b>Required.</b></para>
|
||
<para>Returns <see langword="true"/> if export configuration is valid.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._HasValidProjectConfiguration(Godot.EditorExportPreset)">
|
||
<summary>
|
||
<para><b>Required.</b></para>
|
||
<para>Returns <see langword="true"/> if project configuration is valid.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._IsExecutable(System.String)">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Returns <see langword="true"/> if specified file is a valid executable (native executable or script) for the target platform.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._PollExport">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Returns <see langword="true"/> if one-click deploy options are changed and editor interface should be updated.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._Run(Godot.EditorExportPreset,System.Int32,Godot.EditorExportPlatform.DebugFlags)">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>This method is called when <paramref name="device"/> one-click deploy menu option is selected.</para>
|
||
<para>Implementation should export project to a temporary location, upload and run it on the specific <paramref name="device"/>, or perform another action associated with the menu item.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension._ShouldUpdateExportOptions">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Returns <see langword="true"/> if export options list is changed and presets should be updated.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension.SetConfigError(System.String)">
|
||
<summary>
|
||
<para>Sets current configuration error message text. This method should be called only from the <see cref="M:Godot.EditorExportPlatformExtension._CanExport(Godot.EditorExportPreset,System.Boolean)"/>, <see cref="M:Godot.EditorExportPlatformExtension._HasValidExportConfiguration(Godot.EditorExportPreset,System.Boolean)"/>, or <see cref="M:Godot.EditorExportPlatformExtension._HasValidProjectConfiguration(Godot.EditorExportPreset)"/> implementations.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension.GetConfigError">
|
||
<summary>
|
||
<para>Returns current configuration error message text. This method should be called only from the <see cref="M:Godot.EditorExportPlatformExtension._CanExport(Godot.EditorExportPreset,System.Boolean)"/>, <see cref="M:Godot.EditorExportPlatformExtension._HasValidExportConfiguration(Godot.EditorExportPreset,System.Boolean)"/>, or <see cref="M:Godot.EditorExportPlatformExtension._HasValidProjectConfiguration(Godot.EditorExportPreset)"/> implementations.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension.SetConfigMissingTemplates(System.Boolean)">
|
||
<summary>
|
||
<para>Set to <see langword="true"/> is export templates are missing from the current configuration. This method should be called only from the <see cref="M:Godot.EditorExportPlatformExtension._CanExport(Godot.EditorExportPreset,System.Boolean)"/>, <see cref="M:Godot.EditorExportPlatformExtension._HasValidExportConfiguration(Godot.EditorExportPreset,System.Boolean)"/>, or <see cref="M:Godot.EditorExportPlatformExtension._HasValidProjectConfiguration(Godot.EditorExportPreset)"/> implementations.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension.GetConfigMissingTemplates">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> is export templates are missing from the current configuration. This method should be called only from the <see cref="M:Godot.EditorExportPlatformExtension._CanExport(Godot.EditorExportPreset,System.Boolean)"/>, <see cref="M:Godot.EditorExportPlatformExtension._HasValidExportConfiguration(Godot.EditorExportPreset,System.Boolean)"/>, or <see cref="M:Godot.EditorExportPlatformExtension._HasValidProjectConfiguration(Godot.EditorExportPreset)"/> implementations.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformExtension.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformExtension.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformExtension.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._CanExport">
|
||
<summary>
|
||
Cached name for the '_can_export' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._Cleanup">
|
||
<summary>
|
||
Cached name for the '_cleanup' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._ExportPack">
|
||
<summary>
|
||
Cached name for the '_export_pack' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._ExportPackPatch">
|
||
<summary>
|
||
Cached name for the '_export_pack_patch' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._ExportProject">
|
||
<summary>
|
||
Cached name for the '_export_project' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._ExportZip">
|
||
<summary>
|
||
Cached name for the '_export_zip' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._ExportZipPatch">
|
||
<summary>
|
||
Cached name for the '_export_zip_patch' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._GetBinaryExtensions">
|
||
<summary>
|
||
Cached name for the '_get_binary_extensions' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._GetDebugProtocol">
|
||
<summary>
|
||
Cached name for the '_get_debug_protocol' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._GetDeviceArchitecture">
|
||
<summary>
|
||
Cached name for the '_get_device_architecture' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._GetExportOptionVisibility">
|
||
<summary>
|
||
Cached name for the '_get_export_option_visibility' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._GetExportOptionWarning">
|
||
<summary>
|
||
Cached name for the '_get_export_option_warning' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._GetExportOptions">
|
||
<summary>
|
||
Cached name for the '_get_export_options' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._GetLogo">
|
||
<summary>
|
||
Cached name for the '_get_logo' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._GetName">
|
||
<summary>
|
||
Cached name for the '_get_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._GetOptionIcon">
|
||
<summary>
|
||
Cached name for the '_get_option_icon' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._GetOptionLabel">
|
||
<summary>
|
||
Cached name for the '_get_option_label' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._GetOptionTooltip">
|
||
<summary>
|
||
Cached name for the '_get_option_tooltip' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._GetOptionsCount">
|
||
<summary>
|
||
Cached name for the '_get_options_count' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._GetOptionsTooltip">
|
||
<summary>
|
||
Cached name for the '_get_options_tooltip' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._GetOsName">
|
||
<summary>
|
||
Cached name for the '_get_os_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._GetPlatformFeatures">
|
||
<summary>
|
||
Cached name for the '_get_platform_features' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._GetPresetFeatures">
|
||
<summary>
|
||
Cached name for the '_get_preset_features' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._GetRunIcon">
|
||
<summary>
|
||
Cached name for the '_get_run_icon' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._HasValidExportConfiguration">
|
||
<summary>
|
||
Cached name for the '_has_valid_export_configuration' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._HasValidProjectConfiguration">
|
||
<summary>
|
||
Cached name for the '_has_valid_project_configuration' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._IsExecutable">
|
||
<summary>
|
||
Cached name for the '_is_executable' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._PollExport">
|
||
<summary>
|
||
Cached name for the '_poll_export' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._Run">
|
||
<summary>
|
||
Cached name for the '_run' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName._ShouldUpdateExportOptions">
|
||
<summary>
|
||
Cached name for the '_should_update_export_options' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName.SetConfigError">
|
||
<summary>
|
||
Cached name for the 'set_config_error' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName.GetConfigError">
|
||
<summary>
|
||
Cached name for the 'get_config_error' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName.SetConfigMissingTemplates">
|
||
<summary>
|
||
Cached name for the 'set_config_missing_templates' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlatformExtension.MethodName.GetConfigMissingTemplates">
|
||
<summary>
|
||
Cached name for the 'get_config_missing_templates' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformExtension.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformIos.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformIos.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformIos.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformIos.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformIos.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformIos.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformLinuxBsd.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformLinuxBsd.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformLinuxBsd.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformLinuxBsd.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformLinuxBsd.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformLinuxBsd.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformMacOS.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformMacOS.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformMacOS.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformMacOS.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformMacOS.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformMacOS.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformPC">
|
||
<summary>
|
||
<para>The base class for the desktop platform exporters. These include Windows and Linux/BSD, but not macOS. See the classes inheriting this one for more details.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformPC.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformPC.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformPC.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformPC.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformPC.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformPC.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformWeb">
|
||
<summary>
|
||
<para>The Web exporter customizes how a web build is handled. In the editor's "Export" window, it is created when adding a new "Web" preset.</para>
|
||
<para><b>Note:</b> Godot on Web is rendered inside a <c><canvas></c> tag. Normally, the canvas cannot be positioned or resized manually, but otherwise acts as the main <see cref="T:Godot.Window"/> of the application.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformWeb.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformWeb.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformWeb.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformWeb.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformWeb.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformWeb.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformWindows">
|
||
<summary>
|
||
<para>The Windows exporter customizes how a Windows build is handled. In the editor's "Export" window, it is created when adding a new "Windows" preset.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformWindows.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformWindows.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlatformWindows.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformWindows.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformWindows.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlatformWindows.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlugin">
|
||
<summary>
|
||
<para><see cref="T:Godot.EditorExportPlugin"/>s are automatically invoked whenever the user exports the project. Their most common use is to determine what files are being included in the exported project. For each plugin, <see cref="M:Godot.EditorExportPlugin._ExportBegin(System.String[],System.Boolean,System.String,System.UInt32)"/> is called at the beginning of the export process and then <see cref="M:Godot.EditorExportPlugin._ExportFile(System.String,System.String,System.String[])"/> is called for each exported file.</para>
|
||
<para>To use <see cref="T:Godot.EditorExportPlugin"/>, register it using the <see cref="M:Godot.EditorPlugin.AddExportPlugin(Godot.EditorExportPlugin)"/> method first.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._BeginCustomizeResources(Godot.EditorExportPlatform,System.String[])">
|
||
<summary>
|
||
<para>Return <see langword="true"/> if this plugin will customize resources based on the platform and features used.</para>
|
||
<para>When enabled, <see cref="M:Godot.EditorExportPlugin._GetCustomizationConfigurationHash"/> and <see cref="M:Godot.EditorExportPlugin._CustomizeResource(Godot.Resource,System.String)"/> will be called and must be implemented.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._BeginCustomizeScenes(Godot.EditorExportPlatform,System.String[])">
|
||
<summary>
|
||
<para>Return <see langword="true"/> if this plugin will customize scenes based on the platform and features used.</para>
|
||
<para>When enabled, <see cref="M:Godot.EditorExportPlugin._GetCustomizationConfigurationHash"/> and <see cref="M:Godot.EditorExportPlugin._CustomizeScene(Godot.Node,System.String)"/> will be called and must be implemented.</para>
|
||
<para><b>Note:</b> <see cref="M:Godot.EditorExportPlugin._CustomizeScene(Godot.Node,System.String)"/> will only be called for scenes that have been modified since the last export.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._CustomizeResource(Godot.Resource,System.String)">
|
||
<summary>
|
||
<para>Customize a resource. If changes are made to it, return the same or a new resource. Otherwise, return <see langword="null"/>. When a new resource is returned, <paramref name="resource"/> will be replaced by a copy of the new resource.</para>
|
||
<para>The <paramref name="path"/> argument is only used when customizing an actual file, otherwise this means that this resource is part of another one and it will be empty.</para>
|
||
<para>Implementing this method is required if <see cref="M:Godot.EditorExportPlugin._BeginCustomizeResources(Godot.EditorExportPlatform,System.String[])"/> returns <see langword="true"/>.</para>
|
||
<para><b>Note:</b> When customizing any of the following types and returning another resource, the other resource should not be skipped using <see cref="M:Godot.EditorExportPlugin.Skip"/> in <see cref="M:Godot.EditorExportPlugin._ExportFile(System.String,System.String,System.String[])"/>:</para>
|
||
<para>- <see cref="T:Godot.AtlasTexture"/></para>
|
||
<para>- <see cref="T:Godot.CompressedCubemap"/></para>
|
||
<para>- <see cref="T:Godot.CompressedCubemapArray"/></para>
|
||
<para>- <see cref="T:Godot.CompressedTexture2D"/></para>
|
||
<para>- <see cref="T:Godot.CompressedTexture2DArray"/></para>
|
||
<para>- <see cref="T:Godot.CompressedTexture3D"/></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._CustomizeScene(Godot.Node,System.String)">
|
||
<summary>
|
||
<para>Customize a scene. If changes are made to it, return the same or a new scene. Otherwise, return <see langword="null"/>. If a new scene is returned, it is up to you to dispose of the old one.</para>
|
||
<para>Implementing this method is required if <see cref="M:Godot.EditorExportPlugin._BeginCustomizeScenes(Godot.EditorExportPlatform,System.String[])"/> returns <see langword="true"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._EndCustomizeResources">
|
||
<summary>
|
||
<para>This is called when the customization process for resources ends.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._EndCustomizeScenes">
|
||
<summary>
|
||
<para>This is called when the customization process for scenes ends.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._ExportBegin(System.String[],System.Boolean,System.String,System.UInt32)">
|
||
<summary>
|
||
<para>Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. <paramref name="features"/> is the list of features for the export, <paramref name="isDebug"/> is <see langword="true"/> for debug builds, <paramref name="path"/> is the target path for the exported project. <paramref name="flags"/> is only used when running a runnable profile, e.g. when using native run on Android.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._ExportEnd">
|
||
<summary>
|
||
<para>Virtual method to be overridden by the user. Called when the export is finished.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._ExportFile(System.String,System.String,System.String[])">
|
||
<summary>
|
||
<para>Virtual method to be overridden by the user. Called for each exported file before <see cref="M:Godot.EditorExportPlugin._CustomizeResource(Godot.Resource,System.String)"/> and <see cref="M:Godot.EditorExportPlugin._CustomizeScene(Godot.Node,System.String)"/>. The arguments can be used to identify the file. <paramref name="path"/> is the path of the file, <paramref name="type"/> is the <see cref="T:Godot.Resource"/> represented by the file (e.g. <see cref="T:Godot.PackedScene"/>), and <paramref name="features"/> is the list of features for the export.</para>
|
||
<para>Calling <see cref="M:Godot.EditorExportPlugin.Skip"/> inside this callback will make the file not included in the export.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._GetAndroidDependencies(Godot.EditorExportPlatform,System.Boolean)">
|
||
<summary>
|
||
<para>Virtual method to be overridden by the user. This is called to retrieve the set of Android dependencies provided by this plugin. Each returned Android dependency should have the format of an Android remote binary dependency: <c>org.godot.example:my-plugin:0.0.0</c></para>
|
||
<para>For more information see <a href="https://developer.android.com/build/dependencies?agpversion=4.1#dependency-types">Android documentation on dependencies</a>.</para>
|
||
<para><b>Note:</b> Only supported on Android and requires <c>EditorExportPlatformAndroid.gradle_build/use_gradle_build</c> to be enabled.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._GetAndroidDependenciesMavenRepos(Godot.EditorExportPlatform,System.Boolean)">
|
||
<summary>
|
||
<para>Virtual method to be overridden by the user. This is called to retrieve the URLs of Maven repositories for the set of Android dependencies provided by this plugin.</para>
|
||
<para>For more information see <a href="https://docs.gradle.org/current/userguide/dependency_management.html#sec:maven_repo">Gradle documentation on dependency management</a>.</para>
|
||
<para><b>Note:</b> Google's Maven repo and the Maven Central repo are already included by default.</para>
|
||
<para><b>Note:</b> Only supported on Android and requires <c>EditorExportPlatformAndroid.gradle_build/use_gradle_build</c> to be enabled.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._GetAndroidLibraries(Godot.EditorExportPlatform,System.Boolean)">
|
||
<summary>
|
||
<para>Virtual method to be overridden by the user. This is called to retrieve the local paths of the Android libraries archive (AAR) files provided by this plugin.</para>
|
||
<para><b>Note:</b> Relative paths <b>must</b> be relative to Godot's <c>res://addons/</c> directory. For example, an AAR file located under <c>res://addons/hello_world_plugin/HelloWorld.release.aar</c> can be returned as an absolute path using <c>res://addons/hello_world_plugin/HelloWorld.release.aar</c> or a relative path using <c>hello_world_plugin/HelloWorld.release.aar</c>.</para>
|
||
<para><b>Note:</b> Only supported on Android and requires <c>EditorExportPlatformAndroid.gradle_build/use_gradle_build</c> to be enabled.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._GetAndroidManifestActivityElementContents(Godot.EditorExportPlatform,System.Boolean)">
|
||
<summary>
|
||
<para>Virtual method to be overridden by the user. This is used at export time to update the contents of the <c>activity</c> element in the generated Android manifest.</para>
|
||
<para><b>Note:</b> Only supported on Android and requires <c>EditorExportPlatformAndroid.gradle_build/use_gradle_build</c> to be enabled.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._GetAndroidManifestApplicationElementContents(Godot.EditorExportPlatform,System.Boolean)">
|
||
<summary>
|
||
<para>Virtual method to be overridden by the user. This is used at export time to update the contents of the <c>application</c> element in the generated Android manifest.</para>
|
||
<para><b>Note:</b> Only supported on Android and requires <c>EditorExportPlatformAndroid.gradle_build/use_gradle_build</c> to be enabled.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._GetAndroidManifestElementContents(Godot.EditorExportPlatform,System.Boolean)">
|
||
<summary>
|
||
<para>Virtual method to be overridden by the user. This is used at export time to update the contents of the <c>manifest</c> element in the generated Android manifest.</para>
|
||
<para><b>Note:</b> Only supported on Android and requires <c>EditorExportPlatformAndroid.gradle_build/use_gradle_build</c> to be enabled.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._GetCustomizationConfigurationHash">
|
||
<summary>
|
||
<para>Return a hash based on the configuration passed (for both scenes and resources). This helps keep separate caches for separate export configurations.</para>
|
||
<para>Implementing this method is required if <see cref="M:Godot.EditorExportPlugin._BeginCustomizeResources(Godot.EditorExportPlatform,System.String[])"/> returns <see langword="true"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._GetExportFeatures(Godot.EditorExportPlatform,System.Boolean)">
|
||
<summary>
|
||
<para>Return a <see cref="T:System.String"/>[] of additional features this preset, for the given <paramref name="platform"/>, should have.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._GetExportOptionVisibility(Godot.EditorExportPlatform,System.String)">
|
||
<summary>
|
||
<para><b>Optional.</b></para>
|
||
<para>Validates <paramref name="option"/> and returns the visibility for the specified <paramref name="platform"/>. The default implementation returns <see langword="true"/> for all options.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._GetExportOptionWarning(Godot.EditorExportPlatform,System.String)">
|
||
<summary>
|
||
<para>Check the requirements for the given <paramref name="option"/> and return a non-empty warning string if they are not met.</para>
|
||
<para><b>Note:</b> Use <see cref="M:Godot.EditorExportPlugin.GetOption(Godot.StringName)"/> to check the value of the export options.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._GetExportOptions(Godot.EditorExportPlatform)">
|
||
<summary>
|
||
<para>Return a list of export options that can be configured for this export plugin.</para>
|
||
<para>Each element in the return value is a <see cref="T:Godot.Collections.Dictionary"/> with the following keys:</para>
|
||
<para>- <c>option</c>: A dictionary with the structure documented by <see cref="M:Godot.GodotObject.GetPropertyList"/>, but all keys are optional.</para>
|
||
<para>- <c>default_value</c>: The default value for this option.</para>
|
||
<para>- <c>update_visibility</c>: An optional boolean value. If set to <see langword="true"/>, the preset will emit <see cref="E:Godot.GodotObject.PropertyListChanged"/> when the option is changed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._GetExportOptionsOverrides(Godot.EditorExportPlatform)">
|
||
<summary>
|
||
<para>Return a <see cref="T:Godot.Collections.Dictionary"/> of override values for export options, that will be used instead of user-provided values. Overridden options will be hidden from the user interface.</para>
|
||
<para><code>
|
||
class MyExportPlugin extends EditorExportPlugin:
|
||
func _get_name() -> String:
|
||
return "MyExportPlugin"
|
||
|
||
func _supports_platform(platform) -> bool:
|
||
if platform is EditorExportPlatformPC:
|
||
# Run on all desktop platforms including Windows, MacOS and Linux.
|
||
return true
|
||
return false
|
||
|
||
func _get_export_options_overrides(platform) -> Dictionary:
|
||
# Override "Embed PCK" to always be enabled.
|
||
return {
|
||
"binary_format/embed_pck": true,
|
||
}
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._GetName">
|
||
<summary>
|
||
<para>Return the name identifier of this plugin (for future identification by the exporter). The plugins are sorted by name before exporting.</para>
|
||
<para>Implementing this method is required.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._ShouldUpdateExportOptions(Godot.EditorExportPlatform)">
|
||
<summary>
|
||
<para>Return <see langword="true"/>, if the result of <see cref="M:Godot.EditorExportPlugin._GetExportOptions(Godot.EditorExportPlatform)"/> has changed and the export options of preset corresponding to <paramref name="platform"/> should be updated.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin._SupportsPlatform(Godot.EditorExportPlatform)">
|
||
<summary>
|
||
<para>Return <see langword="true"/> if the plugin supports the given <paramref name="platform"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.AddSharedObject(System.String,System.String[],System.String)">
|
||
<summary>
|
||
<para>Adds a shared object or a directory containing only shared objects with the given <paramref name="tags"/> and destination <paramref name="path"/>.</para>
|
||
<para><b>Note:</b> In case of macOS exports, those shared objects will be added to <c>Frameworks</c> directory of app bundle.</para>
|
||
<para>In case of a directory code-sign will error if you place non code object in directory.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.AddSharedObject(System.String,System.ReadOnlySpan{System.String},System.String)">
|
||
<summary>
|
||
<para>Adds a shared object or a directory containing only shared objects with the given <paramref name="tags"/> and destination <paramref name="path"/>.</para>
|
||
<para><b>Note:</b> In case of macOS exports, those shared objects will be added to <c>Frameworks</c> directory of app bundle.</para>
|
||
<para>In case of a directory code-sign will error if you place non code object in directory.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.AddIosProjectStaticLib(System.String)">
|
||
<summary>
|
||
<para>Adds a static lib from the given <paramref name="path"/> to the iOS project.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.AddFile(System.String,System.Byte[],System.Boolean)">
|
||
<summary>
|
||
<para>Adds a custom file to be exported. <paramref name="path"/> is the virtual path that can be used to load the file, <paramref name="file"/> is the binary data of the file.</para>
|
||
<para>When called inside <see cref="M:Godot.EditorExportPlugin._ExportFile(System.String,System.String,System.String[])"/> and <paramref name="remap"/> is <see langword="true"/>, the current file will not be exported, but instead remapped to this custom file. <paramref name="remap"/> is ignored when called in other places.</para>
|
||
<para><paramref name="file"/> will not be imported, so consider using <see cref="M:Godot.EditorExportPlugin._CustomizeResource(Godot.Resource,System.String)"/> to remap imported resources.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.AddFile(System.String,System.ReadOnlySpan{System.Byte},System.Boolean)">
|
||
<summary>
|
||
<para>Adds a custom file to be exported. <paramref name="path"/> is the virtual path that can be used to load the file, <paramref name="file"/> is the binary data of the file.</para>
|
||
<para>When called inside <see cref="M:Godot.EditorExportPlugin._ExportFile(System.String,System.String,System.String[])"/> and <paramref name="remap"/> is <see langword="true"/>, the current file will not be exported, but instead remapped to this custom file. <paramref name="remap"/> is ignored when called in other places.</para>
|
||
<para><paramref name="file"/> will not be imported, so consider using <see cref="M:Godot.EditorExportPlugin._CustomizeResource(Godot.Resource,System.String)"/> to remap imported resources.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.AddIosFramework(System.String)">
|
||
<summary>
|
||
<para>Adds a static library (*.a) or dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.AddIosEmbeddedFramework(System.String)">
|
||
<summary>
|
||
<para>Adds a dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project and embeds it into resulting binary.</para>
|
||
<para><b>Note:</b> For static libraries (*.a) works in same way as <see cref="M:Godot.EditorExportPlugin.AddIosFramework(System.String)"/>.</para>
|
||
<para><b>Note:</b> This method should not be used for System libraries as they are already present on the device.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.AddIosPlistContent(System.String)">
|
||
<summary>
|
||
<para>Adds content for iOS Property List files.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.AddIosLinkerFlags(System.String)">
|
||
<summary>
|
||
<para>Adds linker flags for the iOS export.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.AddIosBundleFile(System.String)">
|
||
<summary>
|
||
<para>Adds an iOS bundle file from the given <paramref name="path"/> to the exported project.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.AddIosCppCode(System.String)">
|
||
<summary>
|
||
<para>Adds a C++ code to the iOS export. The final code is created from the code appended by each active export plugin.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.AddMacOSPluginFile(System.String)">
|
||
<summary>
|
||
<para>Adds file or directory matching <paramref name="path"/> to <c>PlugIns</c> directory of macOS app bundle.</para>
|
||
<para><b>Note:</b> This is useful only for macOS exports.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.Skip">
|
||
<summary>
|
||
<para>To be called inside <see cref="M:Godot.EditorExportPlugin._ExportFile(System.String,System.String,System.String[])"/>. Skips the current file, so it's not included in the export.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.GetOption(Godot.StringName)">
|
||
<summary>
|
||
<para>Returns the current value of an export option supplied by <see cref="M:Godot.EditorExportPlugin._GetExportOptions(Godot.EditorExportPlatform)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.GetExportPreset">
|
||
<summary>
|
||
<para>Returns currently used export preset.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.GetExportPlatform">
|
||
<summary>
|
||
<para>Returns currently used export platform.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPlugin.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlugin.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlugin.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._BeginCustomizeResources">
|
||
<summary>
|
||
Cached name for the '_begin_customize_resources' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._BeginCustomizeScenes">
|
||
<summary>
|
||
Cached name for the '_begin_customize_scenes' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._CustomizeResource">
|
||
<summary>
|
||
Cached name for the '_customize_resource' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._CustomizeScene">
|
||
<summary>
|
||
Cached name for the '_customize_scene' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._EndCustomizeResources">
|
||
<summary>
|
||
Cached name for the '_end_customize_resources' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._EndCustomizeScenes">
|
||
<summary>
|
||
Cached name for the '_end_customize_scenes' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._ExportBegin">
|
||
<summary>
|
||
Cached name for the '_export_begin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._ExportEnd">
|
||
<summary>
|
||
Cached name for the '_export_end' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._ExportFile">
|
||
<summary>
|
||
Cached name for the '_export_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._GetAndroidDependencies">
|
||
<summary>
|
||
Cached name for the '_get_android_dependencies' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._GetAndroidDependenciesMavenRepos">
|
||
<summary>
|
||
Cached name for the '_get_android_dependencies_maven_repos' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._GetAndroidLibraries">
|
||
<summary>
|
||
Cached name for the '_get_android_libraries' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._GetAndroidManifestActivityElementContents">
|
||
<summary>
|
||
Cached name for the '_get_android_manifest_activity_element_contents' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._GetAndroidManifestApplicationElementContents">
|
||
<summary>
|
||
Cached name for the '_get_android_manifest_application_element_contents' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._GetAndroidManifestElementContents">
|
||
<summary>
|
||
Cached name for the '_get_android_manifest_element_contents' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._GetCustomizationConfigurationHash">
|
||
<summary>
|
||
Cached name for the '_get_customization_configuration_hash' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._GetExportFeatures">
|
||
<summary>
|
||
Cached name for the '_get_export_features' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._GetExportOptionVisibility">
|
||
<summary>
|
||
Cached name for the '_get_export_option_visibility' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._GetExportOptionWarning">
|
||
<summary>
|
||
Cached name for the '_get_export_option_warning' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._GetExportOptions">
|
||
<summary>
|
||
Cached name for the '_get_export_options' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._GetExportOptionsOverrides">
|
||
<summary>
|
||
Cached name for the '_get_export_options_overrides' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._GetName">
|
||
<summary>
|
||
Cached name for the '_get_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._ShouldUpdateExportOptions">
|
||
<summary>
|
||
Cached name for the '_should_update_export_options' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName._SupportsPlatform">
|
||
<summary>
|
||
Cached name for the '_supports_platform' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName.AddSharedObject">
|
||
<summary>
|
||
Cached name for the 'add_shared_object' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName.AddIosProjectStaticLib">
|
||
<summary>
|
||
Cached name for the 'add_ios_project_static_lib' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName.AddFile">
|
||
<summary>
|
||
Cached name for the 'add_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName.AddIosFramework">
|
||
<summary>
|
||
Cached name for the 'add_ios_framework' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName.AddIosEmbeddedFramework">
|
||
<summary>
|
||
Cached name for the 'add_ios_embedded_framework' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName.AddIosPlistContent">
|
||
<summary>
|
||
Cached name for the 'add_ios_plist_content' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName.AddIosLinkerFlags">
|
||
<summary>
|
||
Cached name for the 'add_ios_linker_flags' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName.AddIosBundleFile">
|
||
<summary>
|
||
Cached name for the 'add_ios_bundle_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName.AddIosCppCode">
|
||
<summary>
|
||
Cached name for the 'add_ios_cpp_code' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName.AddMacOSPluginFile">
|
||
<summary>
|
||
Cached name for the 'add_macos_plugin_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName.Skip">
|
||
<summary>
|
||
Cached name for the 'skip' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName.GetOption">
|
||
<summary>
|
||
Cached name for the 'get_option' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName.GetExportPreset">
|
||
<summary>
|
||
Cached name for the 'get_export_preset' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPlugin.MethodName.GetExportPlatform">
|
||
<summary>
|
||
Cached name for the 'get_export_platform' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPlugin.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPreset">
|
||
<summary>
|
||
<para>Export preset configuration. Instances of <see cref="T:Godot.EditorExportPreset"/> by editor UI and intended to be used a read-only configuration passed to the <see cref="T:Godot.EditorExportPlatform"/> methods when exporting the project.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.Has(Godot.StringName)">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if preset has specified property.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetFilesToExport">
|
||
<summary>
|
||
<para>Returns array of files to export.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetCustomizedFiles">
|
||
<summary>
|
||
<para>Returns <see cref="T:Godot.Collections.Dictionary"/> of files selected in the "Resources" tab of the export dialog. Dictionary keys are file names and values are export mode - <c>"strip</c>, <c>"keep"</c>, or <c>"remove"</c>. See also <see cref="M:Godot.EditorExportPreset.GetFileExportMode(System.String,Godot.EditorExportPreset.FileExportMode)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetCustomizedFilesCount">
|
||
<summary>
|
||
<para>Returns number of files selected in the "Resources" tab of the export dialog.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.HasExportFile(System.String)">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if specified file is exported.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetFileExportMode(System.String,Godot.EditorExportPreset.FileExportMode)">
|
||
<summary>
|
||
<para>Returns file export mode for the specified file.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetPresetName">
|
||
<summary>
|
||
<para>Returns export preset name.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.IsRunnable">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if "Runnable" toggle is enabled in the export dialog.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.AreAdvancedOptionsEnabled">
|
||
<summary>
|
||
<para>Returns <see langword="true"/>, is "Advanced" toggle is enabled in the export dialog.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.IsDedicatedServer">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if dedicated server export mode is selected in the export dialog.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetExportFilter">
|
||
<summary>
|
||
<para>Returns export file filter mode selected in the "Resources" tab of the export dialog.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetIncludeFilter">
|
||
<summary>
|
||
<para>Returns file filters to include during export.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetExcludeFilter">
|
||
<summary>
|
||
<para>Returns file filters to exclude during export.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetCustomFeatures">
|
||
<summary>
|
||
<para>Returns string with a comma separated list of custom features.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetPatches">
|
||
<summary>
|
||
<para>Returns the list of packs on which to base a patch export on.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetExportPath">
|
||
<summary>
|
||
<para>Returns export target path.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetEncryptionInFilter">
|
||
<summary>
|
||
<para>Returns file filters to include during PCK encryption.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetEncryptionExFilter">
|
||
<summary>
|
||
<para>Returns file filters to exclude during PCK encryption.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetEncryptPck">
|
||
<summary>
|
||
<para>Returns <see langword="true"/>, PCK encryption is enabled in the export dialog.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetEncryptDirectory">
|
||
<summary>
|
||
<para>Returns <see langword="true"/>, PCK directory encryption is enabled in the export dialog.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetEncryptionKey">
|
||
<summary>
|
||
<para>Returns PCK encryption key.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetScriptExportMode">
|
||
<summary>
|
||
<para>Returns script export mode.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetOrEnv(Godot.StringName,System.String)">
|
||
<summary>
|
||
<para>Returns export option value or value of environment variable if it is set.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.GetVersion(Godot.StringName,System.Boolean)">
|
||
<summary>
|
||
<para>Returns the preset's version number, or fall back to the <c>ProjectSettings.application/config/version</c> project setting if set to an empty string.</para>
|
||
<para>If <paramref name="windowsVersion"/> is <see langword="true"/>, formats the returned version number to be compatible with Windows executable metadata.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorExportPreset.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPreset.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPreset.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.Has">
|
||
<summary>
|
||
Cached name for the 'has' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetFilesToExport">
|
||
<summary>
|
||
Cached name for the 'get_files_to_export' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetCustomizedFiles">
|
||
<summary>
|
||
Cached name for the 'get_customized_files' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetCustomizedFilesCount">
|
||
<summary>
|
||
Cached name for the 'get_customized_files_count' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.HasExportFile">
|
||
<summary>
|
||
Cached name for the 'has_export_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetFileExportMode">
|
||
<summary>
|
||
Cached name for the 'get_file_export_mode' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetPresetName">
|
||
<summary>
|
||
Cached name for the 'get_preset_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.IsRunnable">
|
||
<summary>
|
||
Cached name for the 'is_runnable' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.AreAdvancedOptionsEnabled">
|
||
<summary>
|
||
Cached name for the 'are_advanced_options_enabled' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.IsDedicatedServer">
|
||
<summary>
|
||
Cached name for the 'is_dedicated_server' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetExportFilter">
|
||
<summary>
|
||
Cached name for the 'get_export_filter' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetIncludeFilter">
|
||
<summary>
|
||
Cached name for the 'get_include_filter' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetExcludeFilter">
|
||
<summary>
|
||
Cached name for the 'get_exclude_filter' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetCustomFeatures">
|
||
<summary>
|
||
Cached name for the 'get_custom_features' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetPatches">
|
||
<summary>
|
||
Cached name for the 'get_patches' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetExportPath">
|
||
<summary>
|
||
Cached name for the 'get_export_path' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetEncryptionInFilter">
|
||
<summary>
|
||
Cached name for the 'get_encryption_in_filter' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetEncryptionExFilter">
|
||
<summary>
|
||
Cached name for the 'get_encryption_ex_filter' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetEncryptPck">
|
||
<summary>
|
||
Cached name for the 'get_encrypt_pck' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetEncryptDirectory">
|
||
<summary>
|
||
Cached name for the 'get_encrypt_directory' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetEncryptionKey">
|
||
<summary>
|
||
Cached name for the 'get_encryption_key' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetScriptExportMode">
|
||
<summary>
|
||
Cached name for the 'get_script_export_mode' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetOrEnv">
|
||
<summary>
|
||
Cached name for the 'get_or_env' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorExportPreset.MethodName.GetVersion">
|
||
<summary>
|
||
Cached name for the 'get_version' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorExportPreset.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFeatureProfile">
|
||
<summary>
|
||
<para>An editor feature profile can be used to disable specific features of the Godot editor. When disabled, the features won't appear in the editor, which makes the editor less cluttered. This is useful in education settings to reduce confusion or when working in a team. For example, artists and level designers could use a feature profile that disables the script editor to avoid accidentally making changes to files they aren't supposed to edit.</para>
|
||
<para>To manage editor feature profiles visually, use <b>Editor > Manage Feature Profiles...</b> at the top of the editor window.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.Feature.Feature3D">
|
||
<summary>
|
||
<para>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.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.Feature.Script">
|
||
<summary>
|
||
<para>The Script tab, which contains the script editor and class reference browser. If this feature is disabled, the Script tab won't display.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.Feature.AssetLib">
|
||
<summary>
|
||
<para>The AssetLib tab. If this feature is disabled, the AssetLib tab won't display.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.Feature.SceneTree">
|
||
<summary>
|
||
<para>Scene tree editing. If this feature is disabled, the Scene tree dock will still be visible but will be read-only.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.Feature.NodeDock">
|
||
<summary>
|
||
<para>The Node dock. If this feature is disabled, signals and groups won't be visible and modifiable from the editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.Feature.FilesystemDock">
|
||
<summary>
|
||
<para>The FileSystem dock. If this feature is disabled, the FileSystem dock won't be visible.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.Feature.ImportDock">
|
||
<summary>
|
||
<para>The Import dock. If this feature is disabled, the Import dock won't be visible.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.Feature.HistoryDock">
|
||
<summary>
|
||
<para>The History dock. If this feature is disabled, the History dock won't be visible.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.Feature.Game">
|
||
<summary>
|
||
<para>The Game tab, which allows embedding the game window and selecting nodes by clicking inside of it. If this feature is disabled, the Game tab won't display.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.Feature.Max">
|
||
<summary>
|
||
<para>Represents the size of the <see cref="T:Godot.EditorFeatureProfile.Feature"/> enum.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFeatureProfile.SetDisableClass(Godot.StringName,System.Boolean)">
|
||
<summary>
|
||
<para>If <paramref name="disable"/> is <see langword="true"/>, disables the class specified by <paramref name="className"/>. When disabled, the class won't appear in the Create New Node dialog.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFeatureProfile.IsClassDisabled(Godot.StringName)">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if the class specified by <paramref name="className"/> is disabled. When disabled, the class won't appear in the Create New Node dialog.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFeatureProfile.SetDisableClassEditor(Godot.StringName,System.Boolean)">
|
||
<summary>
|
||
<para>If <paramref name="disable"/> is <see langword="true"/>, disables editing for the class specified by <paramref name="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.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFeatureProfile.IsClassEditorDisabled(Godot.StringName)">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if editing for the class specified by <paramref name="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.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFeatureProfile.SetDisableClassProperty(Godot.StringName,Godot.StringName,System.Boolean)">
|
||
<summary>
|
||
<para>If <paramref name="disable"/> is <see langword="true"/>, disables editing for <paramref name="property"/> in the class specified by <paramref name="className"/>. When a property is disabled, it won't appear in the Inspector when selecting a node that extends the class specified by <paramref name="className"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFeatureProfile.IsClassPropertyDisabled(Godot.StringName,Godot.StringName)">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if <paramref name="property"/> is disabled in the class specified by <paramref name="className"/>. When a property is disabled, it won't appear in the Inspector when selecting a node that extends the class specified by <paramref name="className"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFeatureProfile.SetDisableFeature(Godot.EditorFeatureProfile.Feature,System.Boolean)">
|
||
<summary>
|
||
<para>If <paramref name="disable"/> is <see langword="true"/>, disables the editor feature specified in <paramref name="feature"/>. When a feature is disabled, it will disappear from the editor entirely.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFeatureProfile.IsFeatureDisabled(Godot.EditorFeatureProfile.Feature)">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if the <paramref name="feature"/> is disabled. When a feature is disabled, it will disappear from the editor entirely.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFeatureProfile.GetFeatureName(Godot.EditorFeatureProfile.Feature)">
|
||
<summary>
|
||
<para>Returns the specified <paramref name="feature"/>'s human-readable name.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFeatureProfile.SaveToFile(System.String)">
|
||
<summary>
|
||
<para>Saves the editor feature profile to a file in JSON format. It can then be imported using the feature profile manager's <b>Import</b> button or the <see cref="M:Godot.EditorFeatureProfile.LoadFromFile(System.String)"/> method.</para>
|
||
<para><b>Note:</b> Feature profiles created via the user interface are saved in the <c>feature_profiles</c> directory, as a file with the <c>.profile</c> extension. The editor configuration folder can be found by using <see cref="M:Godot.EditorPaths.GetConfigDir"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFeatureProfile.LoadFromFile(System.String)">
|
||
<summary>
|
||
<para>Loads an editor feature profile from a file. The file must follow the JSON format obtained by using the feature profile manager's <b>Export</b> button or the <see cref="M:Godot.EditorFeatureProfile.SaveToFile(System.String)"/> method.</para>
|
||
<para><b>Note:</b> Feature profiles created via the user interface are loaded from the <c>feature_profiles</c> directory, as a file with the <c>.profile</c> extension. The editor configuration folder can be found by using <see cref="M:Godot.EditorPaths.GetConfigDir"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFeatureProfile.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorFeatureProfile.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorFeatureProfile.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorFeatureProfile.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFeatureProfile.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.MethodName.SetDisableClass">
|
||
<summary>
|
||
Cached name for the 'set_disable_class' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.MethodName.IsClassDisabled">
|
||
<summary>
|
||
Cached name for the 'is_class_disabled' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.MethodName.SetDisableClassEditor">
|
||
<summary>
|
||
Cached name for the 'set_disable_class_editor' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.MethodName.IsClassEditorDisabled">
|
||
<summary>
|
||
Cached name for the 'is_class_editor_disabled' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.MethodName.SetDisableClassProperty">
|
||
<summary>
|
||
Cached name for the 'set_disable_class_property' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.MethodName.IsClassPropertyDisabled">
|
||
<summary>
|
||
Cached name for the 'is_class_property_disabled' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.MethodName.SetDisableFeature">
|
||
<summary>
|
||
Cached name for the 'set_disable_feature' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.MethodName.IsFeatureDisabled">
|
||
<summary>
|
||
Cached name for the 'is_feature_disabled' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.MethodName.GetFeatureName">
|
||
<summary>
|
||
Cached name for the 'get_feature_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.MethodName.SaveToFile">
|
||
<summary>
|
||
Cached name for the 'save_to_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFeatureProfile.MethodName.LoadFromFile">
|
||
<summary>
|
||
Cached name for the 'load_from_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFeatureProfile.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileDialog">
|
||
<summary>
|
||
<para><see cref="T:Godot.EditorFileDialog"/> is an enhanced version of <see cref="T:Godot.FileDialog"/> available only to editor plugins. Additional features include list of favorited/recent files and the ability to see files as thumbnails grid instead of list.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.FileModeEnum.OpenFile">
|
||
<summary>
|
||
<para>The <see cref="T:Godot.EditorFileDialog"/> can select only one file. Accepting the window will open the file.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.FileModeEnum.OpenFiles">
|
||
<summary>
|
||
<para>The <see cref="T:Godot.EditorFileDialog"/> can select multiple files. Accepting the window will open all files.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.FileModeEnum.OpenDir">
|
||
<summary>
|
||
<para>The <see cref="T:Godot.EditorFileDialog"/> can select only one directory. Accepting the window will open the directory.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.FileModeEnum.OpenAny">
|
||
<summary>
|
||
<para>The <see cref="T:Godot.EditorFileDialog"/> can select a file or directory. Accepting the window will open it.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.FileModeEnum.SaveFile">
|
||
<summary>
|
||
<para>The <see cref="T:Godot.EditorFileDialog"/> can select only one file. Accepting the window will save the file.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.AccessEnum.Resources">
|
||
<summary>
|
||
<para>The <see cref="T:Godot.EditorFileDialog"/> can only view <c>res://</c> directory contents.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.AccessEnum.Userdata">
|
||
<summary>
|
||
<para>The <see cref="T:Godot.EditorFileDialog"/> can only view <c>user://</c> directory contents.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.AccessEnum.Filesystem">
|
||
<summary>
|
||
<para>The <see cref="T:Godot.EditorFileDialog"/> can view the entire local file system.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.DisplayModeEnum.Thumbnails">
|
||
<summary>
|
||
<para>The <see cref="T:Godot.EditorFileDialog"/> displays resources as thumbnails.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.DisplayModeEnum.List">
|
||
<summary>
|
||
<para>The <see cref="T:Godot.EditorFileDialog"/> displays resources as a list of filenames.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorFileDialog.Access">
|
||
<summary>
|
||
<para>The location from which the user may select a file, including <c>res://</c>, <c>user://</c>, and the local file system.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorFileDialog.DisplayMode">
|
||
<summary>
|
||
<para>The view format in which the <see cref="T:Godot.EditorFileDialog"/> displays resources to the user.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorFileDialog.FileMode">
|
||
<summary>
|
||
<para>The dialog's open or save mode, which affects the selection behavior. See <see cref="T:Godot.EditorFileDialog.FileModeEnum"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorFileDialog.CurrentDir">
|
||
<summary>
|
||
<para>The currently occupied directory.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorFileDialog.CurrentFile">
|
||
<summary>
|
||
<para>The currently selected file.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorFileDialog.CurrentPath">
|
||
<summary>
|
||
<para>The file system path in the address bar.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorFileDialog.Filters">
|
||
<summary>
|
||
<para>The available file type filters. For example, this shows only <c>.png</c> and <c>.gd</c> files: <c>set_filters(PackedStringArray(["*.png ; PNG Images","*.gd ; GDScript Files"]))</c>. Multiple file types can also be specified in a single filter. <c>"*.png, *.jpg, *.jpeg ; Supported Images"</c> will show both PNG and JPEG files when selected.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorFileDialog.OptionCount">
|
||
<summary>
|
||
<para>The number of additional <see cref="T:Godot.OptionButton"/>s and <see cref="T:Godot.CheckBox"/>es in the dialog.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorFileDialog.ShowHiddenFiles">
|
||
<summary>
|
||
<para>If <see langword="true"/>, hidden files and directories will be visible in the <see cref="T:Godot.EditorFileDialog"/>. This property is synchronized with <c>EditorSettings.filesystem/file_dialog/show_hidden_files</c>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorFileDialog.DisableOverwriteWarning">
|
||
<summary>
|
||
<para>If <see langword="true"/>, the <see cref="T:Godot.EditorFileDialog"/> will not warn the user before overwriting files.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.ClearFilters">
|
||
<summary>
|
||
<para>Removes all filters except for "All Files (*.*)".</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.AddFilter(System.String,System.String)">
|
||
<summary>
|
||
<para>Adds a comma-delimited file name <paramref name="filter"/> option to the <see cref="T:Godot.EditorFileDialog"/> with an optional <paramref name="description"/>, which restricts what files can be picked.</para>
|
||
<para>A <paramref name="filter"/> should be of the form <c>"filename.extension"</c>, where filename and extension can be <c>*</c> to match any string. Filters starting with <c>.</c> (i.e. empty filenames) are not allowed.</para>
|
||
<para>For example, a <paramref name="filter"/> of <c>"*.tscn, *.scn"</c> and a <paramref name="description"/> of <c>"Scenes"</c> results in filter text "Scenes (*.tscn, *.scn)".</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.GetOptionName(System.Int32)">
|
||
<summary>
|
||
<para>Returns the name of the <see cref="T:Godot.OptionButton"/> or <see cref="T:Godot.CheckBox"/> with index <paramref name="option"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.GetOptionValues(System.Int32)">
|
||
<summary>
|
||
<para>Returns an array of values of the <see cref="T:Godot.OptionButton"/> with index <paramref name="option"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.GetOptionDefault(System.Int32)">
|
||
<summary>
|
||
<para>Returns the default value index of the <see cref="T:Godot.OptionButton"/> or <see cref="T:Godot.CheckBox"/> with index <paramref name="option"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.SetOptionName(System.Int32,System.String)">
|
||
<summary>
|
||
<para>Sets the name of the <see cref="T:Godot.OptionButton"/> or <see cref="T:Godot.CheckBox"/> with index <paramref name="option"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.SetOptionValues(System.Int32,System.String[])">
|
||
<summary>
|
||
<para>Sets the option values of the <see cref="T:Godot.OptionButton"/> with index <paramref name="option"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.SetOptionValues(System.Int32,System.ReadOnlySpan{System.String})">
|
||
<summary>
|
||
<para>Sets the option values of the <see cref="T:Godot.OptionButton"/> with index <paramref name="option"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.SetOptionDefault(System.Int32,System.Int32)">
|
||
<summary>
|
||
<para>Sets the default value index of the <see cref="T:Godot.OptionButton"/> or <see cref="T:Godot.CheckBox"/> with index <paramref name="option"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.AddOption(System.String,System.String[],System.Int32)">
|
||
<summary>
|
||
<para>Adds an additional <see cref="T:Godot.OptionButton"/> to the file dialog. If <paramref name="values"/> is empty, a <see cref="T:Godot.CheckBox"/> is added instead.</para>
|
||
<para><paramref name="defaultValueIndex"/> should be an index of the value in the <paramref name="values"/>. If <paramref name="values"/> is empty it should be either <c>1</c> (checked), or <c>0</c> (unchecked).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.AddOption(System.String,System.ReadOnlySpan{System.String},System.Int32)">
|
||
<summary>
|
||
<para>Adds an additional <see cref="T:Godot.OptionButton"/> to the file dialog. If <paramref name="values"/> is empty, a <see cref="T:Godot.CheckBox"/> is added instead.</para>
|
||
<para><paramref name="defaultValueIndex"/> should be an index of the value in the <paramref name="values"/>. If <paramref name="values"/> is empty it should be either <c>1</c> (checked), or <c>0</c> (unchecked).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.GetSelectedOptions">
|
||
<summary>
|
||
<para>Returns a <see cref="T:Godot.Collections.Dictionary"/> with the selected values of the additional <see cref="T:Godot.OptionButton"/>s and/or <see cref="T:Godot.CheckBox"/>es. <see cref="T:Godot.Collections.Dictionary"/> keys are names and values are selected value indices.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.ClearFileNameFilter">
|
||
<summary>
|
||
<para>Clear the filter for file names.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.SetFileNameFilter(System.String)">
|
||
<summary>
|
||
<para>Sets the value of the filter for file names.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.GetFileNameFilter">
|
||
<summary>
|
||
<para>Returns the value of the filter for file names.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.GetVBox">
|
||
<summary>
|
||
<para>Returns the <see cref="T:Godot.VBoxContainer"/> used to display the file system.</para>
|
||
<para><b>Warning:</b> This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their <see cref="P:Godot.CanvasItem.Visible"/> property.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.GetLineEdit">
|
||
<summary>
|
||
<para>Returns the LineEdit for the selected file.</para>
|
||
<para><b>Warning:</b> This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their <see cref="P:Godot.CanvasItem.Visible"/> property.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.AddSideMenu(Godot.Control,System.String)">
|
||
<summary>
|
||
<para>Adds the given <paramref name="menu"/> to the side of the file dialog with the given <paramref name="title"/> text on top. Only one side menu is allowed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.PopupFileDialog">
|
||
<summary>
|
||
<para>Shows the <see cref="T:Godot.EditorFileDialog"/> at the default size and position for file dialogs in the editor, and selects the file name if there is a current file.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.Invalidate">
|
||
<summary>
|
||
<para>Notify the <see cref="T:Godot.EditorFileDialog"/> that its view of the data is no longer accurate. Updates the view contents on next view update.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileDialog.FileSelectedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorFileDialog.FileSelected"/> event of a <see cref="T:Godot.EditorFileDialog"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorFileDialog.FileSelected">
|
||
<summary>
|
||
<para>Emitted when a file is selected.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileDialog.FilesSelectedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorFileDialog.FilesSelected"/> event of a <see cref="T:Godot.EditorFileDialog"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorFileDialog.FilesSelected">
|
||
<summary>
|
||
<para>Emitted when multiple files are selected.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileDialog.DirSelectedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorFileDialog.DirSelected"/> event of a <see cref="T:Godot.EditorFileDialog"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorFileDialog.DirSelected">
|
||
<summary>
|
||
<para>Emitted when a directory is selected.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileDialog.FileNameFilterChangedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorFileDialog.FileNameFilterChanged"/> event of a <see cref="T:Godot.EditorFileDialog"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorFileDialog.FileNameFilterChanged">
|
||
<summary>
|
||
<para>Emitted when the filter for file names changes.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorFileDialog.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorFileDialog.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.PropertyName.Access">
|
||
<summary>
|
||
Cached name for the 'access' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.PropertyName.DisplayMode">
|
||
<summary>
|
||
Cached name for the 'display_mode' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.PropertyName.FileMode">
|
||
<summary>
|
||
Cached name for the 'file_mode' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.PropertyName.CurrentDir">
|
||
<summary>
|
||
Cached name for the 'current_dir' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.PropertyName.CurrentFile">
|
||
<summary>
|
||
Cached name for the 'current_file' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.PropertyName.CurrentPath">
|
||
<summary>
|
||
Cached name for the 'current_path' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.PropertyName.Filters">
|
||
<summary>
|
||
Cached name for the 'filters' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.PropertyName.OptionCount">
|
||
<summary>
|
||
Cached name for the 'option_count' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.PropertyName.ShowHiddenFiles">
|
||
<summary>
|
||
Cached name for the 'show_hidden_files' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.PropertyName.DisableOverwriteWarning">
|
||
<summary>
|
||
Cached name for the 'disable_overwrite_warning' property.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileDialog.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.ClearFilters">
|
||
<summary>
|
||
Cached name for the 'clear_filters' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.AddFilter">
|
||
<summary>
|
||
Cached name for the 'add_filter' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.SetFilters">
|
||
<summary>
|
||
Cached name for the 'set_filters' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.GetFilters">
|
||
<summary>
|
||
Cached name for the 'get_filters' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.GetOptionName">
|
||
<summary>
|
||
Cached name for the 'get_option_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.GetOptionValues">
|
||
<summary>
|
||
Cached name for the 'get_option_values' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.GetOptionDefault">
|
||
<summary>
|
||
Cached name for the 'get_option_default' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.SetOptionName">
|
||
<summary>
|
||
Cached name for the 'set_option_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.SetOptionValues">
|
||
<summary>
|
||
Cached name for the 'set_option_values' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.SetOptionDefault">
|
||
<summary>
|
||
Cached name for the 'set_option_default' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.SetOptionCount">
|
||
<summary>
|
||
Cached name for the 'set_option_count' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.GetOptionCount">
|
||
<summary>
|
||
Cached name for the 'get_option_count' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.AddOption">
|
||
<summary>
|
||
Cached name for the 'add_option' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.GetSelectedOptions">
|
||
<summary>
|
||
Cached name for the 'get_selected_options' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.ClearFileNameFilter">
|
||
<summary>
|
||
Cached name for the 'clear_filename_filter' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.SetFileNameFilter">
|
||
<summary>
|
||
Cached name for the 'set_filename_filter' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.GetFileNameFilter">
|
||
<summary>
|
||
Cached name for the 'get_filename_filter' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.GetCurrentDir">
|
||
<summary>
|
||
Cached name for the 'get_current_dir' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.GetCurrentFile">
|
||
<summary>
|
||
Cached name for the 'get_current_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.GetCurrentPath">
|
||
<summary>
|
||
Cached name for the 'get_current_path' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.SetCurrentDir">
|
||
<summary>
|
||
Cached name for the 'set_current_dir' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.SetCurrentFile">
|
||
<summary>
|
||
Cached name for the 'set_current_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.SetCurrentPath">
|
||
<summary>
|
||
Cached name for the 'set_current_path' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.SetFileMode">
|
||
<summary>
|
||
Cached name for the 'set_file_mode' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.GetFileMode">
|
||
<summary>
|
||
Cached name for the 'get_file_mode' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.GetVBox">
|
||
<summary>
|
||
Cached name for the 'get_vbox' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.GetLineEdit">
|
||
<summary>
|
||
Cached name for the 'get_line_edit' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.SetAccess">
|
||
<summary>
|
||
Cached name for the 'set_access' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.GetAccess">
|
||
<summary>
|
||
Cached name for the 'get_access' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.SetShowHiddenFiles">
|
||
<summary>
|
||
Cached name for the 'set_show_hidden_files' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.IsShowingHiddenFiles">
|
||
<summary>
|
||
Cached name for the 'is_showing_hidden_files' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.SetDisplayMode">
|
||
<summary>
|
||
Cached name for the 'set_display_mode' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.GetDisplayMode">
|
||
<summary>
|
||
Cached name for the 'get_display_mode' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.SetDisableOverwriteWarning">
|
||
<summary>
|
||
Cached name for the 'set_disable_overwrite_warning' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.IsOverwriteWarningDisabled">
|
||
<summary>
|
||
Cached name for the 'is_overwrite_warning_disabled' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.AddSideMenu">
|
||
<summary>
|
||
Cached name for the 'add_side_menu' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.PopupFileDialog">
|
||
<summary>
|
||
Cached name for the 'popup_file_dialog' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.MethodName.Invalidate">
|
||
<summary>
|
||
Cached name for the 'invalidate' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileDialog.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.SignalName.FileSelected">
|
||
<summary>
|
||
Cached name for the 'file_selected' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.SignalName.FilesSelected">
|
||
<summary>
|
||
Cached name for the 'files_selected' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.SignalName.DirSelected">
|
||
<summary>
|
||
Cached name for the 'dir_selected' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileDialog.SignalName.FileNameFilterChanged">
|
||
<summary>
|
||
Cached name for the 'filename_filter_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileSystem">
|
||
<summary>
|
||
<para>This object holds information of all resources in the filesystem, their types, etc.</para>
|
||
<para><b>Note:</b> This class shouldn't be instantiated directly. Instead, access the singleton using <see cref="M:Godot.EditorInterface.GetResourceFilesystem"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystem.GetFilesystem">
|
||
<summary>
|
||
<para>Gets the root directory object.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystem.IsScanning">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if the filesystem is being scanned.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystem.GetScanningProgress">
|
||
<summary>
|
||
<para>Returns the scan progress for 0 to 1 if the FS is being scanned.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystem.Scan">
|
||
<summary>
|
||
<para>Scan the filesystem for changes.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystem.ScanSources">
|
||
<summary>
|
||
<para>Check if the source of any imported resource changed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystem.UpdateFile(System.String)">
|
||
<summary>
|
||
<para>Add a file in an existing directory, or schedule file information to be updated on editor restart. Can be used to update text files saved by an external program.</para>
|
||
<para>This will not import the file. To reimport, call <see cref="M:Godot.EditorFileSystem.ReimportFiles(System.String[])"/> or <see cref="M:Godot.EditorFileSystem.Scan"/> methods.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystem.GetFilesystemPath(System.String)">
|
||
<summary>
|
||
<para>Returns a view into the filesystem at <paramref name="path"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystem.GetFileType(System.String)">
|
||
<summary>
|
||
<para>Returns the resource type of the file, given the full path. This returns a string such as <c>"Resource"</c> or <c>"GDScript"</c>, <i>not</i> a file extension such as <c>".gd"</c>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystem.ReimportFiles(System.String[])">
|
||
<summary>
|
||
<para>Reimports a set of files. Call this if these files or their <c>.import</c> files were directly edited by script or an external program.</para>
|
||
<para>If the file type changed or the file was newly created, use <see cref="M:Godot.EditorFileSystem.UpdateFile(System.String)"/> or <see cref="M:Godot.EditorFileSystem.Scan"/>.</para>
|
||
<para><b>Note:</b> This function blocks until the import is finished. However, the main loop iteration, including timers and <see cref="M:Godot.Node._Process(System.Double)"/>, will occur during the import process due to progress bar updates. Avoid calls to <see cref="M:Godot.EditorFileSystem.ReimportFiles(System.String[])"/> or <see cref="M:Godot.EditorFileSystem.Scan"/> while an import is in progress.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystem.ReimportFiles(System.ReadOnlySpan{System.String})">
|
||
<summary>
|
||
<para>Reimports a set of files. Call this if these files or their <c>.import</c> files were directly edited by script or an external program.</para>
|
||
<para>If the file type changed or the file was newly created, use <see cref="M:Godot.EditorFileSystem.UpdateFile(System.String)"/> or <see cref="M:Godot.EditorFileSystem.Scan"/>.</para>
|
||
<para><b>Note:</b> This function blocks until the import is finished. However, the main loop iteration, including timers and <see cref="M:Godot.Node._Process(System.Double)"/>, will occur during the import process due to progress bar updates. Avoid calls to <see cref="M:Godot.EditorFileSystem.ReimportFiles(System.String[])"/> or <see cref="M:Godot.EditorFileSystem.Scan"/> while an import is in progress.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorFileSystem.FilesystemChanged">
|
||
<summary>
|
||
<para>Emitted if the filesystem changed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorFileSystem.ScriptClassesUpdated">
|
||
<summary>
|
||
<para>Emitted when the list of global script classes gets updated.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileSystem.SourcesChangedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorFileSystem.SourcesChanged"/> event of a <see cref="T:Godot.EditorFileSystem"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorFileSystem.SourcesChanged">
|
||
<summary>
|
||
<para>Emitted if the source of any imported file changed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileSystem.ResourcesReimportingEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorFileSystem.ResourcesReimporting"/> event of a <see cref="T:Godot.EditorFileSystem"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorFileSystem.ResourcesReimporting">
|
||
<summary>
|
||
<para>Emitted before a resource is reimported.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileSystem.ResourcesReimportedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorFileSystem.ResourcesReimported"/> event of a <see cref="T:Godot.EditorFileSystem"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorFileSystem.ResourcesReimported">
|
||
<summary>
|
||
<para>Emitted if a resource is reimported.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileSystem.ResourcesReloadEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorFileSystem.ResourcesReload"/> event of a <see cref="T:Godot.EditorFileSystem"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorFileSystem.ResourcesReload">
|
||
<summary>
|
||
<para>Emitted if at least one resource is reloaded when the filesystem is scanned.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystem.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystem.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystem.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorFileSystem.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileSystem.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystem.MethodName.GetFilesystem">
|
||
<summary>
|
||
Cached name for the 'get_filesystem' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystem.MethodName.IsScanning">
|
||
<summary>
|
||
Cached name for the 'is_scanning' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystem.MethodName.GetScanningProgress">
|
||
<summary>
|
||
Cached name for the 'get_scanning_progress' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystem.MethodName.Scan">
|
||
<summary>
|
||
Cached name for the 'scan' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystem.MethodName.ScanSources">
|
||
<summary>
|
||
Cached name for the 'scan_sources' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystem.MethodName.UpdateFile">
|
||
<summary>
|
||
Cached name for the 'update_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystem.MethodName.GetFilesystemPath">
|
||
<summary>
|
||
Cached name for the 'get_filesystem_path' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystem.MethodName.GetFileType">
|
||
<summary>
|
||
Cached name for the 'get_file_type' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystem.MethodName.ReimportFiles">
|
||
<summary>
|
||
Cached name for the 'reimport_files' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileSystem.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystem.SignalName.FilesystemChanged">
|
||
<summary>
|
||
Cached name for the 'filesystem_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystem.SignalName.ScriptClassesUpdated">
|
||
<summary>
|
||
Cached name for the 'script_classes_updated' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystem.SignalName.SourcesChanged">
|
||
<summary>
|
||
Cached name for the 'sources_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystem.SignalName.ResourcesReimporting">
|
||
<summary>
|
||
Cached name for the 'resources_reimporting' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystem.SignalName.ResourcesReimported">
|
||
<summary>
|
||
Cached name for the 'resources_reimported' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystem.SignalName.ResourcesReload">
|
||
<summary>
|
||
Cached name for the 'resources_reload' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileSystemDirectory">
|
||
<summary>
|
||
<para>A more generalized, low-level variation of the directory concept.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemDirectory.GetSubdirCount">
|
||
<summary>
|
||
<para>Returns the number of subdirectories in this directory.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemDirectory.GetSubdir(System.Int32)">
|
||
<summary>
|
||
<para>Returns the subdirectory at index <paramref name="idx"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemDirectory.GetFileCount">
|
||
<summary>
|
||
<para>Returns the number of files in this directory.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemDirectory.GetFile(System.Int32)">
|
||
<summary>
|
||
<para>Returns the name of the file at index <paramref name="idx"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemDirectory.GetFilePath(System.Int32)">
|
||
<summary>
|
||
<para>Returns the path to the file at index <paramref name="idx"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemDirectory.GetFileType(System.Int32)">
|
||
<summary>
|
||
<para>Returns the resource type of the file at index <paramref name="idx"/>. This returns a string such as <c>"Resource"</c> or <c>"GDScript"</c>, <i>not</i> a file extension such as <c>".gd"</c>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemDirectory.GetFileScriptClassName(System.Int32)">
|
||
<summary>
|
||
<para>Returns the name of the script class defined in the file at index <paramref name="idx"/>. If the file doesn't define a script class using the <c>class_name</c> syntax, this will return an empty string.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemDirectory.GetFileScriptClassExtends(System.Int32)">
|
||
<summary>
|
||
<para>Returns the base class of the script class defined in the file at index <paramref name="idx"/>. If the file doesn't define a script class using the <c>class_name</c> syntax, this will return an empty string.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemDirectory.GetFileImportIsValid(System.Int32)">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if the file at index <paramref name="idx"/> imported properly.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemDirectory.GetName">
|
||
<summary>
|
||
<para>Returns the name of this directory.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemDirectory.GetPath">
|
||
<summary>
|
||
<para>Returns the path to this directory.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemDirectory.GetParent">
|
||
<summary>
|
||
<para>Returns the parent directory for this directory or <see langword="null"/> if called on a directory at <c>res://</c> or <c>user://</c>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemDirectory.FindFileIndex(System.String)">
|
||
<summary>
|
||
<para>Returns the index of the file with name <paramref name="name"/> or <c>-1</c> if not found.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemDirectory.FindDirIndex(System.String)">
|
||
<summary>
|
||
<para>Returns the index of the directory with name <paramref name="name"/> or <c>-1</c> if not found.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemDirectory.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemDirectory.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemDirectory.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorFileSystemDirectory.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileSystemDirectory.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystemDirectory.MethodName.GetSubdirCount">
|
||
<summary>
|
||
Cached name for the 'get_subdir_count' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystemDirectory.MethodName.GetSubdir">
|
||
<summary>
|
||
Cached name for the 'get_subdir' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystemDirectory.MethodName.GetFileCount">
|
||
<summary>
|
||
Cached name for the 'get_file_count' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystemDirectory.MethodName.GetFile">
|
||
<summary>
|
||
Cached name for the 'get_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystemDirectory.MethodName.GetFilePath">
|
||
<summary>
|
||
Cached name for the 'get_file_path' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystemDirectory.MethodName.GetFileType">
|
||
<summary>
|
||
Cached name for the 'get_file_type' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystemDirectory.MethodName.GetFileScriptClassName">
|
||
<summary>
|
||
Cached name for the 'get_file_script_class_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystemDirectory.MethodName.GetFileScriptClassExtends">
|
||
<summary>
|
||
Cached name for the 'get_file_script_class_extends' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystemDirectory.MethodName.GetFileImportIsValid">
|
||
<summary>
|
||
Cached name for the 'get_file_import_is_valid' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystemDirectory.MethodName.GetName">
|
||
<summary>
|
||
Cached name for the 'get_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystemDirectory.MethodName.GetPath">
|
||
<summary>
|
||
Cached name for the 'get_path' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystemDirectory.MethodName.GetParent">
|
||
<summary>
|
||
Cached name for the 'get_parent' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystemDirectory.MethodName.FindFileIndex">
|
||
<summary>
|
||
Cached name for the 'find_file_index' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystemDirectory.MethodName.FindDirIndex">
|
||
<summary>
|
||
Cached name for the 'find_dir_index' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileSystemDirectory.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileSystemImportFormatSupportQuery">
|
||
<summary>
|
||
<para>This class is used to query and configure a certain import format. It is used in conjunction with asset format import plugins.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemImportFormatSupportQuery._GetFileExtensions">
|
||
<summary>
|
||
<para>Return the file extensions supported.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemImportFormatSupportQuery._IsActive">
|
||
<summary>
|
||
<para>Return whether this importer is active.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemImportFormatSupportQuery._Query">
|
||
<summary>
|
||
<para>Query support. Return <see langword="false"/> if import must not continue.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemImportFormatSupportQuery.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemImportFormatSupportQuery.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorFileSystemImportFormatSupportQuery.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorFileSystemImportFormatSupportQuery.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileSystemImportFormatSupportQuery.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystemImportFormatSupportQuery.MethodName._GetFileExtensions">
|
||
<summary>
|
||
Cached name for the '_get_file_extensions' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystemImportFormatSupportQuery.MethodName._IsActive">
|
||
<summary>
|
||
Cached name for the '_is_active' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorFileSystemImportFormatSupportQuery.MethodName._Query">
|
||
<summary>
|
||
Cached name for the '_query' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorFileSystemImportFormatSupportQuery.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorImportPlugin">
|
||
<summary>
|
||
<para><see cref="T:Godot.EditorImportPlugin"/>s provide a way to extend the editor's resource import functionality. Use them to import resources from custom files or to provide alternatives to the editor's existing importers.</para>
|
||
<para>EditorImportPlugins work by associating with specific file extensions and a resource type. See <see cref="M:Godot.EditorImportPlugin._GetRecognizedExtensions"/> and <see cref="M:Godot.EditorImportPlugin._GetResourceType"/>. They may optionally specify some import presets that affect the import process. EditorImportPlugins are responsible for creating the resources and saving them in the <c>.godot/imported</c> directory (see <c>ProjectSettings.application/config/use_hidden_project_data_directory</c>).</para>
|
||
<para>Below is an example EditorImportPlugin that imports a <see cref="T:Godot.Mesh"/> from a file with the extension ".special" or ".spec":</para>
|
||
<para><code>
|
||
using Godot;
|
||
|
||
public partial class MySpecialPlugin : EditorImportPlugin
|
||
{
|
||
public override string _GetImporterName()
|
||
{
|
||
return "my.special.plugin";
|
||
}
|
||
|
||
public override string _GetVisibleName()
|
||
{
|
||
return "Special Mesh";
|
||
}
|
||
|
||
public override string[] _GetRecognizedExtensions()
|
||
{
|
||
return new string[] { "special", "spec" };
|
||
}
|
||
|
||
public override string _GetSaveExtension()
|
||
{
|
||
return "mesh";
|
||
}
|
||
|
||
public override string _GetResourceType()
|
||
{
|
||
return "Mesh";
|
||
}
|
||
|
||
public override int _GetPresetCount()
|
||
{
|
||
return 1;
|
||
}
|
||
|
||
public override string _GetPresetName(int presetIndex)
|
||
{
|
||
return "Default";
|
||
}
|
||
|
||
public override Godot.Collections.Array<Godot.Collections.Dictionary> _GetImportOptions(string path, int presetIndex)
|
||
{
|
||
return new Godot.Collections.Array<Godot.Collections.Dictionary>
|
||
{
|
||
new Godot.Collections.Dictionary
|
||
{
|
||
{ "name", "myOption" },
|
||
{ "default_value", false },
|
||
}
|
||
};
|
||
}
|
||
|
||
public override Error _Import(string sourceFile, string savePath, Godot.Collections.Dictionary options, Godot.Collections.Array<string> platformVariants, Godot.Collections.Array<string> genFiles)
|
||
{
|
||
using var file = FileAccess.Open(sourceFile, FileAccess.ModeFlags.Read);
|
||
if (file.GetError() != Error.Ok)
|
||
{
|
||
return Error.Failed;
|
||
}
|
||
|
||
var mesh = new ArrayMesh();
|
||
// Fill the Mesh with data read in "file", left as an exercise to the reader.
|
||
string filename = $"{savePath}.{_GetSaveExtension()}";
|
||
return ResourceSaver.Save(mesh, filename);
|
||
}
|
||
}
|
||
</code></para>
|
||
<para>To use <see cref="T:Godot.EditorImportPlugin"/>, register it using the <see cref="M:Godot.EditorPlugin.AddImportPlugin(Godot.EditorImportPlugin,System.Boolean)"/> method first.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin._CanImportThreaded">
|
||
<summary>
|
||
<para>Tells whether this importer can be run in parallel on threads, or, on the contrary, it's only safe for the editor to call it from the main thread, for one file at a time.</para>
|
||
<para>If this method is not overridden, it will return <see langword="false"/> by default.</para>
|
||
<para>If this importer's implementation is thread-safe and can be run in parallel, override this with <see langword="true"/> to optimize for concurrency.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin._GetFormatVersion">
|
||
<summary>
|
||
<para>Gets the format version of this importer. Increment this version when making incompatible changes to the format of the imported resources.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin._GetImportOptions(System.String,System.Int32)">
|
||
<summary>
|
||
<para>Gets the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: <c>name</c>, <c>default_value</c>, <c>property_hint</c> (optional), <c>hint_string</c> (optional), <c>usage</c> (optional).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin._GetImportOrder">
|
||
<summary>
|
||
<para>Gets the order of this importer to be run when importing resources. Importers with <i>lower</i> import orders will be called first, and higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. The default import order is <c>0</c> unless overridden by a specific importer. See <see cref="T:Godot.ResourceImporter.ImportOrder"/> for some predefined values.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin._GetImporterName">
|
||
<summary>
|
||
<para>Gets the unique name of the importer.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin._GetOptionVisibility(System.String,Godot.StringName,Godot.Collections.Dictionary)">
|
||
<summary>
|
||
<para>This method can be overridden to hide specific import options if conditions are met. This is mainly useful for hiding options that depend on others if one of them is disabled.</para>
|
||
<para><code>
|
||
public void _GetOptionVisibility(string option, Godot.Collections.Dictionary options)
|
||
{
|
||
// Only show the lossy quality setting if the compression mode is set to "Lossy".
|
||
if (option == "compress/lossy_quality" && options.ContainsKey("compress/mode"))
|
||
{
|
||
return (int)options["compress/mode"] == CompressLossy; // This is a constant you set
|
||
}
|
||
|
||
return true;
|
||
}
|
||
</code></para>
|
||
<para>Returns <see langword="true"/> to make all options always visible.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin._GetPresetCount">
|
||
<summary>
|
||
<para>Gets the number of initial presets defined by the plugin. Use <see cref="M:Godot.EditorImportPlugin._GetImportOptions(System.String,System.Int32)"/> to get the default options for the preset and <see cref="M:Godot.EditorImportPlugin._GetPresetName(System.Int32)"/> to get the name of the preset.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin._GetPresetName(System.Int32)">
|
||
<summary>
|
||
<para>Gets the name of the options preset at this index.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin._GetPriority">
|
||
<summary>
|
||
<para>Gets the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. The default priority is <c>1.0</c>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin._GetRecognizedExtensions">
|
||
<summary>
|
||
<para>Gets the list of file extensions to associate with this loader (case-insensitive). e.g. <c>["obj"]</c>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin._GetResourceType">
|
||
<summary>
|
||
<para>Gets the Godot resource type associated with this loader. e.g. <c>"Mesh"</c> or <c>"Animation"</c>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin._GetSaveExtension">
|
||
<summary>
|
||
<para>Gets the extension used to save this resource in the <c>.godot/imported</c> directory (see <c>ProjectSettings.application/config/use_hidden_project_data_directory</c>).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin._GetVisibleName">
|
||
<summary>
|
||
<para>Gets the name to display in the import window. You should choose this name as a continuation to "Import as", e.g. "Import as Special Mesh".</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin._Import(System.String,System.String,Godot.Collections.Dictionary,Godot.Collections.Array{System.String},Godot.Collections.Array{System.String})">
|
||
<summary>
|
||
<para>Imports <paramref name="sourceFile"/> into <paramref name="savePath"/> with the import <paramref name="options"/> specified. The <paramref name="platformVariants"/> and <paramref name="genFiles"/> arrays will be modified by this function.</para>
|
||
<para>This method must be overridden to do the actual importing work. See this class' description for an example of overriding this method.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin.AppendImportExternalResource(System.String,Godot.Collections.Dictionary,System.String,Godot.Variant)">
|
||
<summary>
|
||
<para>This function can only be called during the <see cref="M:Godot.EditorImportPlugin._Import(System.String,System.String,Godot.Collections.Dictionary,Godot.Collections.Array{System.String},Godot.Collections.Array{System.String})"/> callback and it allows manually importing resources from it. This is useful when the imported file generates external resources that require importing (as example, images). Custom parameters for the ".import" file can be passed via the <paramref name="customOptions"/>. Additionally, in cases where multiple importers can handle a file, the <paramref name="customImporter"/> can be specified to force a specific one. This function performs a resource import and returns immediately with a success or error code. <paramref name="generatorParameters"/> defines optional extra metadata which will be stored as <c>generator_parameters</c> in the <c>remap</c> section of the <c>.import</c> file, for example to store a md5 hash of the source data.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorImportPlugin.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorImportPlugin.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorImportPlugin.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorImportPlugin.MethodName._CanImportThreaded">
|
||
<summary>
|
||
Cached name for the '_can_import_threaded' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorImportPlugin.MethodName._GetFormatVersion">
|
||
<summary>
|
||
Cached name for the '_get_format_version' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorImportPlugin.MethodName._GetImportOptions">
|
||
<summary>
|
||
Cached name for the '_get_import_options' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorImportPlugin.MethodName._GetImportOrder">
|
||
<summary>
|
||
Cached name for the '_get_import_order' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorImportPlugin.MethodName._GetImporterName">
|
||
<summary>
|
||
Cached name for the '_get_importer_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorImportPlugin.MethodName._GetOptionVisibility">
|
||
<summary>
|
||
Cached name for the '_get_option_visibility' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorImportPlugin.MethodName._GetPresetCount">
|
||
<summary>
|
||
Cached name for the '_get_preset_count' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorImportPlugin.MethodName._GetPresetName">
|
||
<summary>
|
||
Cached name for the '_get_preset_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorImportPlugin.MethodName._GetPriority">
|
||
<summary>
|
||
Cached name for the '_get_priority' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorImportPlugin.MethodName._GetRecognizedExtensions">
|
||
<summary>
|
||
Cached name for the '_get_recognized_extensions' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorImportPlugin.MethodName._GetResourceType">
|
||
<summary>
|
||
Cached name for the '_get_resource_type' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorImportPlugin.MethodName._GetSaveExtension">
|
||
<summary>
|
||
Cached name for the '_get_save_extension' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorImportPlugin.MethodName._GetVisibleName">
|
||
<summary>
|
||
Cached name for the '_get_visible_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorImportPlugin.MethodName._Import">
|
||
<summary>
|
||
Cached name for the '_import' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorImportPlugin.MethodName.AppendImportExternalResource">
|
||
<summary>
|
||
Cached name for the 'append_import_external_resource' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorImportPlugin.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorInspector">
|
||
<summary>
|
||
<para>This is the control that implements property editing in the editor's Settings dialogs, the Inspector dock, etc. To get the <see cref="T:Godot.EditorInspector"/> used in the editor's Inspector dock, use <see cref="M:Godot.EditorInterface.GetInspector"/>.</para>
|
||
<para><see cref="T:Godot.EditorInspector"/> will show properties in the same order as the array returned by <see cref="M:Godot.GodotObject.GetPropertyList"/>.</para>
|
||
<para>If a property's name is path-like (i.e. if it contains forward slashes), <see cref="T:Godot.EditorInspector"/> will create nested sections for "directories" along the path. For example, if a property is named <c>highlighting/gdscript/node_path_color</c>, it will be shown as "Node Path Color" inside the "GDScript" section nested inside the "Highlighting" section.</para>
|
||
<para>If a property has <see cref="F:Godot.PropertyUsageFlags.Group"/> usage, it will group subsequent properties whose name starts with the property's hint string. The group ends when a property does not start with that hint string or when a new group starts. An empty group name effectively ends the current group. <see cref="T:Godot.EditorInspector"/> will create a top-level section for each group. For example, if a property with group usage is named <c>Collide With</c> and its hint string is <c>collide_with_</c>, a subsequent <c>collide_with_area</c> property will be shown as "Area" inside the "Collide With" section. There is also a special case: when the hint string contains the name of a property, that property is grouped too. This is mainly to help grouping properties like <c>font</c>, <c>font_color</c> and <c>font_size</c> (using the hint string <c>font_</c>).</para>
|
||
<para>If a property has <see cref="F:Godot.PropertyUsageFlags.Subgroup"/> usage, a subgroup will be created in the same way as a group, and a second-level section will be created for each subgroup.</para>
|
||
<para><b>Note:</b> Unlike sections created from path-like property names, <see cref="T:Godot.EditorInspector"/> won't capitalize the name for sections created from groups. So properties with group usage usually use capitalized names instead of snake_cased names.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInspector.Edit(Godot.GodotObject)">
|
||
<summary>
|
||
<para>Shows the properties of the given <paramref name="object"/> in this inspector for editing. To clear the inspector, call this method with <see langword="null"/>.</para>
|
||
<para><b>Note:</b> If you want to edit an object in the editor's main inspector, use the <c>edit_*</c> methods in <see cref="T:Godot.EditorInterface"/> instead.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInspector.GetSelectedPath">
|
||
<summary>
|
||
<para>Gets the path of the currently selected property.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInspector.GetEditedObject">
|
||
<summary>
|
||
<para>Returns the object currently selected in this inspector.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInspector.InstantiatePropertyEditor(Godot.GodotObject,Godot.Variant.Type,System.String,Godot.PropertyHint,System.String,System.UInt32,System.Boolean)">
|
||
<summary>
|
||
<para>Creates a property editor that can be used by plugin UI to edit the specified property of an <paramref name="object"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorInspector.PropertySelectedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorInspector.PropertySelected"/> event of a <see cref="T:Godot.EditorInspector"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorInspector.PropertySelected">
|
||
<summary>
|
||
<para>Emitted when a property is selected in the inspector.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorInspector.PropertyKeyedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorInspector.PropertyKeyed"/> event of a <see cref="T:Godot.EditorInspector"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorInspector.PropertyKeyed">
|
||
<summary>
|
||
<para>Emitted when a property is keyed in the inspector. Properties can be keyed by clicking the "key" icon next to a property when the Animation panel is toggled.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorInspector.PropertyDeletedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorInspector.PropertyDeleted"/> event of a <see cref="T:Godot.EditorInspector"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorInspector.PropertyDeleted">
|
||
<summary>
|
||
<para>Emitted when a property is removed from the inspector.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorInspector.ResourceSelectedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorInspector.ResourceSelected"/> event of a <see cref="T:Godot.EditorInspector"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorInspector.ResourceSelected">
|
||
<summary>
|
||
<para>Emitted when a resource is selected in the inspector.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorInspector.ObjectIdSelectedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorInspector.ObjectIdSelected"/> event of a <see cref="T:Godot.EditorInspector"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorInspector.ObjectIdSelected">
|
||
<summary>
|
||
<para>Emitted when the Edit button of an <see cref="T:Godot.GodotObject"/> has been pressed in the inspector. This is mainly used in the remote scene tree Inspector.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorInspector.PropertyEditedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorInspector.PropertyEdited"/> event of a <see cref="T:Godot.EditorInspector"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorInspector.PropertyEdited">
|
||
<summary>
|
||
<para>Emitted when a property is edited in the inspector.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorInspector.PropertyToggledEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorInspector.PropertyToggled"/> event of a <see cref="T:Godot.EditorInspector"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorInspector.PropertyToggled">
|
||
<summary>
|
||
<para>Emitted when a boolean property is toggled in the inspector.</para>
|
||
<para><b>Note:</b> This signal is never emitted if the internal <c>autoclear</c> property enabled. Since this property is always enabled in the editor inspector, this signal is never emitted by the editor itself.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorInspector.EditedObjectChanged">
|
||
<summary>
|
||
<para>Emitted when the object being edited by the inspector has changed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorInspector.RestartRequested">
|
||
<summary>
|
||
<para>Emitted when a property that requires a restart to be applied is edited in the inspector. This is only used in the Project Settings and Editor Settings.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInspector.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorInspector.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorInspector.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorInspector.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorInspector.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspector.MethodName.Edit">
|
||
<summary>
|
||
Cached name for the 'edit' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspector.MethodName.GetSelectedPath">
|
||
<summary>
|
||
Cached name for the 'get_selected_path' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspector.MethodName.GetEditedObject">
|
||
<summary>
|
||
Cached name for the 'get_edited_object' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspector.MethodName.InstantiatePropertyEditor">
|
||
<summary>
|
||
Cached name for the 'instantiate_property_editor' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorInspector.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspector.SignalName.PropertySelected">
|
||
<summary>
|
||
Cached name for the 'property_selected' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspector.SignalName.PropertyKeyed">
|
||
<summary>
|
||
Cached name for the 'property_keyed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspector.SignalName.PropertyDeleted">
|
||
<summary>
|
||
Cached name for the 'property_deleted' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspector.SignalName.ResourceSelected">
|
||
<summary>
|
||
Cached name for the 'resource_selected' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspector.SignalName.ObjectIdSelected">
|
||
<summary>
|
||
Cached name for the 'object_id_selected' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspector.SignalName.PropertyEdited">
|
||
<summary>
|
||
Cached name for the 'property_edited' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspector.SignalName.PropertyToggled">
|
||
<summary>
|
||
Cached name for the 'property_toggled' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspector.SignalName.EditedObjectChanged">
|
||
<summary>
|
||
Cached name for the 'edited_object_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspector.SignalName.RestartRequested">
|
||
<summary>
|
||
Cached name for the 'restart_requested' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorInspectorPlugin">
|
||
<summary>
|
||
<para><see cref="T:Godot.EditorInspectorPlugin"/> allows adding custom property editors to <see cref="T:Godot.EditorInspector"/>.</para>
|
||
<para>When an object is edited, the <see cref="M:Godot.EditorInspectorPlugin._CanHandle(Godot.GodotObject)"/> function is called and must return <see langword="true"/> if the object type is supported.</para>
|
||
<para>If supported, the function <see cref="M:Godot.EditorInspectorPlugin._ParseBegin(Godot.GodotObject)"/> will be called, allowing to place custom controls at the beginning of the class.</para>
|
||
<para>Subsequently, the <see cref="M:Godot.EditorInspectorPlugin._ParseCategory(Godot.GodotObject,System.String)"/> and <see cref="M:Godot.EditorInspectorPlugin._ParseProperty(Godot.GodotObject,Godot.Variant.Type,System.String,Godot.PropertyHint,System.String,Godot.PropertyUsageFlags,System.Boolean)"/> are called for every category and property. They offer the ability to add custom controls to the inspector too.</para>
|
||
<para>Finally, <see cref="M:Godot.EditorInspectorPlugin._ParseEnd(Godot.GodotObject)"/> will be called.</para>
|
||
<para>On each of these calls, the "add" functions can be called.</para>
|
||
<para>To use <see cref="T:Godot.EditorInspectorPlugin"/>, register it using the <see cref="M:Godot.EditorPlugin.AddInspectorPlugin(Godot.EditorInspectorPlugin)"/> method first.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInspectorPlugin._CanHandle(Godot.GodotObject)">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if this object can be handled by this plugin.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInspectorPlugin._ParseBegin(Godot.GodotObject)">
|
||
<summary>
|
||
<para>Called to allow adding controls at the beginning of the property list for <paramref name="object"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInspectorPlugin._ParseCategory(Godot.GodotObject,System.String)">
|
||
<summary>
|
||
<para>Called to allow adding controls at the beginning of a category in the property list for <paramref name="object"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInspectorPlugin._ParseEnd(Godot.GodotObject)">
|
||
<summary>
|
||
<para>Called to allow adding controls at the end of the property list for <paramref name="object"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInspectorPlugin._ParseGroup(Godot.GodotObject,System.String)">
|
||
<summary>
|
||
<para>Called to allow adding controls at the beginning of a group or a sub-group in the property list for <paramref name="object"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInspectorPlugin._ParseProperty(Godot.GodotObject,Godot.Variant.Type,System.String,Godot.PropertyHint,System.String,Godot.PropertyUsageFlags,System.Boolean)">
|
||
<summary>
|
||
<para>Called to allow adding property-specific editors to the property list for <paramref name="object"/>. The added editor control must extend <see cref="T:Godot.EditorProperty"/>. Returning <see langword="true"/> removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInspectorPlugin.AddCustomControl(Godot.Control)">
|
||
<summary>
|
||
<para>Adds a custom control, which is not necessarily a property editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInspectorPlugin.AddPropertyEditor(System.String,Godot.Control,System.Boolean,System.String)">
|
||
<summary>
|
||
<para>Adds a property editor for an individual property. The <paramref name="editor"/> control must extend <see cref="T:Godot.EditorProperty"/>.</para>
|
||
<para>There can be multiple property editors for a property. If <paramref name="addToEnd"/> is <see langword="true"/>, this newly added editor will be displayed after all the other editors of the property whose <paramref name="addToEnd"/> is <see langword="false"/>. For example, the editor uses this parameter to add an "Edit Region" button for <see cref="P:Godot.Sprite2D.RegionRect"/> below the regular <see cref="T:Godot.Rect2"/> editor.</para>
|
||
<para><paramref name="label"/> can be used to choose a custom label for the property editor in the inspector. If left empty, the label is computed from the name of the property instead.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInspectorPlugin.AddPropertyEditorForMultipleProperties(System.String,System.String[],Godot.Control)">
|
||
<summary>
|
||
<para>Adds an editor that allows modifying multiple properties. The <paramref name="editor"/> control must extend <see cref="T:Godot.EditorProperty"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInspectorPlugin.AddPropertyEditorForMultipleProperties(System.String,System.ReadOnlySpan{System.String},Godot.Control)">
|
||
<summary>
|
||
<para>Adds an editor that allows modifying multiple properties. The <paramref name="editor"/> control must extend <see cref="T:Godot.EditorProperty"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInspectorPlugin.AddPropertyEditor(System.String,Godot.Control,System.Boolean)">
|
||
<summary>
|
||
<para>Adds a property editor for an individual property. The <paramref name="editor"/> control must extend <see cref="T:Godot.EditorProperty"/>.</para>
|
||
<para>There can be multiple property editors for a property. If <paramref name="addToEnd"/> is <see langword="true"/>, this newly added editor will be displayed after all the other editors of the property whose <paramref name="addToEnd"/> is <see langword="false"/>. For example, the editor uses this parameter to add an "Edit Region" button for <see cref="P:Godot.Sprite2D.RegionRect"/> below the regular <see cref="T:Godot.Rect2"/> editor.</para>
|
||
<para><paramref name="label"/> can be used to choose a custom label for the property editor in the inspector. If left empty, the label is computed from the name of the property instead.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInspectorPlugin.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorInspectorPlugin.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorInspectorPlugin.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorInspectorPlugin.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorInspectorPlugin.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspectorPlugin.MethodName._CanHandle">
|
||
<summary>
|
||
Cached name for the '_can_handle' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspectorPlugin.MethodName._ParseBegin">
|
||
<summary>
|
||
Cached name for the '_parse_begin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspectorPlugin.MethodName._ParseCategory">
|
||
<summary>
|
||
Cached name for the '_parse_category' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspectorPlugin.MethodName._ParseEnd">
|
||
<summary>
|
||
Cached name for the '_parse_end' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspectorPlugin.MethodName._ParseGroup">
|
||
<summary>
|
||
Cached name for the '_parse_group' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspectorPlugin.MethodName._ParseProperty">
|
||
<summary>
|
||
Cached name for the '_parse_property' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspectorPlugin.MethodName.AddCustomControl">
|
||
<summary>
|
||
Cached name for the 'add_custom_control' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspectorPlugin.MethodName.AddPropertyEditor">
|
||
<summary>
|
||
Cached name for the 'add_property_editor' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInspectorPlugin.MethodName.AddPropertyEditorForMultipleProperties">
|
||
<summary>
|
||
Cached name for the 'add_property_editor_for_multiple_properties' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorInspectorPlugin.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorInterface">
|
||
<summary>
|
||
<para><see cref="T:Godot.EditorInterface"/> gives you control over Godot editor's window. It allows customizing the window, saving and (re-)loading scenes, rendering mesh previews, inspecting and editing resources and objects, and provides access to <see cref="T:Godot.EditorSettings"/>, <see cref="T:Godot.EditorFileSystem"/>, <see cref="T:Godot.EditorResourcePreview"/>, <see cref="T:Godot.ScriptEditor"/>, the editor viewport, and information about scenes.</para>
|
||
<para><b>Note:</b> This class shouldn't be instantiated directly. Instead, access the singleton directly by its name.</para>
|
||
<para><code>
|
||
// In C# you can access it via the static Singleton property.
|
||
EditorSettings settings = EditorInterface.Singleton.GetEditorSettings();
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorInterface.DistractionFreeMode">
|
||
<summary>
|
||
<para>If <see langword="true"/>, enables distraction-free mode which hides side docks to increase the space available for the main view.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorInterface.MovieMakerEnabled">
|
||
<summary>
|
||
<para>If <see langword="true"/>, the Movie Maker mode is enabled in the editor. See <see cref="T:Godot.MovieWriter"/> for more information.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.RestartEditor(System.Boolean)">
|
||
<summary>
|
||
<para>Restarts the editor. This closes the editor and then opens the same project. If <paramref name="save"/> is <see langword="true"/>, the project will be saved before restarting.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetCommandPalette">
|
||
<summary>
|
||
<para>Returns the editor's <see cref="T:Godot.EditorCommandPalette"/> instance.</para>
|
||
<para><b>Warning:</b> Removing and freeing this node will render a part of the editor useless and may cause a crash.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetResourceFilesystem">
|
||
<summary>
|
||
<para>Returns the editor's <see cref="T:Godot.EditorFileSystem"/> instance.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetEditorPaths">
|
||
<summary>
|
||
<para>Returns the <see cref="T:Godot.EditorPaths"/> singleton.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetResourcePreviewer">
|
||
<summary>
|
||
<para>Returns the editor's <see cref="T:Godot.EditorResourcePreview"/> instance.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetSelection">
|
||
<summary>
|
||
<para>Returns the editor's <see cref="T:Godot.EditorSelection"/> instance.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetEditorSettings">
|
||
<summary>
|
||
<para>Returns the editor's <see cref="T:Godot.EditorSettings"/> instance.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetEditorToaster">
|
||
<summary>
|
||
<para>Returns the editor's <see cref="T:Godot.EditorToaster"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetEditorUndoRedo">
|
||
<summary>
|
||
<para>Returns the editor's <see cref="T:Godot.EditorUndoRedoManager"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.MakeMeshPreviews(Godot.Collections.Array{Godot.Mesh},System.Int32)">
|
||
<summary>
|
||
<para>Returns mesh previews rendered at the given size as an <see cref="T:Godot.Collections.Array"/> of <see cref="T:Godot.Texture2D"/>s.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.SetPluginEnabled(System.String,System.Boolean)">
|
||
<summary>
|
||
<para>Sets the enabled status of a plugin. The plugin name is the same as its directory name.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.IsPluginEnabled(System.String)">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if the specified <paramref name="plugin"/> is enabled. The plugin name is the same as its directory name.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetEditorTheme">
|
||
<summary>
|
||
<para>Returns the editor's <see cref="T:Godot.Theme"/>.</para>
|
||
<para><b>Note:</b> When creating custom editor UI, prefer accessing theme items directly from your GUI nodes using the <c>get_theme_*</c> methods.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetBaseControl">
|
||
<summary>
|
||
<para>Returns the main container of Godot editor's window. For example, you can use it to retrieve the size of the container and place your controls accordingly.</para>
|
||
<para><b>Warning:</b> Removing and freeing this node will render the editor useless and may cause a crash.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetEditorMainScreen">
|
||
<summary>
|
||
<para>Returns the editor control responsible for main screen plugins and tools. Use it with plugins that implement <see cref="M:Godot.EditorPlugin._HasMainScreen"/>.</para>
|
||
<para><b>Note:</b> This node is a <see cref="T:Godot.VBoxContainer"/>, which means that if you add a <see cref="T:Godot.Control"/> child to it, you need to set the child's <see cref="P:Godot.Control.SizeFlagsVertical"/> to <see cref="F:Godot.Control.SizeFlags.ExpandFill"/> to make it use the full available space.</para>
|
||
<para><b>Warning:</b> Removing and freeing this node will render a part of the editor useless and may cause a crash.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetScriptEditor">
|
||
<summary>
|
||
<para>Returns the editor's <see cref="T:Godot.ScriptEditor"/> instance.</para>
|
||
<para><b>Warning:</b> Removing and freeing this node will render a part of the editor useless and may cause a crash.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetEditorViewport2D">
|
||
<summary>
|
||
<para>Returns the 2D editor <see cref="T:Godot.SubViewport"/>. It does not have a camera. Instead, the view transforms are done directly and can be accessed with <see cref="P:Godot.Viewport.GlobalCanvasTransform"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetEditorViewport3D(System.Int32)">
|
||
<summary>
|
||
<para>Returns the specified 3D editor <see cref="T:Godot.SubViewport"/>, from <c>0</c> to <c>3</c>. The viewport can be used to access the active editor cameras with <see cref="M:Godot.Viewport.GetCamera3D"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.SetMainScreenEditor(System.String)">
|
||
<summary>
|
||
<para>Sets the editor's current main screen to the one specified in <paramref name="name"/>. <paramref name="name"/> must match the title of the tab in question exactly (e.g. <c>2D</c>, <c>3D</c>, <c>Script</c>, or <c>AssetLib</c> for default tabs).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.IsMultiWindowEnabled">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if multiple window support is enabled in the editor. Multiple window support is enabled if <i>all</i> of these statements are true:</para>
|
||
<para>- <c>EditorSettings.interface/multi_window/enable</c> is <see langword="true"/>.</para>
|
||
<para>- <c>EditorSettings.interface/editor/single_window_mode</c> is <see langword="false"/>.</para>
|
||
<para>- <see cref="P:Godot.Viewport.GuiEmbedSubwindows"/> is <see langword="false"/>. This is forced to <see langword="true"/> on platforms that don't support multiple windows such as Web, or when the <c>--single-window</c> <a href="$DOCS_URL/tutorials/editor/command_line_tutorial.html">command line argument</a> is used.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetEditorScale">
|
||
<summary>
|
||
<para>Returns the actual scale of the editor UI (<c>1.0</c> being 100% scale). This can be used to adjust position and dimensions of the UI added by plugins.</para>
|
||
<para><b>Note:</b> This value is set via the <c>interface/editor/display_scale</c> and <c>interface/editor/custom_display_scale</c> editor settings. Editor must be restarted for changes to be properly applied.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.PopupDialog(Godot.Window,System.Nullable{Godot.Rect2I})">
|
||
<summary>
|
||
<para>Pops up the <paramref name="dialog"/> in the editor UI with <see cref="M:Godot.Window.PopupExclusive(Godot.Node,System.Nullable{Godot.Rect2I})"/>. The dialog must have no current parent, otherwise the method fails.</para>
|
||
<para>See also <see cref="M:Godot.Window.SetUnparentWhenInvisible(System.Boolean)"/>.</para>
|
||
</summary>
|
||
<param name="rect">If the parameter is null, then the default value is <c>new Rect2I(new Vector2I(0, 0), new Vector2I(0, 0))</c>.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.PopupDialogCentered(Godot.Window,System.Nullable{Godot.Vector2I})">
|
||
<summary>
|
||
<para>Pops up the <paramref name="dialog"/> in the editor UI with <see cref="M:Godot.Window.PopupExclusiveCentered(Godot.Node,System.Nullable{Godot.Vector2I})"/>. The dialog must have no current parent, otherwise the method fails.</para>
|
||
<para>See also <see cref="M:Godot.Window.SetUnparentWhenInvisible(System.Boolean)"/>.</para>
|
||
</summary>
|
||
<param name="minsize">If the parameter is null, then the default value is <c>new Vector2I(0, 0)</c>.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.PopupDialogCenteredRatio(Godot.Window,System.Single)">
|
||
<summary>
|
||
<para>Pops up the <paramref name="dialog"/> in the editor UI with <see cref="M:Godot.Window.PopupExclusiveCenteredRatio(Godot.Node,System.Single)"/>. The dialog must have no current parent, otherwise the method fails.</para>
|
||
<para>See also <see cref="M:Godot.Window.SetUnparentWhenInvisible(System.Boolean)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.PopupDialogCenteredClamped(Godot.Window,System.Nullable{Godot.Vector2I},System.Single)">
|
||
<summary>
|
||
<para>Pops up the <paramref name="dialog"/> in the editor UI with <see cref="M:Godot.Window.PopupExclusiveCenteredClamped(Godot.Node,System.Nullable{Godot.Vector2I},System.Single)"/>. The dialog must have no current parent, otherwise the method fails.</para>
|
||
<para>See also <see cref="M:Godot.Window.SetUnparentWhenInvisible(System.Boolean)"/>.</para>
|
||
</summary>
|
||
<param name="minsize">If the parameter is null, then the default value is <c>new Vector2I(0, 0)</c>.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetCurrentFeatureProfile">
|
||
<summary>
|
||
<para>Returns the name of the currently activated feature profile. If the default profile is currently active, an empty string is returned instead.</para>
|
||
<para>In order to get a reference to the <see cref="T:Godot.EditorFeatureProfile"/>, you must load the feature profile using <see cref="M:Godot.EditorFeatureProfile.LoadFromFile(System.String)"/>.</para>
|
||
<para><b>Note:</b> Feature profiles created via the user interface are loaded from the <c>feature_profiles</c> directory, as a file with the <c>.profile</c> extension. The editor configuration folder can be found by using <see cref="M:Godot.EditorPaths.GetConfigDir"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.SetCurrentFeatureProfile(System.String)">
|
||
<summary>
|
||
<para>Selects and activates the specified feature profile with the given <paramref name="profileName"/>. Set <paramref name="profileName"/> to an empty string to reset to the default feature profile.</para>
|
||
<para>A feature profile can be created programmatically using the <see cref="T:Godot.EditorFeatureProfile"/> class.</para>
|
||
<para><b>Note:</b> The feature profile that gets activated must be located in the <c>feature_profiles</c> directory, as a file with the <c>.profile</c> extension. If a profile could not be found, an error occurs. The editor configuration folder can be found by using <see cref="M:Godot.EditorPaths.GetConfigDir"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.PopupNodeSelector(Godot.Callable,Godot.Collections.Array{Godot.StringName},Godot.Node)">
|
||
<summary>
|
||
<para>Pops up an editor dialog for selecting a <see cref="T:Godot.Node"/> from the edited scene. The <paramref name="callback"/> must take a single argument of type <see cref="T:Godot.NodePath"/>. It is called on the selected <see cref="T:Godot.NodePath"/> or the empty path <c>^""</c> if the dialog is canceled. If <paramref name="validTypes"/> is provided, the dialog will only show Nodes that match one of the listed Node types. If <paramref name="currentValue"/> is provided, the Node will be automatically selected in the tree, if it exists.</para>
|
||
<para><b>Example:</b> Display the node selection dialog as soon as this node is added to the tree for the first time:</para>
|
||
<para><code>
|
||
func _ready():
|
||
if Engine.is_editor_hint():
|
||
EditorInterface.popup_node_selector(_on_node_selected, ["Button"])
|
||
|
||
func _on_node_selected(node_path):
|
||
if node_path.is_empty():
|
||
print("node selection canceled")
|
||
else:
|
||
print("selected ", node_path)
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.PopupPropertySelector(Godot.GodotObject,Godot.Callable,System.Int32[],System.String)">
|
||
<summary>
|
||
<para>Pops up an editor dialog for selecting properties from <paramref name="object"/>. The <paramref name="callback"/> must take a single argument of type <see cref="T:Godot.NodePath"/>. It is called on the selected property path (see <c>NodePath.get_as_property_path</c>) or the empty path <c>^""</c> if the dialog is canceled. If <paramref name="typeFilter"/> is provided, the dialog will only show properties that match one of the listed <see cref="T:Godot.Variant.Type"/> values. If <paramref name="currentValue"/> is provided, the property will be selected automatically in the property list, if it exists.</para>
|
||
<para><code>
|
||
func _ready():
|
||
if Engine.is_editor_hint():
|
||
EditorInterface.popup_property_selector(this, _on_property_selected, [TYPE_INT])
|
||
|
||
func _on_property_selected(property_path):
|
||
if property_path.is_empty():
|
||
print("property selection canceled")
|
||
else:
|
||
print("selected ", property_path)
|
||
</code></para>
|
||
</summary>
|
||
<param name="typeFilter">If the parameter is null, then the default value is <c>Array.Empty<int>()</c>.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.PopupPropertySelector(Godot.GodotObject,Godot.Callable,System.ReadOnlySpan{System.Int32},System.String)">
|
||
<summary>
|
||
<para>Pops up an editor dialog for selecting properties from <paramref name="object"/>. The <paramref name="callback"/> must take a single argument of type <see cref="T:Godot.NodePath"/>. It is called on the selected property path (see <c>NodePath.get_as_property_path</c>) or the empty path <c>^""</c> if the dialog is canceled. If <paramref name="typeFilter"/> is provided, the dialog will only show properties that match one of the listed <see cref="T:Godot.Variant.Type"/> values. If <paramref name="currentValue"/> is provided, the property will be selected automatically in the property list, if it exists.</para>
|
||
<para><code>
|
||
func _ready():
|
||
if Engine.is_editor_hint():
|
||
EditorInterface.popup_property_selector(this, _on_property_selected, [TYPE_INT])
|
||
|
||
func _on_property_selected(property_path):
|
||
if property_path.is_empty():
|
||
print("property selection canceled")
|
||
else:
|
||
print("selected ", property_path)
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.PopupMethodSelector(Godot.GodotObject,Godot.Callable,System.String)">
|
||
<summary>
|
||
<para>Pops up an editor dialog for selecting a method from <paramref name="object"/>. The <paramref name="callback"/> must take a single argument of type <see cref="T:System.String"/> which will contain the name of the selected method or be empty if the dialog is canceled. If <paramref name="currentValue"/> is provided, the method will be selected automatically in the method list, if it exists.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.PopupQuickOpen(Godot.Callable,Godot.Collections.Array{Godot.StringName})">
|
||
<summary>
|
||
<para>Pops up an editor dialog for quick selecting a resource file. The <paramref name="callback"/> must take a single argument of type <see cref="T:System.String"/> which will contain the path of the selected resource or be empty if the dialog is canceled. If <paramref name="baseTypes"/> is provided, the dialog will only show resources that match these types. Only types deriving from <see cref="T:Godot.Resource"/> are supported.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.PopupCreateDialog(Godot.Callable,Godot.StringName,System.String,System.String,Godot.Collections.Array{Godot.StringName},Godot.Collections.Dictionary)">
|
||
<summary>
|
||
<para>Pops up an editor dialog for creating an object.</para>
|
||
<para>The <paramref name="callback"/> must take a single argument of type <see cref="T:Godot.StringName"/> which will contain the type name of the selected object or be empty if no item is selected.</para>
|
||
<para>The <paramref name="baseType"/> specifies the base type of objects to display. For example, if you set this to "Resource", all types derived from <see cref="T:Godot.Resource"/> will display in the create dialog.</para>
|
||
<para>The <paramref name="currentType"/> will be passed in the search box of the create dialog, and the specified type can be immediately selected when the dialog pops up. If the <paramref name="currentType"/> is not derived from <paramref name="baseType"/>, there will be no result of the type in the dialog.</para>
|
||
<para>The <paramref name="dialogTitle"/> allows you to define a custom title for the dialog. This is useful if you want to accurately hint the usage of the dialog. If the <paramref name="dialogTitle"/> is an empty string, the dialog will use "Create New 'Base Type'" as the default title.</para>
|
||
<para>The <paramref name="typeBlocklist"/> contains a list of type names, and the types in the blocklist will be hidden from the create dialog.</para>
|
||
<para>The <paramref name="typeSuffixes"/> is a dictionary, with keys being <see cref="T:Godot.StringName"/>s and values being <see cref="T:System.String"/>s. Custom suffixes override the default suffixes which are file names of their scripts. For example, if you set a custom suffix as "Custom Suffix" for a global script type,</para>
|
||
<para><code>
|
||
Node
|
||
|- MyCustomNode (my_custom_node.gd)
|
||
</code></para>
|
||
<para>will be</para>
|
||
<para><code>
|
||
Node
|
||
|- MyCustomNode (Custom Suffix)
|
||
</code></para>
|
||
<para>Bear in mind that when a built-in type does not have any custom suffix, its suffix will be removed. The suffix of a type created from a script will fall back to its script file name. For global types by scripts, if you customize their suffixes to an empty string, their suffixes will be removed.</para>
|
||
<para><b>Note:</b> Trying to list the base type in the <paramref name="typeBlocklist"/> will hide all types derived from the base type from the create dialog.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetFileSystemDock">
|
||
<summary>
|
||
<para>Returns the editor's <see cref="T:Godot.FileSystemDock"/> instance.</para>
|
||
<para><b>Warning:</b> Removing and freeing this node will render a part of the editor useless and may cause a crash.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.SelectFile(System.String)">
|
||
<summary>
|
||
<para>Selects the file, with the path provided by <paramref name="file"/>, in the FileSystem dock.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetSelectedPaths">
|
||
<summary>
|
||
<para>Returns an array containing the paths of the currently selected files (and directories) in the <see cref="T:Godot.FileSystemDock"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetCurrentPath">
|
||
<summary>
|
||
<para>Returns the current path being viewed in the <see cref="T:Godot.FileSystemDock"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetCurrentDirectory">
|
||
<summary>
|
||
<para>Returns the current directory being viewed in the <see cref="T:Godot.FileSystemDock"/>. If a file is selected, its base directory will be returned using <c>String.get_base_dir</c> instead.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetInspector">
|
||
<summary>
|
||
<para>Returns the editor's <see cref="T:Godot.EditorInspector"/> instance.</para>
|
||
<para><b>Warning:</b> Removing and freeing this node will render a part of the editor useless and may cause a crash.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.InspectObject(Godot.GodotObject,System.String,System.Boolean)">
|
||
<summary>
|
||
<para>Shows the given property on the given <paramref name="object"/> in the editor's Inspector dock. If <paramref name="inspectorOnly"/> is <see langword="true"/>, plugins will not attempt to edit <paramref name="object"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.EditResource(Godot.Resource)">
|
||
<summary>
|
||
<para>Edits the given <see cref="T:Godot.Resource"/>. If the resource is a <see cref="T:Godot.Script"/> you can also edit it with <see cref="M:Godot.EditorInterface.EditScript(Godot.Script,System.Int32,System.Int32,System.Boolean)"/> to specify the line and column position.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.EditNode(Godot.Node)">
|
||
<summary>
|
||
<para>Edits the given <see cref="T:Godot.Node"/>. The node will be also selected if it's inside the scene tree.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.EditScript(Godot.Script,System.Int32,System.Int32,System.Boolean)">
|
||
<summary>
|
||
<para>Edits the given <see cref="T:Godot.Script"/>. The line and column on which to open the script can also be specified. The script will be open with the user-configured editor for the script's language which may be an external editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.OpenSceneFromPath(System.String,System.Boolean)">
|
||
<summary>
|
||
<para>Opens the scene at the given path. If <paramref name="setInherited"/> is <see langword="true"/>, creates a new inherited scene.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.ReloadSceneFromPath(System.String)">
|
||
<summary>
|
||
<para>Reloads the scene at the given path.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetOpenScenes">
|
||
<summary>
|
||
<para>Returns an <see cref="T:Godot.Collections.Array"/> with the file paths of the currently opened scenes.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetEditedSceneRoot">
|
||
<summary>
|
||
<para>Returns the edited (current) scene's root <see cref="T:Godot.Node"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.SaveScene">
|
||
<summary>
|
||
<para>Saves the currently active scene. Returns either <see cref="F:Godot.Error.Ok"/> or <see cref="F:Godot.Error.CantCreate"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.SaveSceneAs(System.String,System.Boolean)">
|
||
<summary>
|
||
<para>Saves the currently active scene as a file at <paramref name="path"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.SaveAllScenes">
|
||
<summary>
|
||
<para>Saves all opened scenes in the editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.MarkSceneAsUnsaved">
|
||
<summary>
|
||
<para>Marks the current scene tab as unsaved.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.PlayMainScene">
|
||
<summary>
|
||
<para>Plays the main scene.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.PlayCurrentScene">
|
||
<summary>
|
||
<para>Plays the currently active scene.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.PlayCustomScene(System.String)">
|
||
<summary>
|
||
<para>Plays the scene specified by its filepath.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.StopPlayingScene">
|
||
<summary>
|
||
<para>Stops the scene that is currently playing.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.IsPlayingScene">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if a scene is currently being played, <see langword="false"/> otherwise. Paused scenes are considered as being played.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.GetPlayingScene">
|
||
<summary>
|
||
<para>Returns the name of the scene that is being played. If no scene is currently being played, returns an empty string.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.OpenSceneFromPath(System.String)">
|
||
<summary>
|
||
<para>Opens the scene at the given path. If <paramref name="setInherited"/> is <see langword="true"/>, creates a new inherited scene.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.PopupPropertySelector(Godot.GodotObject,Godot.Callable,System.Int32[])">
|
||
<summary>
|
||
<para>Pops up an editor dialog for selecting properties from <paramref name="object"/>. The <paramref name="callback"/> must take a single argument of type <see cref="T:Godot.NodePath"/>. It is called on the selected property path (see <c>NodePath.get_as_property_path</c>) or the empty path <c>^""</c> if the dialog is canceled. If <paramref name="typeFilter"/> is provided, the dialog will only show properties that match one of the listed <see cref="T:Godot.Variant.Type"/> values. If <paramref name="currentValue"/> is provided, the property will be selected automatically in the property list, if it exists.</para>
|
||
<para><code>
|
||
func _ready():
|
||
if Engine.is_editor_hint():
|
||
EditorInterface.popup_property_selector(this, _on_property_selected, [TYPE_INT])
|
||
|
||
func _on_property_selected(property_path):
|
||
if property_path.is_empty():
|
||
print("property selection canceled")
|
||
else:
|
||
print("selected ", property_path)
|
||
</code></para>
|
||
</summary>
|
||
<param name="typeFilter">If the parameter is null, then the default value is <c>Array.Empty<int>()</c>.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.PopupPropertySelector(Godot.GodotObject,Godot.Callable,System.ReadOnlySpan{System.Int32})">
|
||
<summary>
|
||
<para>Pops up an editor dialog for selecting properties from <paramref name="object"/>. The <paramref name="callback"/> must take a single argument of type <see cref="T:Godot.NodePath"/>. It is called on the selected property path (see <c>NodePath.get_as_property_path</c>) or the empty path <c>^""</c> if the dialog is canceled. If <paramref name="typeFilter"/> is provided, the dialog will only show properties that match one of the listed <see cref="T:Godot.Variant.Type"/> values. If <paramref name="currentValue"/> is provided, the property will be selected automatically in the property list, if it exists.</para>
|
||
<para><code>
|
||
func _ready():
|
||
if Engine.is_editor_hint():
|
||
EditorInterface.popup_property_selector(this, _on_property_selected, [TYPE_INT])
|
||
|
||
func _on_property_selected(property_path):
|
||
if property_path.is_empty():
|
||
print("property selection canceled")
|
||
else:
|
||
print("selected ", property_path)
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.PopupNodeSelector(Godot.Callable,Godot.Collections.Array{Godot.StringName})">
|
||
<summary>
|
||
<para>Pops up an editor dialog for selecting a <see cref="T:Godot.Node"/> from the edited scene. The <paramref name="callback"/> must take a single argument of type <see cref="T:Godot.NodePath"/>. It is called on the selected <see cref="T:Godot.NodePath"/> or the empty path <c>^""</c> if the dialog is canceled. If <paramref name="validTypes"/> is provided, the dialog will only show Nodes that match one of the listed Node types. If <paramref name="currentValue"/> is provided, the Node will be automatically selected in the tree, if it exists.</para>
|
||
<para><b>Example:</b> Display the node selection dialog as soon as this node is added to the tree for the first time:</para>
|
||
<para><code>
|
||
func _ready():
|
||
if Engine.is_editor_hint():
|
||
EditorInterface.popup_node_selector(_on_node_selected, ["Button"])
|
||
|
||
func _on_node_selected(node_path):
|
||
if node_path.is_empty():
|
||
print("node selection canceled")
|
||
else:
|
||
print("selected ", node_path)
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorInterface.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorInterface.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.PropertyName.DistractionFreeMode">
|
||
<summary>
|
||
Cached name for the 'distraction_free_mode' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.PropertyName.MovieMakerEnabled">
|
||
<summary>
|
||
Cached name for the 'movie_maker_enabled' property.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorInterface.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.RestartEditor">
|
||
<summary>
|
||
Cached name for the 'restart_editor' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetCommandPalette">
|
||
<summary>
|
||
Cached name for the 'get_command_palette' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetResourceFilesystem">
|
||
<summary>
|
||
Cached name for the 'get_resource_filesystem' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetEditorPaths">
|
||
<summary>
|
||
Cached name for the 'get_editor_paths' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetResourcePreviewer">
|
||
<summary>
|
||
Cached name for the 'get_resource_previewer' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetSelection">
|
||
<summary>
|
||
Cached name for the 'get_selection' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetEditorSettings">
|
||
<summary>
|
||
Cached name for the 'get_editor_settings' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetEditorToaster">
|
||
<summary>
|
||
Cached name for the 'get_editor_toaster' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetEditorUndoRedo">
|
||
<summary>
|
||
Cached name for the 'get_editor_undo_redo' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.MakeMeshPreviews">
|
||
<summary>
|
||
Cached name for the 'make_mesh_previews' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.SetPluginEnabled">
|
||
<summary>
|
||
Cached name for the 'set_plugin_enabled' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.IsPluginEnabled">
|
||
<summary>
|
||
Cached name for the 'is_plugin_enabled' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetEditorTheme">
|
||
<summary>
|
||
Cached name for the 'get_editor_theme' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetBaseControl">
|
||
<summary>
|
||
Cached name for the 'get_base_control' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetEditorMainScreen">
|
||
<summary>
|
||
Cached name for the 'get_editor_main_screen' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetScriptEditor">
|
||
<summary>
|
||
Cached name for the 'get_script_editor' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetEditorViewport2D">
|
||
<summary>
|
||
Cached name for the 'get_editor_viewport_2d' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetEditorViewport3D">
|
||
<summary>
|
||
Cached name for the 'get_editor_viewport_3d' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.SetMainScreenEditor">
|
||
<summary>
|
||
Cached name for the 'set_main_screen_editor' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.SetDistractionFreeMode">
|
||
<summary>
|
||
Cached name for the 'set_distraction_free_mode' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.IsDistractionFreeModeEnabled">
|
||
<summary>
|
||
Cached name for the 'is_distraction_free_mode_enabled' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.IsMultiWindowEnabled">
|
||
<summary>
|
||
Cached name for the 'is_multi_window_enabled' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetEditorScale">
|
||
<summary>
|
||
Cached name for the 'get_editor_scale' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.PopupDialog">
|
||
<summary>
|
||
Cached name for the 'popup_dialog' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.PopupDialogCentered">
|
||
<summary>
|
||
Cached name for the 'popup_dialog_centered' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.PopupDialogCenteredRatio">
|
||
<summary>
|
||
Cached name for the 'popup_dialog_centered_ratio' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.PopupDialogCenteredClamped">
|
||
<summary>
|
||
Cached name for the 'popup_dialog_centered_clamped' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetCurrentFeatureProfile">
|
||
<summary>
|
||
Cached name for the 'get_current_feature_profile' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.SetCurrentFeatureProfile">
|
||
<summary>
|
||
Cached name for the 'set_current_feature_profile' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.PopupNodeSelector">
|
||
<summary>
|
||
Cached name for the 'popup_node_selector' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.PopupPropertySelector">
|
||
<summary>
|
||
Cached name for the 'popup_property_selector' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.PopupMethodSelector">
|
||
<summary>
|
||
Cached name for the 'popup_method_selector' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.PopupQuickOpen">
|
||
<summary>
|
||
Cached name for the 'popup_quick_open' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.PopupCreateDialog">
|
||
<summary>
|
||
Cached name for the 'popup_create_dialog' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetFileSystemDock">
|
||
<summary>
|
||
Cached name for the 'get_file_system_dock' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.SelectFile">
|
||
<summary>
|
||
Cached name for the 'select_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetSelectedPaths">
|
||
<summary>
|
||
Cached name for the 'get_selected_paths' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetCurrentPath">
|
||
<summary>
|
||
Cached name for the 'get_current_path' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetCurrentDirectory">
|
||
<summary>
|
||
Cached name for the 'get_current_directory' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetInspector">
|
||
<summary>
|
||
Cached name for the 'get_inspector' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.InspectObject">
|
||
<summary>
|
||
Cached name for the 'inspect_object' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.EditResource">
|
||
<summary>
|
||
Cached name for the 'edit_resource' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.EditNode">
|
||
<summary>
|
||
Cached name for the 'edit_node' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.EditScript">
|
||
<summary>
|
||
Cached name for the 'edit_script' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.OpenSceneFromPath">
|
||
<summary>
|
||
Cached name for the 'open_scene_from_path' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.ReloadSceneFromPath">
|
||
<summary>
|
||
Cached name for the 'reload_scene_from_path' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetOpenScenes">
|
||
<summary>
|
||
Cached name for the 'get_open_scenes' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetEditedSceneRoot">
|
||
<summary>
|
||
Cached name for the 'get_edited_scene_root' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.SaveScene">
|
||
<summary>
|
||
Cached name for the 'save_scene' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.SaveSceneAs">
|
||
<summary>
|
||
Cached name for the 'save_scene_as' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.SaveAllScenes">
|
||
<summary>
|
||
Cached name for the 'save_all_scenes' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.MarkSceneAsUnsaved">
|
||
<summary>
|
||
Cached name for the 'mark_scene_as_unsaved' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.PlayMainScene">
|
||
<summary>
|
||
Cached name for the 'play_main_scene' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.PlayCurrentScene">
|
||
<summary>
|
||
Cached name for the 'play_current_scene' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.PlayCustomScene">
|
||
<summary>
|
||
Cached name for the 'play_custom_scene' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.StopPlayingScene">
|
||
<summary>
|
||
Cached name for the 'stop_playing_scene' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.IsPlayingScene">
|
||
<summary>
|
||
Cached name for the 'is_playing_scene' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.GetPlayingScene">
|
||
<summary>
|
||
Cached name for the 'get_playing_scene' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.SetMovieMakerEnabled">
|
||
<summary>
|
||
Cached name for the 'set_movie_maker_enabled' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorInterface.MethodName.IsMovieMakerEnabled">
|
||
<summary>
|
||
Cached name for the 'is_movie_maker_enabled' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorInterface.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorNode3DGizmo">
|
||
<summary>
|
||
<para>Gizmo that is used for providing custom visualization and editing (handles and subgizmos) for <see cref="T:Godot.Node3D"/> objects. Can be overridden to create custom gizmos, but for simple gizmos creating a <see cref="T:Godot.EditorNode3DGizmoPlugin"/> is usually recommended.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo._CommitHandle(System.Int32,System.Boolean,Godot.Variant,System.Boolean)">
|
||
<summary>
|
||
<para>Override this method to commit a handle being edited (handles must have been previously added by <see cref="M:Godot.EditorNode3DGizmo.AddHandles(Godot.Vector3[],Godot.Material,System.Int32[],System.Boolean,System.Boolean)"/>). This usually means creating an <see cref="T:Godot.UndoRedo"/> action for the change, using the current handle value as "do" and the <paramref name="restore"/> argument as "undo".</para>
|
||
<para>If the <paramref name="cancel"/> argument is <see langword="true"/>, the <paramref name="restore"/> value should be directly set, without any <see cref="T:Godot.UndoRedo"/> action.</para>
|
||
<para>The <paramref name="secondary"/> argument is <see langword="true"/> when the committed handle is secondary (see <see cref="M:Godot.EditorNode3DGizmo.AddHandles(Godot.Vector3[],Godot.Material,System.Int32[],System.Boolean,System.Boolean)"/> for more information).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo._CommitSubgizmos(System.Int32[],Godot.Collections.Array{Godot.Transform3D},System.Boolean)">
|
||
<summary>
|
||
<para>Override this method to commit a group of subgizmos being edited (see <see cref="M:Godot.EditorNode3DGizmo._SubgizmosIntersectRay(Godot.Camera3D,Godot.Vector2)"/> and <see cref="M:Godot.EditorNode3DGizmo._SubgizmosIntersectFrustum(Godot.Camera3D,Godot.Collections.Array{Godot.Plane})"/>). This usually means creating an <see cref="T:Godot.UndoRedo"/> action for the change, using the current transforms as "do" and the <paramref name="restores"/> transforms as "undo".</para>
|
||
<para>If the <paramref name="cancel"/> argument is <see langword="true"/>, the <paramref name="restores"/> transforms should be directly set, without any <see cref="T:Godot.UndoRedo"/> action.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo._GetHandleName(System.Int32,System.Boolean)">
|
||
<summary>
|
||
<para>Override this method to return the name of an edited handle (handles must have been previously added by <see cref="M:Godot.EditorNode3DGizmo.AddHandles(Godot.Vector3[],Godot.Material,System.Int32[],System.Boolean,System.Boolean)"/>). Handles can be named for reference to the user when editing.</para>
|
||
<para>The <paramref name="secondary"/> argument is <see langword="true"/> when the requested handle is secondary (see <see cref="M:Godot.EditorNode3DGizmo.AddHandles(Godot.Vector3[],Godot.Material,System.Int32[],System.Boolean,System.Boolean)"/> for more information).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo._GetHandleValue(System.Int32,System.Boolean)">
|
||
<summary>
|
||
<para>Override this method to return the current value of a handle. This value will be requested at the start of an edit and used as the <c>restore</c> argument in <see cref="M:Godot.EditorNode3DGizmo._CommitHandle(System.Int32,System.Boolean,Godot.Variant,System.Boolean)"/>.</para>
|
||
<para>The <paramref name="secondary"/> argument is <see langword="true"/> when the requested handle is secondary (see <see cref="M:Godot.EditorNode3DGizmo.AddHandles(Godot.Vector3[],Godot.Material,System.Int32[],System.Boolean,System.Boolean)"/> for more information).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo._GetSubgizmoTransform(System.Int32)">
|
||
<summary>
|
||
<para>Override this method to return the current transform of a subgizmo. This transform will be requested at the start of an edit and used as the <c>restore</c> argument in <see cref="M:Godot.EditorNode3DGizmo._CommitSubgizmos(System.Int32[],Godot.Collections.Array{Godot.Transform3D},System.Boolean)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo._IsHandleHighlighted(System.Int32,System.Boolean)">
|
||
<summary>
|
||
<para>Override this method to return <see langword="true"/> whenever the given handle should be highlighted in the editor.</para>
|
||
<para>The <paramref name="secondary"/> argument is <see langword="true"/> when the requested handle is secondary (see <see cref="M:Godot.EditorNode3DGizmo.AddHandles(Godot.Vector3[],Godot.Material,System.Int32[],System.Boolean,System.Boolean)"/> for more information).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo._Redraw">
|
||
<summary>
|
||
<para>Override this method to add all the gizmo elements whenever a gizmo update is requested. It's common to call <see cref="M:Godot.EditorNode3DGizmo.Clear"/> at the beginning of this method and then add visual elements depending on the node's properties.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo._SetHandle(System.Int32,System.Boolean,Godot.Camera3D,Godot.Vector2)">
|
||
<summary>
|
||
<para>Override this method to update the node properties when the user drags a gizmo handle (previously added with <see cref="M:Godot.EditorNode3DGizmo.AddHandles(Godot.Vector3[],Godot.Material,System.Int32[],System.Boolean,System.Boolean)"/>). The provided <paramref name="point"/> is the mouse position in screen coordinates and the <paramref name="camera"/> can be used to convert it to raycasts.</para>
|
||
<para>The <paramref name="secondary"/> argument is <see langword="true"/> when the edited handle is secondary (see <see cref="M:Godot.EditorNode3DGizmo.AddHandles(Godot.Vector3[],Godot.Material,System.Int32[],System.Boolean,System.Boolean)"/> for more information).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo._SetSubgizmoTransform(System.Int32,Godot.Transform3D)">
|
||
<summary>
|
||
<para>Override this method to update the node properties during subgizmo editing (see <see cref="M:Godot.EditorNode3DGizmo._SubgizmosIntersectRay(Godot.Camera3D,Godot.Vector2)"/> and <see cref="M:Godot.EditorNode3DGizmo._SubgizmosIntersectFrustum(Godot.Camera3D,Godot.Collections.Array{Godot.Plane})"/>). The <paramref name="transform"/> is given in the <see cref="T:Godot.Node3D"/>'s local coordinate system.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo._SubgizmosIntersectFrustum(Godot.Camera3D,Godot.Collections.Array{Godot.Plane})">
|
||
<summary>
|
||
<para>Override this method to allow selecting subgizmos using mouse drag box selection. Given a <paramref name="camera"/> and a <paramref name="frustum"/>, this method should return which subgizmos are contained within the frustum. The <paramref name="frustum"/> argument consists of an array with all the <see cref="T:Godot.Plane"/>s that make up the selection frustum. The returned value should contain a list of unique subgizmo identifiers, which can have any non-negative value and will be used in other virtual methods like <see cref="M:Godot.EditorNode3DGizmo._GetSubgizmoTransform(System.Int32)"/> or <see cref="M:Godot.EditorNode3DGizmo._CommitSubgizmos(System.Int32[],Godot.Collections.Array{Godot.Transform3D},System.Boolean)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo._SubgizmosIntersectRay(Godot.Camera3D,Godot.Vector2)">
|
||
<summary>
|
||
<para>Override this method to allow selecting subgizmos using mouse clicks. Given a <paramref name="camera"/> and a <paramref name="point"/> in screen coordinates, this method should return which subgizmo should be selected. The returned value should be a unique subgizmo identifier, which can have any non-negative value and will be used in other virtual methods like <see cref="M:Godot.EditorNode3DGizmo._GetSubgizmoTransform(System.Int32)"/> or <see cref="M:Godot.EditorNode3DGizmo._CommitSubgizmos(System.Int32[],Godot.Collections.Array{Godot.Transform3D},System.Boolean)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.AddLines(Godot.Vector3[],Godot.Material,System.Boolean,System.Nullable{Godot.Color})">
|
||
<summary>
|
||
<para>Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this method during <see cref="M:Godot.EditorNode3DGizmo._Redraw"/>.</para>
|
||
</summary>
|
||
<param name="modulate">If the parameter is null, then the default value is <c>new Color(1.0f, 1.0f, 1.0f, 1.0f)</c>.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.AddLines(System.ReadOnlySpan{Godot.Vector3},Godot.Material,System.Boolean,System.Nullable{Godot.Color})">
|
||
<summary>
|
||
<para>Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this method during <see cref="M:Godot.EditorNode3DGizmo._Redraw"/>.</para>
|
||
</summary>
|
||
<param name="modulate">If the parameter is null, then the default value is <c>new Color(1.0f, 1.0f, 1.0f, 1.0f)</c>.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.AddMesh(Godot.Mesh,Godot.Material,System.Nullable{Godot.Transform3D},Godot.SkinReference)">
|
||
<summary>
|
||
<para>Adds a mesh to the gizmo with the specified <paramref name="material"/>, local <paramref name="transform"/> and <paramref name="skeleton"/>. Call this method during <see cref="M:Godot.EditorNode3DGizmo._Redraw"/>.</para>
|
||
</summary>
|
||
<param name="transform">If the parameter is null, then the default value is <c>Transform3D.Identity</c>.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.AddCollisionSegments(Godot.Vector3[])">
|
||
<summary>
|
||
<para>Adds the specified <paramref name="segments"/> to the gizmo's collision shape for picking. Call this method during <see cref="M:Godot.EditorNode3DGizmo._Redraw"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.AddCollisionSegments(System.ReadOnlySpan{Godot.Vector3})">
|
||
<summary>
|
||
<para>Adds the specified <paramref name="segments"/> to the gizmo's collision shape for picking. Call this method during <see cref="M:Godot.EditorNode3DGizmo._Redraw"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.AddCollisionTriangles(Godot.TriangleMesh)">
|
||
<summary>
|
||
<para>Adds collision triangles to the gizmo for picking. A <see cref="T:Godot.TriangleMesh"/> can be generated from a regular <see cref="T:Godot.Mesh"/> too. Call this method during <see cref="M:Godot.EditorNode3DGizmo._Redraw"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.AddUnscaledBillboard(Godot.Material,System.Single,System.Nullable{Godot.Color})">
|
||
<summary>
|
||
<para>Adds an unscaled billboard for visualization and selection. Call this method during <see cref="M:Godot.EditorNode3DGizmo._Redraw"/>.</para>
|
||
</summary>
|
||
<param name="modulate">If the parameter is null, then the default value is <c>new Color(1.0f, 1.0f, 1.0f, 1.0f)</c>.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.AddHandles(Godot.Vector3[],Godot.Material,System.Int32[],System.Boolean,System.Boolean)">
|
||
<summary>
|
||
<para>Adds a list of handles (points) which can be used to edit the properties of the gizmo's <see cref="T:Godot.Node3D"/>. The <paramref name="ids"/> argument can be used to specify a custom identifier for each handle, if an empty array is passed, the ids will be assigned automatically from the <paramref name="handles"/> argument order.</para>
|
||
<para>The <paramref name="secondary"/> argument marks the added handles as secondary, meaning they will normally have lower selection priority than regular handles. When the user is holding the shift key secondary handles will switch to have higher priority than regular handles. This change in priority can be used to place multiple handles at the same point while still giving the user control on their selection.</para>
|
||
<para>There are virtual methods which will be called upon editing of these handles. Call this method during <see cref="M:Godot.EditorNode3DGizmo._Redraw"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.AddHandles(System.ReadOnlySpan{Godot.Vector3},Godot.Material,System.ReadOnlySpan{System.Int32},System.Boolean,System.Boolean)">
|
||
<summary>
|
||
<para>Adds a list of handles (points) which can be used to edit the properties of the gizmo's <see cref="T:Godot.Node3D"/>. The <paramref name="ids"/> argument can be used to specify a custom identifier for each handle, if an empty array is passed, the ids will be assigned automatically from the <paramref name="handles"/> argument order.</para>
|
||
<para>The <paramref name="secondary"/> argument marks the added handles as secondary, meaning they will normally have lower selection priority than regular handles. When the user is holding the shift key secondary handles will switch to have higher priority than regular handles. This change in priority can be used to place multiple handles at the same point while still giving the user control on their selection.</para>
|
||
<para>There are virtual methods which will be called upon editing of these handles. Call this method during <see cref="M:Godot.EditorNode3DGizmo._Redraw"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.SetNode3D(Godot.Node)">
|
||
<summary>
|
||
<para>Sets the reference <see cref="T:Godot.Node3D"/> node for the gizmo. <paramref name="node"/> must inherit from <see cref="T:Godot.Node3D"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.GetNode3D">
|
||
<summary>
|
||
<para>Returns the <see cref="T:Godot.Node3D"/> node associated with this gizmo.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.GetPlugin">
|
||
<summary>
|
||
<para>Returns the <see cref="T:Godot.EditorNode3DGizmoPlugin"/> that owns this gizmo. It's useful to retrieve materials using <see cref="M:Godot.EditorNode3DGizmoPlugin.GetMaterial(System.String,Godot.EditorNode3DGizmo)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.Clear">
|
||
<summary>
|
||
<para>Removes everything in the gizmo including meshes, collisions and handles.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.SetHidden(System.Boolean)">
|
||
<summary>
|
||
<para>Sets the gizmo's hidden state. If <see langword="true"/>, the gizmo will be hidden. If <see langword="false"/>, it will be shown.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.IsSubgizmoSelected(System.Int32)">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if the given subgizmo is currently selected. Can be used to highlight selected elements during <see cref="M:Godot.EditorNode3DGizmo._Redraw"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.GetSubgizmoSelection">
|
||
<summary>
|
||
<para>Returns a list of the currently selected subgizmos. Can be used to highlight selected elements during <see cref="M:Godot.EditorNode3DGizmo._Redraw"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmo.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorNode3DGizmo.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorNode3DGizmo.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName._BeginHandleAction">
|
||
<summary>
|
||
Cached name for the '_begin_handle_action' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName._CommitHandle">
|
||
<summary>
|
||
Cached name for the '_commit_handle' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName._CommitSubgizmos">
|
||
<summary>
|
||
Cached name for the '_commit_subgizmos' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName._GetHandleName">
|
||
<summary>
|
||
Cached name for the '_get_handle_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName._GetHandleValue">
|
||
<summary>
|
||
Cached name for the '_get_handle_value' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName._GetSubgizmoTransform">
|
||
<summary>
|
||
Cached name for the '_get_subgizmo_transform' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName._IsHandleHighlighted">
|
||
<summary>
|
||
Cached name for the '_is_handle_highlighted' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName._Redraw">
|
||
<summary>
|
||
Cached name for the '_redraw' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName._SetHandle">
|
||
<summary>
|
||
Cached name for the '_set_handle' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName._SetSubgizmoTransform">
|
||
<summary>
|
||
Cached name for the '_set_subgizmo_transform' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName._SubgizmosIntersectFrustum">
|
||
<summary>
|
||
Cached name for the '_subgizmos_intersect_frustum' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName._SubgizmosIntersectRay">
|
||
<summary>
|
||
Cached name for the '_subgizmos_intersect_ray' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName.AddLines">
|
||
<summary>
|
||
Cached name for the 'add_lines' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName.AddMesh">
|
||
<summary>
|
||
Cached name for the 'add_mesh' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName.AddCollisionSegments">
|
||
<summary>
|
||
Cached name for the 'add_collision_segments' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName.AddCollisionTriangles">
|
||
<summary>
|
||
Cached name for the 'add_collision_triangles' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName.AddUnscaledBillboard">
|
||
<summary>
|
||
Cached name for the 'add_unscaled_billboard' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName.AddHandles">
|
||
<summary>
|
||
Cached name for the 'add_handles' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName.SetNode3D">
|
||
<summary>
|
||
Cached name for the 'set_node_3d' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName.GetNode3D">
|
||
<summary>
|
||
Cached name for the 'get_node_3d' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName.GetPlugin">
|
||
<summary>
|
||
Cached name for the 'get_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName.Clear">
|
||
<summary>
|
||
Cached name for the 'clear' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName.SetHidden">
|
||
<summary>
|
||
Cached name for the 'set_hidden' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName.IsSubgizmoSelected">
|
||
<summary>
|
||
Cached name for the 'is_subgizmo_selected' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmo.MethodName.GetSubgizmoSelection">
|
||
<summary>
|
||
Cached name for the 'get_subgizmo_selection' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorNode3DGizmo.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorNode3DGizmoPlugin">
|
||
<summary>
|
||
<para><see cref="T:Godot.EditorNode3DGizmoPlugin"/> allows you to define a new type of Gizmo. There are two main ways to do so: extending <see cref="T:Godot.EditorNode3DGizmoPlugin"/> for the simpler gizmos, or creating a new <see cref="T:Godot.EditorNode3DGizmo"/> type. See the tutorial in the documentation for more info.</para>
|
||
<para>To use <see cref="T:Godot.EditorNode3DGizmoPlugin"/>, register it using the <see cref="M:Godot.EditorPlugin.AddNode3DGizmoPlugin(Godot.EditorNode3DGizmoPlugin)"/> method first.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin._CanBeHidden">
|
||
<summary>
|
||
<para>Override this method to define whether the gizmos handled by this plugin can be hidden or not. Returns <see langword="true"/> if not overridden.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin._CommitHandle(Godot.EditorNode3DGizmo,System.Int32,System.Boolean,Godot.Variant,System.Boolean)">
|
||
<summary>
|
||
<para>Override this method to commit a handle being edited (handles must have been previously added by <see cref="M:Godot.EditorNode3DGizmo.AddHandles(Godot.Vector3[],Godot.Material,System.Int32[],System.Boolean,System.Boolean)"/> during <see cref="M:Godot.EditorNode3DGizmoPlugin._Redraw(Godot.EditorNode3DGizmo)"/>). This usually means creating an <see cref="T:Godot.UndoRedo"/> action for the change, using the current handle value as "do" and the <paramref name="restore"/> argument as "undo".</para>
|
||
<para>If the <paramref name="cancel"/> argument is <see langword="true"/>, the <paramref name="restore"/> value should be directly set, without any <see cref="T:Godot.UndoRedo"/> action.</para>
|
||
<para>The <paramref name="secondary"/> argument is <see langword="true"/> when the committed handle is secondary (see <see cref="M:Godot.EditorNode3DGizmo.AddHandles(Godot.Vector3[],Godot.Material,System.Int32[],System.Boolean,System.Boolean)"/> for more information).</para>
|
||
<para>Called for this plugin's active gizmos.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin._CommitSubgizmos(Godot.EditorNode3DGizmo,System.Int32[],Godot.Collections.Array{Godot.Transform3D},System.Boolean)">
|
||
<summary>
|
||
<para>Override this method to commit a group of subgizmos being edited (see <see cref="M:Godot.EditorNode3DGizmoPlugin._SubgizmosIntersectRay(Godot.EditorNode3DGizmo,Godot.Camera3D,Godot.Vector2)"/> and <see cref="M:Godot.EditorNode3DGizmoPlugin._SubgizmosIntersectFrustum(Godot.EditorNode3DGizmo,Godot.Camera3D,Godot.Collections.Array{Godot.Plane})"/>). This usually means creating an <see cref="T:Godot.UndoRedo"/> action for the change, using the current transforms as "do" and the <paramref name="restores"/> transforms as "undo".</para>
|
||
<para>If the <paramref name="cancel"/> argument is <see langword="true"/>, the <paramref name="restores"/> transforms should be directly set, without any <see cref="T:Godot.UndoRedo"/> action. As with all subgizmo methods, transforms are given in local space respect to the gizmo's Node3D. Called for this plugin's active gizmos.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin._CreateGizmo(Godot.Node3D)">
|
||
<summary>
|
||
<para>Override this method to return a custom <see cref="T:Godot.EditorNode3DGizmo"/> for the 3D nodes of your choice, return <see langword="null"/> for the rest of nodes. See also <see cref="M:Godot.EditorNode3DGizmoPlugin._HasGizmo(Godot.Node3D)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin._GetGizmoName">
|
||
<summary>
|
||
<para>Override this method to provide the name that will appear in the gizmo visibility menu.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin._GetHandleName(Godot.EditorNode3DGizmo,System.Int32,System.Boolean)">
|
||
<summary>
|
||
<para>Override this method to provide gizmo's handle names. The <paramref name="secondary"/> argument is <see langword="true"/> when the requested handle is secondary (see <see cref="M:Godot.EditorNode3DGizmo.AddHandles(Godot.Vector3[],Godot.Material,System.Int32[],System.Boolean,System.Boolean)"/> for more information). Called for this plugin's active gizmos.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin._GetHandleValue(Godot.EditorNode3DGizmo,System.Int32,System.Boolean)">
|
||
<summary>
|
||
<para>Override this method to return the current value of a handle. This value will be requested at the start of an edit and used as the <c>restore</c> argument in <see cref="M:Godot.EditorNode3DGizmoPlugin._CommitHandle(Godot.EditorNode3DGizmo,System.Int32,System.Boolean,Godot.Variant,System.Boolean)"/>.</para>
|
||
<para>The <paramref name="secondary"/> argument is <see langword="true"/> when the requested handle is secondary (see <see cref="M:Godot.EditorNode3DGizmo.AddHandles(Godot.Vector3[],Godot.Material,System.Int32[],System.Boolean,System.Boolean)"/> for more information).</para>
|
||
<para>Called for this plugin's active gizmos.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin._GetPriority">
|
||
<summary>
|
||
<para>Override this method to set the gizmo's priority. Gizmos with higher priority will have precedence when processing inputs like handles or subgizmos selection.</para>
|
||
<para>All built-in editor gizmos return a priority of <c>-1</c>. If not overridden, this method will return <c>0</c>, which means custom gizmos will automatically get higher priority than built-in gizmos.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin._GetSubgizmoTransform(Godot.EditorNode3DGizmo,System.Int32)">
|
||
<summary>
|
||
<para>Override this method to return the current transform of a subgizmo. As with all subgizmo methods, the transform should be in local space respect to the gizmo's Node3D. This transform will be requested at the start of an edit and used in the <c>restore</c> argument in <see cref="M:Godot.EditorNode3DGizmoPlugin._CommitSubgizmos(Godot.EditorNode3DGizmo,System.Int32[],Godot.Collections.Array{Godot.Transform3D},System.Boolean)"/>. Called for this plugin's active gizmos.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin._HasGizmo(Godot.Node3D)">
|
||
<summary>
|
||
<para>Override this method to define which Node3D nodes have a gizmo from this plugin. Whenever a <see cref="T:Godot.Node3D"/> node is added to a scene this method is called, if it returns <see langword="true"/> the node gets a generic <see cref="T:Godot.EditorNode3DGizmo"/> assigned and is added to this plugin's list of active gizmos.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin._IsHandleHighlighted(Godot.EditorNode3DGizmo,System.Int32,System.Boolean)">
|
||
<summary>
|
||
<para>Override this method to return <see langword="true"/> whenever to given handle should be highlighted in the editor. The <paramref name="secondary"/> argument is <see langword="true"/> when the requested handle is secondary (see <see cref="M:Godot.EditorNode3DGizmo.AddHandles(Godot.Vector3[],Godot.Material,System.Int32[],System.Boolean,System.Boolean)"/> for more information). Called for this plugin's active gizmos.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin._IsSelectableWhenHidden">
|
||
<summary>
|
||
<para>Override this method to define whether Node3D with this gizmo should be selectable even when the gizmo is hidden.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin._Redraw(Godot.EditorNode3DGizmo)">
|
||
<summary>
|
||
<para>Override this method to add all the gizmo elements whenever a gizmo update is requested. It's common to call <see cref="M:Godot.EditorNode3DGizmo.Clear"/> at the beginning of this method and then add visual elements depending on the node's properties.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin._SetHandle(Godot.EditorNode3DGizmo,System.Int32,System.Boolean,Godot.Camera3D,Godot.Vector2)">
|
||
<summary>
|
||
<para>Override this method to update the node's properties when the user drags a gizmo handle (previously added with <see cref="M:Godot.EditorNode3DGizmo.AddHandles(Godot.Vector3[],Godot.Material,System.Int32[],System.Boolean,System.Boolean)"/>). The provided <paramref name="screenPos"/> is the mouse position in screen coordinates and the <paramref name="camera"/> can be used to convert it to raycasts.</para>
|
||
<para>The <paramref name="secondary"/> argument is <see langword="true"/> when the edited handle is secondary (see <see cref="M:Godot.EditorNode3DGizmo.AddHandles(Godot.Vector3[],Godot.Material,System.Int32[],System.Boolean,System.Boolean)"/> for more information).</para>
|
||
<para>Called for this plugin's active gizmos.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin._SetSubgizmoTransform(Godot.EditorNode3DGizmo,System.Int32,Godot.Transform3D)">
|
||
<summary>
|
||
<para>Override this method to update the node properties during subgizmo editing (see <see cref="M:Godot.EditorNode3DGizmoPlugin._SubgizmosIntersectRay(Godot.EditorNode3DGizmo,Godot.Camera3D,Godot.Vector2)"/> and <see cref="M:Godot.EditorNode3DGizmoPlugin._SubgizmosIntersectFrustum(Godot.EditorNode3DGizmo,Godot.Camera3D,Godot.Collections.Array{Godot.Plane})"/>). The <paramref name="transform"/> is given in the Node3D's local coordinate system. Called for this plugin's active gizmos.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin._SubgizmosIntersectFrustum(Godot.EditorNode3DGizmo,Godot.Camera3D,Godot.Collections.Array{Godot.Plane})">
|
||
<summary>
|
||
<para>Override this method to allow selecting subgizmos using mouse drag box selection. Given a <paramref name="camera"/> and <paramref name="frustumPlanes"/>, this method should return which subgizmos are contained within the frustums. The <paramref name="frustumPlanes"/> argument consists of an array with all the <see cref="T:Godot.Plane"/>s that make up the selection frustum. The returned value should contain a list of unique subgizmo identifiers, these identifiers can have any non-negative value and will be used in other virtual methods like <see cref="M:Godot.EditorNode3DGizmoPlugin._GetSubgizmoTransform(Godot.EditorNode3DGizmo,System.Int32)"/> or <see cref="M:Godot.EditorNode3DGizmoPlugin._CommitSubgizmos(Godot.EditorNode3DGizmo,System.Int32[],Godot.Collections.Array{Godot.Transform3D},System.Boolean)"/>. Called for this plugin's active gizmos.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin._SubgizmosIntersectRay(Godot.EditorNode3DGizmo,Godot.Camera3D,Godot.Vector2)">
|
||
<summary>
|
||
<para>Override this method to allow selecting subgizmos using mouse clicks. Given a <paramref name="camera"/> and a <paramref name="screenPos"/> in screen coordinates, this method should return which subgizmo should be selected. The returned value should be a unique subgizmo identifier, which can have any non-negative value and will be used in other virtual methods like <see cref="M:Godot.EditorNode3DGizmoPlugin._GetSubgizmoTransform(Godot.EditorNode3DGizmo,System.Int32)"/> or <see cref="M:Godot.EditorNode3DGizmoPlugin._CommitSubgizmos(Godot.EditorNode3DGizmo,System.Int32[],Godot.Collections.Array{Godot.Transform3D},System.Boolean)"/>. Called for this plugin's active gizmos.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin.CreateMaterial(System.String,Godot.Color,System.Boolean,System.Boolean,System.Boolean)">
|
||
<summary>
|
||
<para>Creates an unshaded material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with <see cref="M:Godot.EditorNode3DGizmoPlugin.GetMaterial(System.String,Godot.EditorNode3DGizmo)"/> and used in <see cref="M:Godot.EditorNode3DGizmo.AddMesh(Godot.Mesh,Godot.Material,System.Nullable{Godot.Transform3D},Godot.SkinReference)"/> and <see cref="M:Godot.EditorNode3DGizmo.AddLines(Godot.Vector3[],Godot.Material,System.Boolean,System.Nullable{Godot.Color})"/>. Should not be overridden.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin.CreateIconMaterial(System.String,Godot.Texture2D,System.Boolean,System.Nullable{Godot.Color})">
|
||
<summary>
|
||
<para>Creates an icon material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with <see cref="M:Godot.EditorNode3DGizmoPlugin.GetMaterial(System.String,Godot.EditorNode3DGizmo)"/> and used in <see cref="M:Godot.EditorNode3DGizmo.AddUnscaledBillboard(Godot.Material,System.Single,System.Nullable{Godot.Color})"/>. Should not be overridden.</para>
|
||
</summary>
|
||
<param name="color">If the parameter is null, then the default value is <c>new Color(1.0f, 1.0f, 1.0f, 1.0f)</c>.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin.CreateHandleMaterial(System.String,System.Boolean,Godot.Texture2D)">
|
||
<summary>
|
||
<para>Creates a handle material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with <see cref="M:Godot.EditorNode3DGizmoPlugin.GetMaterial(System.String,Godot.EditorNode3DGizmo)"/> and used in <see cref="M:Godot.EditorNode3DGizmo.AddHandles(Godot.Vector3[],Godot.Material,System.Int32[],System.Boolean,System.Boolean)"/>. Should not be overridden.</para>
|
||
<para>You can optionally provide a texture to use instead of the default icon.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin.AddMaterial(System.String,Godot.StandardMaterial3D)">
|
||
<summary>
|
||
<para>Adds a new material to the internal material list for the plugin. It can then be accessed with <see cref="M:Godot.EditorNode3DGizmoPlugin.GetMaterial(System.String,Godot.EditorNode3DGizmo)"/>. Should not be overridden.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin.GetMaterial(System.String,Godot.EditorNode3DGizmo)">
|
||
<summary>
|
||
<para>Gets material from the internal list of materials. If an <see cref="T:Godot.EditorNode3DGizmo"/> is provided, it will try to get the corresponding variant (selected and/or editable).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorNode3DGizmoPlugin.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorNode3DGizmoPlugin.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorNode3DGizmoPlugin.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._BeginHandleAction">
|
||
<summary>
|
||
Cached name for the '_begin_handle_action' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._CanBeHidden">
|
||
<summary>
|
||
Cached name for the '_can_be_hidden' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._CommitHandle">
|
||
<summary>
|
||
Cached name for the '_commit_handle' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._CommitSubgizmos">
|
||
<summary>
|
||
Cached name for the '_commit_subgizmos' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._CreateGizmo">
|
||
<summary>
|
||
Cached name for the '_create_gizmo' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._GetGizmoName">
|
||
<summary>
|
||
Cached name for the '_get_gizmo_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._GetHandleName">
|
||
<summary>
|
||
Cached name for the '_get_handle_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._GetHandleValue">
|
||
<summary>
|
||
Cached name for the '_get_handle_value' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._GetPriority">
|
||
<summary>
|
||
Cached name for the '_get_priority' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._GetSubgizmoTransform">
|
||
<summary>
|
||
Cached name for the '_get_subgizmo_transform' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._HasGizmo">
|
||
<summary>
|
||
Cached name for the '_has_gizmo' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._IsHandleHighlighted">
|
||
<summary>
|
||
Cached name for the '_is_handle_highlighted' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._IsSelectableWhenHidden">
|
||
<summary>
|
||
Cached name for the '_is_selectable_when_hidden' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._Redraw">
|
||
<summary>
|
||
Cached name for the '_redraw' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._SetHandle">
|
||
<summary>
|
||
Cached name for the '_set_handle' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._SetSubgizmoTransform">
|
||
<summary>
|
||
Cached name for the '_set_subgizmo_transform' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._SubgizmosIntersectFrustum">
|
||
<summary>
|
||
Cached name for the '_subgizmos_intersect_frustum' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName._SubgizmosIntersectRay">
|
||
<summary>
|
||
Cached name for the '_subgizmos_intersect_ray' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName.CreateMaterial">
|
||
<summary>
|
||
Cached name for the 'create_material' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName.CreateIconMaterial">
|
||
<summary>
|
||
Cached name for the 'create_icon_material' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName.CreateHandleMaterial">
|
||
<summary>
|
||
Cached name for the 'create_handle_material' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName.AddMaterial">
|
||
<summary>
|
||
Cached name for the 'add_material' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorNode3DGizmoPlugin.MethodName.GetMaterial">
|
||
<summary>
|
||
Cached name for the 'get_material' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorNode3DGizmoPlugin.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorPaths">
|
||
<summary>
|
||
<para>This editor-only singleton returns OS-specific paths to various data folders and files. It can be used in editor plugins to ensure files are saved in the correct location on each operating system.</para>
|
||
<para><b>Note:</b> This singleton is not accessible in exported projects. Attempting to access it in an exported project will result in a script error as the singleton won't be declared. To prevent script errors in exported projects, use <see cref="M:Godot.Engine.HasSingleton(Godot.StringName)"/> to check whether the singleton is available before using it.</para>
|
||
<para><b>Note:</b> On the Linux/BSD platform, Godot complies with the <a href="https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG Base Directory Specification</a>. You can override environment variables following the specification to change the editor and project data paths.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPaths.GetDataDir">
|
||
<summary>
|
||
<para>Returns the absolute path to the user's data folder. This folder should be used for <i>persistent</i> user data files such as installed export templates.</para>
|
||
<para><b>Default paths per platform:</b></para>
|
||
<para><code>
|
||
- Windows: %APPDATA%\Godot\ (same as `get_config_dir()`)
|
||
- macOS: ~/Library/Application Support/Godot/ (same as `get_config_dir()`)
|
||
- Linux: ~/.local/share/godot/
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPaths.GetConfigDir">
|
||
<summary>
|
||
<para>Returns the absolute path to the user's configuration folder. This folder should be used for <i>persistent</i> user configuration files.</para>
|
||
<para><b>Default paths per platform:</b></para>
|
||
<para><code>
|
||
- Windows: %APPDATA%\Godot\ (same as `get_data_dir()`)
|
||
- macOS: ~/Library/Application Support/Godot/ (same as `get_data_dir()`)
|
||
- Linux: ~/.config/godot/
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPaths.GetCacheDir">
|
||
<summary>
|
||
<para>Returns the absolute path to the user's cache folder. This folder should be used for temporary data that can be removed safely whenever the editor is closed (such as generated resource thumbnails).</para>
|
||
<para><b>Default paths per platform:</b></para>
|
||
<para><code>
|
||
- Windows: %LOCALAPPDATA%\Godot\
|
||
- macOS: ~/Library/Caches/Godot/
|
||
- Linux: ~/.cache/godot/
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPaths.IsSelfContained">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if the editor is marked as self-contained, <see langword="false"/> otherwise. When self-contained mode is enabled, user configuration, data and cache files are saved in an <c>editor_data/</c> folder next to the editor binary. This makes portable usage easier and ensures the Godot editor minimizes file writes outside its own folder. Self-contained mode is not available for exported projects.</para>
|
||
<para>Self-contained mode can be enabled by creating a file named <c>._sc_</c> or <c>_sc_</c> in the same folder as the editor binary or macOS .app bundle while the editor is not running. See also <see cref="M:Godot.EditorPaths.GetSelfContainedFile"/>.</para>
|
||
<para><b>Note:</b> On macOS, quarantine flag should be manually removed before using self-contained mode, see <a href="https://docs.godotengine.org/en/stable/tutorials/export/running_on_macos.html">Running on macOS</a>.</para>
|
||
<para><b>Note:</b> On macOS, placing <c>_sc_</c> or any other file inside .app bundle will break digital signature and make it non-portable, consider placing it in the same folder as the .app bundle instead.</para>
|
||
<para><b>Note:</b> The Steam release of Godot uses self-contained mode by default.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPaths.GetSelfContainedFile">
|
||
<summary>
|
||
<para>Returns the absolute path to the self-contained file that makes the current Godot editor instance be considered as self-contained. Returns an empty string if the current Godot editor instance isn't self-contained. See also <see cref="M:Godot.EditorPaths.IsSelfContained"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPaths.GetProjectSettingsDir">
|
||
<summary>
|
||
<para>Returns the project-specific editor settings path. Projects all have a unique subdirectory inside the settings path where project-specific editor settings are saved.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPaths.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorPaths.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorPaths.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorPaths.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorPaths.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPaths.MethodName.GetDataDir">
|
||
<summary>
|
||
Cached name for the 'get_data_dir' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPaths.MethodName.GetConfigDir">
|
||
<summary>
|
||
Cached name for the 'get_config_dir' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPaths.MethodName.GetCacheDir">
|
||
<summary>
|
||
Cached name for the 'get_cache_dir' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPaths.MethodName.IsSelfContained">
|
||
<summary>
|
||
Cached name for the 'is_self_contained' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPaths.MethodName.GetSelfContainedFile">
|
||
<summary>
|
||
Cached name for the 'get_self_contained_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPaths.MethodName.GetProjectSettingsDir">
|
||
<summary>
|
||
Cached name for the 'get_project_settings_dir' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorPaths.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorPlugin">
|
||
<summary>
|
||
<para>Plugins are used by the editor to extend functionality. The most common types of plugins are those which edit a given node or resource type, import plugins and export plugins. See also <see cref="T:Godot.EditorScript"/> to add functions to the editor.</para>
|
||
<para><b>Note:</b> Some names in this class contain "left" or "right" (e.g. <see cref="F:Godot.EditorPlugin.DockSlot.LeftUl"/>). These APIs assume left-to-right layout, and would be backwards when using right-to-left layout. These names are kept for compatibility reasons.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.CustomControlContainer.Toolbar">
|
||
<summary>
|
||
<para>Main editor toolbar, next to play buttons.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.CustomControlContainer.SpatialEditorMenu">
|
||
<summary>
|
||
<para>The toolbar that appears when 3D editor is active.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.CustomControlContainer.SpatialEditorSideLeft">
|
||
<summary>
|
||
<para>Left sidebar of the 3D editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.CustomControlContainer.SpatialEditorSideRight">
|
||
<summary>
|
||
<para>Right sidebar of the 3D editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.CustomControlContainer.SpatialEditorBottom">
|
||
<summary>
|
||
<para>Bottom panel of the 3D editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.CustomControlContainer.CanvasEditorMenu">
|
||
<summary>
|
||
<para>The toolbar that appears when 2D editor is active.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.CustomControlContainer.CanvasEditorSideLeft">
|
||
<summary>
|
||
<para>Left sidebar of the 2D editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.CustomControlContainer.CanvasEditorSideRight">
|
||
<summary>
|
||
<para>Right sidebar of the 2D editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.CustomControlContainer.CanvasEditorBottom">
|
||
<summary>
|
||
<para>Bottom panel of the 2D editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.CustomControlContainer.InspectorBottom">
|
||
<summary>
|
||
<para>Bottom section of the inspector.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.CustomControlContainer.ProjectSettingTabLeft">
|
||
<summary>
|
||
<para>Tab of Project Settings dialog, to the left of other tabs.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.CustomControlContainer.ProjectSettingTabRight">
|
||
<summary>
|
||
<para>Tab of Project Settings dialog, to the right of other tabs.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.DockSlot.LeftUl">
|
||
<summary>
|
||
<para>Dock slot, left side, upper-left (empty in default layout).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.DockSlot.LeftBl">
|
||
<summary>
|
||
<para>Dock slot, left side, bottom-left (empty in default layout).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.DockSlot.LeftUr">
|
||
<summary>
|
||
<para>Dock slot, left side, upper-right (in default layout includes Scene and Import docks).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.DockSlot.LeftBr">
|
||
<summary>
|
||
<para>Dock slot, left side, bottom-right (in default layout includes FileSystem dock).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.DockSlot.RightUl">
|
||
<summary>
|
||
<para>Dock slot, right side, upper-left (in default layout includes Inspector, Node, and History docks).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.DockSlot.RightBl">
|
||
<summary>
|
||
<para>Dock slot, right side, bottom-left (empty in default layout).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.DockSlot.RightUr">
|
||
<summary>
|
||
<para>Dock slot, right side, upper-right (empty in default layout).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.DockSlot.RightBr">
|
||
<summary>
|
||
<para>Dock slot, right side, bottom-right (empty in default layout).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.DockSlot.Max">
|
||
<summary>
|
||
<para>Represents the size of the <see cref="T:Godot.EditorPlugin.DockSlot"/> enum.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.AfterGuiInput.Pass">
|
||
<summary>
|
||
<para>Forwards the <see cref="T:Godot.InputEvent"/> to other EditorPlugins.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.AfterGuiInput.Stop">
|
||
<summary>
|
||
<para>Prevents the <see cref="T:Godot.InputEvent"/> from reaching other Editor classes.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.AfterGuiInput.Custom">
|
||
<summary>
|
||
<para>Pass the <see cref="T:Godot.InputEvent"/> to other editor plugins except the main <see cref="T:Godot.Node3D"/> one. This can be used to prevent node selection changes and work with sub-gizmos instead.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._ApplyChanges">
|
||
<summary>
|
||
<para>This method is called when the editor is about to save the project, switch to another tab, etc. It asks the plugin to apply any pending state changes to ensure consistency.</para>
|
||
<para>This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._Build">
|
||
<summary>
|
||
<para>This method is called when the editor is about to run the project. The plugin can then perform required operations before the project runs.</para>
|
||
<para>This method must return a boolean. If this method returns <see langword="false"/>, the project will not run. The run is aborted immediately, so this also prevents all other plugins' <see cref="M:Godot.EditorPlugin._Build"/> methods from running.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._Clear">
|
||
<summary>
|
||
<para>Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._DisablePlugin">
|
||
<summary>
|
||
<para>Called by the engine when the user disables the <see cref="T:Godot.EditorPlugin"/> in the Plugin tab of the project settings window.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._Edit(Godot.GodotObject)">
|
||
<summary>
|
||
<para>This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object.</para>
|
||
<para><paramref name="object"/> can be <see langword="null"/> if the plugin was editing an object, but there is no longer any selected object handled by this plugin. It can be used to cleanup editing state.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._EnablePlugin">
|
||
<summary>
|
||
<para>Called by the engine when the user enables the <see cref="T:Godot.EditorPlugin"/> in the Plugin tab of the project settings window.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._Forward3DDrawOverViewport(Godot.Control)">
|
||
<summary>
|
||
<para>Called by the engine when the 3D editor's viewport is updated. Use the <c>overlay</c> <see cref="T:Godot.Control"/> for drawing. You can update the viewport manually by calling <see cref="M:Godot.EditorPlugin.UpdateOverlays"/>.</para>
|
||
<para><code>
|
||
public override void _Forward3DDrawOverViewport(Control viewportControl)
|
||
{
|
||
// Draw a circle at cursor position.
|
||
viewportControl.DrawCircle(viewportControl.GetLocalMousePosition(), 64, Colors.White);
|
||
}
|
||
|
||
public override EditorPlugin.AfterGuiInput _Forward3DGuiInput(Camera3D viewportCamera, InputEvent @event)
|
||
{
|
||
if (@event is InputEventMouseMotion)
|
||
{
|
||
// Redraw viewport when cursor is moved.
|
||
UpdateOverlays();
|
||
return EditorPlugin.AfterGuiInput.Stop;
|
||
}
|
||
return EditorPlugin.AfterGuiInput.Pass;
|
||
}
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._Forward3DForceDrawOverViewport(Godot.Control)">
|
||
<summary>
|
||
<para>This method is the same as <see cref="M:Godot.EditorPlugin._Forward3DDrawOverViewport(Godot.Control)"/>, except it draws on top of everything. Useful when you need an extra layer that shows over anything else.</para>
|
||
<para>You need to enable calling of this method by using <see cref="M:Godot.EditorPlugin.SetForceDrawOverForwardingEnabled"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._Forward3DGuiInput(Godot.Camera3D,Godot.InputEvent)">
|
||
<summary>
|
||
<para>Called when there is a root node in the current edited scene, <see cref="M:Godot.EditorPlugin._Handles(Godot.GodotObject)"/> is implemented, and an <see cref="T:Godot.InputEvent"/> happens in the 3D viewport. The return value decides whether the <see cref="T:Godot.InputEvent"/> is consumed or forwarded to other <see cref="T:Godot.EditorPlugin"/>s. See <see cref="T:Godot.EditorPlugin.AfterGuiInput"/> for options.</para>
|
||
<para><code>
|
||
// Prevents the InputEvent from reaching other Editor classes.
|
||
public override EditorPlugin.AfterGuiInput _Forward3DGuiInput(Camera3D camera, InputEvent @event)
|
||
{
|
||
return EditorPlugin.AfterGuiInput.Stop;
|
||
}
|
||
</code></para>
|
||
<para>This method must return <see cref="F:Godot.EditorPlugin.AfterGuiInput.Pass"/> in order to forward the <see cref="T:Godot.InputEvent"/> to other Editor classes.</para>
|
||
<para><code>
|
||
// Consumes InputEventMouseMotion and forwards other InputEvent types.
|
||
public override EditorPlugin.AfterGuiInput _Forward3DGuiInput(Camera3D camera, InputEvent @event)
|
||
{
|
||
return @event is InputEventMouseMotion ? EditorPlugin.AfterGuiInput.Stop : EditorPlugin.AfterGuiInput.Pass;
|
||
}
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._ForwardCanvasDrawOverViewport(Godot.Control)">
|
||
<summary>
|
||
<para>Called by the engine when the 2D editor's viewport is updated. Use the <c>overlay</c> <see cref="T:Godot.Control"/> for drawing. You can update the viewport manually by calling <see cref="M:Godot.EditorPlugin.UpdateOverlays"/>.</para>
|
||
<para><code>
|
||
public override void _ForwardCanvasDrawOverViewport(Control viewportControl)
|
||
{
|
||
// Draw a circle at cursor position.
|
||
viewportControl.DrawCircle(viewportControl.GetLocalMousePosition(), 64, Colors.White);
|
||
}
|
||
|
||
public override bool _ForwardCanvasGuiInput(InputEvent @event)
|
||
{
|
||
if (@event is InputEventMouseMotion)
|
||
{
|
||
// Redraw viewport when cursor is moved.
|
||
UpdateOverlays();
|
||
return true;
|
||
}
|
||
return false;
|
||
}
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._ForwardCanvasForceDrawOverViewport(Godot.Control)">
|
||
<summary>
|
||
<para>This method is the same as <see cref="M:Godot.EditorPlugin._ForwardCanvasDrawOverViewport(Godot.Control)"/>, except it draws on top of everything. Useful when you need an extra layer that shows over anything else.</para>
|
||
<para>You need to enable calling of this method by using <see cref="M:Godot.EditorPlugin.SetForceDrawOverForwardingEnabled"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._ForwardCanvasGuiInput(Godot.InputEvent)">
|
||
<summary>
|
||
<para>Called when there is a root node in the current edited scene, <see cref="M:Godot.EditorPlugin._Handles(Godot.GodotObject)"/> is implemented, and an <see cref="T:Godot.InputEvent"/> happens in the 2D viewport. If this method returns <see langword="true"/>, <paramref name="event"/> is intercepted by this <see cref="T:Godot.EditorPlugin"/>, otherwise <paramref name="event"/> is forwarded to other Editor classes.</para>
|
||
<para><code>
|
||
// Prevents the InputEvent from reaching other Editor classes.
|
||
public override bool ForwardCanvasGuiInput(InputEvent @event)
|
||
{
|
||
return true;
|
||
}
|
||
</code></para>
|
||
<para>This method must return <see langword="false"/> in order to forward the <see cref="T:Godot.InputEvent"/> to other Editor classes.</para>
|
||
<para><code>
|
||
// Consumes InputEventMouseMotion and forwards other InputEvent types.
|
||
public override bool _ForwardCanvasGuiInput(InputEvent @event)
|
||
{
|
||
if (@event is InputEventMouseMotion)
|
||
{
|
||
return true;
|
||
}
|
||
return false;
|
||
}
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._GetBreakpoints">
|
||
<summary>
|
||
<para>This is for editors that edit script-based objects. You can return a list of breakpoints in the format (<c>script:line</c>), for example: <c>res://path_to_script.gd:25</c>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._GetPluginIcon">
|
||
<summary>
|
||
<para>Override this method in your plugin to return a <see cref="T:Godot.Texture2D"/> in order to give it an icon.</para>
|
||
<para>For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons.</para>
|
||
<para>Ideally, the plugin icon should be white with a transparent background and 16×16 pixels in size.</para>
|
||
<para><code>
|
||
public override Texture2D _GetPluginIcon()
|
||
{
|
||
// You can use a custom icon:
|
||
return ResourceLoader.Load<Texture2D>("res://addons/my_plugin/my_plugin_icon.svg");
|
||
// Or use a built-in icon:
|
||
return EditorInterface.Singleton.GetEditorTheme().GetIcon("Node", "EditorIcons");
|
||
}
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._GetPluginName">
|
||
<summary>
|
||
<para>Override this method in your plugin to provide the name of the plugin when displayed in the Godot editor.</para>
|
||
<para>For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._GetState">
|
||
<summary>
|
||
<para>Override this method to provide a state data you want to be saved, like view position, grid settings, folding, etc. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns). This data is automatically saved for each scene in an <c>editstate</c> file in the editor metadata folder. If you want to store global (scene-independent) editor data for your plugin, you can use <see cref="M:Godot.EditorPlugin._GetWindowLayout(Godot.ConfigFile)"/> instead.</para>
|
||
<para>Use <see cref="M:Godot.EditorPlugin._SetState(Godot.Collections.Dictionary)"/> to restore your saved state.</para>
|
||
<para><b>Note:</b> This method should not be used to save important settings that should persist with the project.</para>
|
||
<para><b>Note:</b> You must implement <see cref="M:Godot.EditorPlugin._GetPluginName"/> for the state to be stored and restored correctly.</para>
|
||
<para><code>
|
||
func _get_state():
|
||
var state = {"zoom": zoom, "preferred_color": my_color}
|
||
return state
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._GetUnsavedStatus(System.String)">
|
||
<summary>
|
||
<para>Override this method to provide a custom message that lists unsaved changes. The editor will call this method when exiting or when closing a scene, and display the returned string in a confirmation dialog. Return empty string if the plugin has no unsaved changes.</para>
|
||
<para>When closing a scene, <paramref name="forScene"/> is the path to the scene being closed. You can use it to handle built-in resources in that scene.</para>
|
||
<para>If the user confirms saving, <see cref="M:Godot.EditorPlugin._SaveExternalData"/> will be called, before closing the editor.</para>
|
||
<para><code>
|
||
func _get_unsaved_status(for_scene):
|
||
if not unsaved:
|
||
return ""
|
||
|
||
if for_scene.is_empty():
|
||
return "Save changes in MyCustomPlugin before closing?"
|
||
else:
|
||
return "Scene %s has changes from MyCustomPlugin. Save before closing?" % for_scene.get_file()
|
||
|
||
func _save_external_data():
|
||
unsaved = false
|
||
</code></para>
|
||
<para>If the plugin has no scene-specific changes, you can ignore the calls when closing scenes:</para>
|
||
<para><code>
|
||
func _get_unsaved_status(for_scene):
|
||
if not for_scene.is_empty():
|
||
return ""
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._GetWindowLayout(Godot.ConfigFile)">
|
||
<summary>
|
||
<para>Override this method to provide the GUI layout of the plugin or any other data you want to be stored. This is used to save the project's editor layout when <see cref="M:Godot.EditorPlugin.QueueSaveLayout"/> is called or the editor layout was changed (for example changing the position of a dock). The data is stored in the <c>editor_layout.cfg</c> file in the editor metadata directory.</para>
|
||
<para>Use <see cref="M:Godot.EditorPlugin._SetWindowLayout(Godot.ConfigFile)"/> to restore your saved layout.</para>
|
||
<para><code>
|
||
func _get_window_layout(configuration):
|
||
configuration.set_value("MyPlugin", "window_position", $Window.position)
|
||
configuration.set_value("MyPlugin", "icon_color", $Icon.modulate)
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._Handles(Godot.GodotObject)">
|
||
<summary>
|
||
<para>Implement this function if your plugin edits a specific type of object (Resource or Node). If you return <see langword="true"/>, then you will get the functions <see cref="M:Godot.EditorPlugin._Edit(Godot.GodotObject)"/> and <see cref="M:Godot.EditorPlugin._MakeVisible(System.Boolean)"/> called when the editor requests them. If you have declared the methods <see cref="M:Godot.EditorPlugin._ForwardCanvasGuiInput(Godot.InputEvent)"/> and <see cref="M:Godot.EditorPlugin._Forward3DGuiInput(Godot.Camera3D,Godot.InputEvent)"/> these will be called too.</para>
|
||
<para><b>Note:</b> Each plugin should handle only one type of objects at a time. If a plugin handles more types of objects and they are edited at the same time, it will result in errors.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._HasMainScreen">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if this is a main screen editor plugin (it goes in the workspace selector together with <b>2D</b>, <b>3D</b>, <b>Script</b> and <b>AssetLib</b>).</para>
|
||
<para>When the plugin's workspace is selected, other main screen plugins will be hidden, but your plugin will not appear automatically. It needs to be added as a child of <see cref="M:Godot.EditorInterface.GetEditorMainScreen"/> and made visible inside <see cref="M:Godot.EditorPlugin._MakeVisible(System.Boolean)"/>.</para>
|
||
<para>Use <see cref="M:Godot.EditorPlugin._GetPluginName"/> and <see cref="M:Godot.EditorPlugin._GetPluginIcon"/> to customize the plugin button's appearance.</para>
|
||
<para><code>
|
||
var plugin_control
|
||
|
||
func _enter_tree():
|
||
plugin_control = preload("my_plugin_control.tscn").instantiate()
|
||
EditorInterface.get_editor_main_screen().add_child(plugin_control)
|
||
plugin_control.hide()
|
||
|
||
func _has_main_screen():
|
||
return true
|
||
|
||
func _make_visible(visible):
|
||
plugin_control.visible = visible
|
||
|
||
func _get_plugin_name():
|
||
return "My Super Cool Plugin 3000"
|
||
|
||
func _get_plugin_icon():
|
||
return EditorInterface.get_editor_theme().get_icon("Node", "EditorIcons")
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._MakeVisible(System.Boolean)">
|
||
<summary>
|
||
<para>This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type.</para>
|
||
<para>Remember that you have to manage the visibility of all your editor controls manually.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._SaveExternalData">
|
||
<summary>
|
||
<para>This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._SetState(Godot.Collections.Dictionary)">
|
||
<summary>
|
||
<para>Restore the state saved by <see cref="M:Godot.EditorPlugin._GetState"/>. This method is called when the current scene tab is changed in the editor.</para>
|
||
<para><b>Note:</b> Your plugin must implement <see cref="M:Godot.EditorPlugin._GetPluginName"/>, otherwise it will not be recognized and this method will not be called.</para>
|
||
<para><code>
|
||
func _set_state(data):
|
||
zoom = data.get("zoom", 1.0)
|
||
preferred_color = data.get("my_color", Color.WHITE)
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin._SetWindowLayout(Godot.ConfigFile)">
|
||
<summary>
|
||
<para>Restore the plugin GUI layout and data saved by <see cref="M:Godot.EditorPlugin._GetWindowLayout(Godot.ConfigFile)"/>. This method is called for every plugin on editor startup. Use the provided <paramref name="configuration"/> file to read your saved data.</para>
|
||
<para><code>
|
||
func _set_window_layout(configuration):
|
||
$Window.position = configuration.get_value("MyPlugin", "window_position", Vector2())
|
||
$Icon.modulate = configuration.get_value("MyPlugin", "icon_color", Color.WHITE)
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddControlToContainer(Godot.EditorPlugin.CustomControlContainer,Godot.Control)">
|
||
<summary>
|
||
<para>Adds a custom control to a container (see <see cref="T:Godot.EditorPlugin.CustomControlContainer"/>). There are many locations where custom controls can be added in the editor UI.</para>
|
||
<para>Please remember that you have to manage the visibility of your custom controls yourself (and likely hide it after adding it).</para>
|
||
<para>When your plugin is deactivated, make sure to remove your custom control with <see cref="M:Godot.EditorPlugin.RemoveControlFromContainer(Godot.EditorPlugin.CustomControlContainer,Godot.Control)"/> and free it with <see cref="M:Godot.Node.QueueFree"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddControlToBottomPanel(Godot.Control,System.String,Godot.Shortcut)">
|
||
<summary>
|
||
<para>Adds a control to the bottom panel (together with Output, Debug, Animation, etc.). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with <see cref="M:Godot.EditorPlugin.RemoveControlFromBottomPanel(Godot.Control)"/> and free it with <see cref="M:Godot.Node.QueueFree"/>.</para>
|
||
<para>Optionally, you can specify a shortcut parameter. When pressed, this shortcut will toggle the bottom panel's visibility. See the default editor bottom panel shortcuts in the Editor Settings for inspiration. Per convention, they all use Alt modifier.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddControlToDock(Godot.EditorPlugin.DockSlot,Godot.Control,Godot.Shortcut)">
|
||
<summary>
|
||
<para>Adds the control to a specific dock slot (see <see cref="T:Godot.EditorPlugin.DockSlot"/> for options).</para>
|
||
<para>If the dock is repositioned and as long as the plugin is active, the editor will save the dock position on further sessions.</para>
|
||
<para>When your plugin is deactivated, make sure to remove your custom control with <see cref="M:Godot.EditorPlugin.RemoveControlFromDocks(Godot.Control)"/> and free it with <see cref="M:Godot.Node.QueueFree"/>.</para>
|
||
<para>Optionally, you can specify a shortcut parameter. When pressed, this shortcut will toggle the dock's visibility once it's moved to the bottom panel (this shortcut does not affect the dock otherwise). See the default editor bottom panel shortcuts in the Editor Settings for inspiration. Per convention, they all use Alt modifier.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveControlFromDocks(Godot.Control)">
|
||
<summary>
|
||
<para>Removes the control from the dock. You have to manually <see cref="M:Godot.Node.QueueFree"/> the control.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveControlFromBottomPanel(Godot.Control)">
|
||
<summary>
|
||
<para>Removes the control from the bottom panel. You have to manually <see cref="M:Godot.Node.QueueFree"/> the control.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveControlFromContainer(Godot.EditorPlugin.CustomControlContainer,Godot.Control)">
|
||
<summary>
|
||
<para>Removes the control from the specified container. You have to manually <see cref="M:Godot.Node.QueueFree"/> the control.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.SetDockTabIcon(Godot.Control,Godot.Texture2D)">
|
||
<summary>
|
||
<para>Sets the tab icon for the given control in a dock slot. Setting to <see langword="null"/> removes the icon.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddToolMenuItem(System.String,Godot.Callable)">
|
||
<summary>
|
||
<para>Adds a custom menu item to <b>Project > Tools</b> named <paramref name="name"/>. When clicked, the provided <paramref name="callable"/> will be called.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddToolSubmenuItem(System.String,Godot.PopupMenu)">
|
||
<summary>
|
||
<para>Adds a custom <see cref="T:Godot.PopupMenu"/> submenu under <b>Project > Tools ></b> <paramref name="name"/>. Use <see cref="M:Godot.EditorPlugin.RemoveToolMenuItem(System.String)"/> on plugin clean up to remove the menu.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveToolMenuItem(System.String)">
|
||
<summary>
|
||
<para>Removes a menu <paramref name="name"/> from <b>Project > Tools</b>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.GetExportAsMenu">
|
||
<summary>
|
||
<para>Returns the <see cref="T:Godot.PopupMenu"/> under <b>Scene > Export As...</b>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddCustomType(System.String,System.String,Godot.Script,Godot.Texture2D)">
|
||
<summary>
|
||
<para>Adds a custom type, which will appear in the list of nodes or resources.</para>
|
||
<para>When a given node or resource is selected, the base type will be instantiated (e.g. "Node3D", "Control", "Resource"), then the script will be loaded and set to this object.</para>
|
||
<para><b>Note:</b> The base type is the base engine class which this type's class hierarchy inherits, not any custom type parent classes.</para>
|
||
<para>You can use the virtual method <see cref="M:Godot.EditorPlugin._Handles(Godot.GodotObject)"/> to check if your custom object is being edited by checking the script or using the <c>is</c> keyword.</para>
|
||
<para>During run-time, this will be a simple object with a script so this function does not need to be called then.</para>
|
||
<para><b>Note:</b> Custom types added this way are not true classes. They are just a helper to create a node with specific script.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveCustomType(System.String)">
|
||
<summary>
|
||
<para>Removes a custom type added by <see cref="M:Godot.EditorPlugin.AddCustomType(System.String,System.String,Godot.Script,Godot.Texture2D)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddAutoloadSingleton(System.String,System.String)">
|
||
<summary>
|
||
<para>Adds a script at <paramref name="path"/> to the Autoload list as <paramref name="name"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveAutoloadSingleton(System.String)">
|
||
<summary>
|
||
<para>Removes an Autoload <paramref name="name"/> from the list.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.UpdateOverlays">
|
||
<summary>
|
||
<para>Updates the overlays of the 2D and 3D editor viewport. Causes methods <see cref="M:Godot.EditorPlugin._ForwardCanvasDrawOverViewport(Godot.Control)"/>, <see cref="M:Godot.EditorPlugin._ForwardCanvasForceDrawOverViewport(Godot.Control)"/>, <see cref="M:Godot.EditorPlugin._Forward3DDrawOverViewport(Godot.Control)"/> and <see cref="M:Godot.EditorPlugin._Forward3DForceDrawOverViewport(Godot.Control)"/> to be called.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.MakeBottomPanelItemVisible(Godot.Control)">
|
||
<summary>
|
||
<para>Makes a specific item in the bottom panel visible.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.HideBottomPanel">
|
||
<summary>
|
||
<para>Minimizes the bottom panel.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.GetUndoRedo">
|
||
<summary>
|
||
<para>Gets the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddUndoRedoInspectorHookCallback(Godot.Callable)">
|
||
<summary>
|
||
<para>Hooks a callback into the undo/redo action creation when a property is modified in the inspector. This allows, for example, to save other properties that may be lost when a given property is modified.</para>
|
||
<para>The callback should have 4 arguments: <see cref="T:Godot.GodotObject"/> <c>undo_redo</c>, <see cref="T:Godot.GodotObject"/> <c>modified_object</c>, <see cref="T:System.String"/> <c>property</c> and <see cref="T:Godot.Variant"/> <c>new_value</c>. They are, respectively, the <see cref="T:Godot.UndoRedo"/> object used by the inspector, the currently modified object, the name of the modified property and the new value the property is about to take.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveUndoRedoInspectorHookCallback(Godot.Callable)">
|
||
<summary>
|
||
<para>Removes a callback previously added by <see cref="M:Godot.EditorPlugin.AddUndoRedoInspectorHookCallback(Godot.Callable)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.QueueSaveLayout">
|
||
<summary>
|
||
<para>Queue save the project's editor layout.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddTranslationParserPlugin(Godot.EditorTranslationParserPlugin)">
|
||
<summary>
|
||
<para>Registers a custom translation parser plugin for extracting translatable strings from custom files.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveTranslationParserPlugin(Godot.EditorTranslationParserPlugin)">
|
||
<summary>
|
||
<para>Removes a custom translation parser plugin registered by <see cref="M:Godot.EditorPlugin.AddTranslationParserPlugin(Godot.EditorTranslationParserPlugin)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddImportPlugin(Godot.EditorImportPlugin,System.Boolean)">
|
||
<summary>
|
||
<para>Registers a new <see cref="T:Godot.EditorImportPlugin"/>. Import plugins are used to import custom and unsupported assets as a custom <see cref="T:Godot.Resource"/> type.</para>
|
||
<para>If <paramref name="firstPriority"/> is <see langword="true"/>, the new import plugin is inserted first in the list and takes precedence over pre-existing plugins.</para>
|
||
<para><b>Note:</b> If you want to import custom 3D asset formats use <see cref="M:Godot.EditorPlugin.AddSceneFormatImporterPlugin(Godot.EditorSceneFormatImporter,System.Boolean)"/> instead.</para>
|
||
<para>See <see cref="M:Godot.EditorPlugin.AddInspectorPlugin(Godot.EditorInspectorPlugin)"/> for an example of how to register a plugin.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveImportPlugin(Godot.EditorImportPlugin)">
|
||
<summary>
|
||
<para>Removes an import plugin registered by <see cref="M:Godot.EditorPlugin.AddImportPlugin(Godot.EditorImportPlugin,System.Boolean)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddSceneFormatImporterPlugin(Godot.EditorSceneFormatImporter,System.Boolean)">
|
||
<summary>
|
||
<para>Registers a new <see cref="T:Godot.EditorSceneFormatImporter"/>. Scene importers are used to import custom 3D asset formats as scenes.</para>
|
||
<para>If <paramref name="firstPriority"/> is <see langword="true"/>, the new import plugin is inserted first in the list and takes precedence over pre-existing plugins.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveSceneFormatImporterPlugin(Godot.EditorSceneFormatImporter)">
|
||
<summary>
|
||
<para>Removes a scene format importer registered by <see cref="M:Godot.EditorPlugin.AddSceneFormatImporterPlugin(Godot.EditorSceneFormatImporter,System.Boolean)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddScenePostImportPlugin(Godot.EditorScenePostImportPlugin,System.Boolean)">
|
||
<summary>
|
||
<para>Add a <see cref="T:Godot.EditorScenePostImportPlugin"/>. These plugins allow customizing the import process of 3D assets by adding new options to the import dialogs.</para>
|
||
<para>If <paramref name="firstPriority"/> is <see langword="true"/>, the new import plugin is inserted first in the list and takes precedence over pre-existing plugins.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveScenePostImportPlugin(Godot.EditorScenePostImportPlugin)">
|
||
<summary>
|
||
<para>Remove the <see cref="T:Godot.EditorScenePostImportPlugin"/>, added with <see cref="M:Godot.EditorPlugin.AddScenePostImportPlugin(Godot.EditorScenePostImportPlugin,System.Boolean)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddExportPlugin(Godot.EditorExportPlugin)">
|
||
<summary>
|
||
<para>Registers a new <see cref="T:Godot.EditorExportPlugin"/>. Export plugins are used to perform tasks when the project is being exported.</para>
|
||
<para>See <see cref="M:Godot.EditorPlugin.AddInspectorPlugin(Godot.EditorInspectorPlugin)"/> for an example of how to register a plugin.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveExportPlugin(Godot.EditorExportPlugin)">
|
||
<summary>
|
||
<para>Removes an export plugin registered by <see cref="M:Godot.EditorPlugin.AddExportPlugin(Godot.EditorExportPlugin)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddExportPlatform(Godot.EditorExportPlatform)">
|
||
<summary>
|
||
<para>Registers a new <see cref="T:Godot.EditorExportPlatform"/>. Export platforms provides functionality of exporting to the specific platform.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveExportPlatform(Godot.EditorExportPlatform)">
|
||
<summary>
|
||
<para>Removes an export platform registered by <see cref="M:Godot.EditorPlugin.AddExportPlatform(Godot.EditorExportPlatform)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddNode3DGizmoPlugin(Godot.EditorNode3DGizmoPlugin)">
|
||
<summary>
|
||
<para>Registers a new <see cref="T:Godot.EditorNode3DGizmoPlugin"/>. Gizmo plugins are used to add custom gizmos to the 3D preview viewport for a <see cref="T:Godot.Node3D"/>.</para>
|
||
<para>See <see cref="M:Godot.EditorPlugin.AddInspectorPlugin(Godot.EditorInspectorPlugin)"/> for an example of how to register a plugin.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveNode3DGizmoPlugin(Godot.EditorNode3DGizmoPlugin)">
|
||
<summary>
|
||
<para>Removes a gizmo plugin registered by <see cref="M:Godot.EditorPlugin.AddNode3DGizmoPlugin(Godot.EditorNode3DGizmoPlugin)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddInspectorPlugin(Godot.EditorInspectorPlugin)">
|
||
<summary>
|
||
<para>Registers a new <see cref="T:Godot.EditorInspectorPlugin"/>. Inspector plugins are used to extend <see cref="T:Godot.EditorInspector"/> and provide custom configuration tools for your object's properties.</para>
|
||
<para><b>Note:</b> Always use <see cref="M:Godot.EditorPlugin.RemoveInspectorPlugin(Godot.EditorInspectorPlugin)"/> to remove the registered <see cref="T:Godot.EditorInspectorPlugin"/> when your <see cref="T:Godot.EditorPlugin"/> is disabled to prevent leaks and an unexpected behavior.</para>
|
||
<para></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveInspectorPlugin(Godot.EditorInspectorPlugin)">
|
||
<summary>
|
||
<para>Removes an inspector plugin registered by <see cref="M:Godot.EditorPlugin.AddInspectorPlugin(Godot.EditorInspectorPlugin)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddResourceConversionPlugin(Godot.EditorResourceConversionPlugin)">
|
||
<summary>
|
||
<para>Registers a new <see cref="T:Godot.EditorResourceConversionPlugin"/>. Resource conversion plugins are used to add custom resource converters to the editor inspector.</para>
|
||
<para>See <see cref="T:Godot.EditorResourceConversionPlugin"/> for an example of how to create a resource conversion plugin.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveResourceConversionPlugin(Godot.EditorResourceConversionPlugin)">
|
||
<summary>
|
||
<para>Removes a resource conversion plugin registered by <see cref="M:Godot.EditorPlugin.AddResourceConversionPlugin(Godot.EditorResourceConversionPlugin)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.SetInputEventForwardingAlwaysEnabled">
|
||
<summary>
|
||
<para>Use this method if you always want to receive inputs from 3D view screen inside <see cref="M:Godot.EditorPlugin._Forward3DGuiInput(Godot.Camera3D,Godot.InputEvent)"/>. It might be especially usable if your plugin will want to use raycast in the scene.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.SetForceDrawOverForwardingEnabled">
|
||
<summary>
|
||
<para>Enables calling of <see cref="M:Godot.EditorPlugin._ForwardCanvasForceDrawOverViewport(Godot.Control)"/> for the 2D editor and <see cref="M:Godot.EditorPlugin._Forward3DForceDrawOverViewport(Godot.Control)"/> for the 3D editor when their viewports are updated. You need to call this method only once and it will work permanently for this plugin.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddContextMenuPlugin(Godot.EditorContextMenuPlugin.ContextMenuSlot,Godot.EditorContextMenuPlugin)">
|
||
<summary>
|
||
<para>Adds a plugin to the context menu. <paramref name="slot"/> is the context menu where the plugin will be added.</para>
|
||
<para>See <see cref="T:Godot.EditorContextMenuPlugin.ContextMenuSlot"/> for available context menus. A plugin instance can belong only to a single context menu slot.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveContextMenuPlugin(Godot.EditorContextMenuPlugin)">
|
||
<summary>
|
||
<para>Removes the specified context menu plugin.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.GetEditorInterface">
|
||
<summary>
|
||
<para>Returns the <see cref="T:Godot.EditorInterface"/> singleton instance.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.GetScriptCreateDialog">
|
||
<summary>
|
||
<para>Gets the Editor's dialog used for making scripts.</para>
|
||
<para><b>Note:</b> Users can configure it before use.</para>
|
||
<para><b>Warning:</b> Removing and freeing this node will render a part of the editor useless and may cause a crash.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddDebuggerPlugin(Godot.EditorDebuggerPlugin)">
|
||
<summary>
|
||
<para>Adds a <see cref="T:Godot.Script"/> as debugger plugin to the Debugger. The script must extend <see cref="T:Godot.EditorDebuggerPlugin"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.RemoveDebuggerPlugin(Godot.EditorDebuggerPlugin)">
|
||
<summary>
|
||
<para>Removes the debugger plugin with given script from the Debugger.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.GetPluginVersion">
|
||
<summary>
|
||
<para>Provide the version of the plugin declared in the <c>plugin.cfg</c> config file.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddControlToDock(Godot.EditorPlugin.DockSlot,Godot.Control)">
|
||
<summary>
|
||
<para>Adds the control to a specific dock slot (see <see cref="T:Godot.EditorPlugin.DockSlot"/> for options).</para>
|
||
<para>If the dock is repositioned and as long as the plugin is active, the editor will save the dock position on further sessions.</para>
|
||
<para>When your plugin is deactivated, make sure to remove your custom control with <see cref="M:Godot.EditorPlugin.RemoveControlFromDocks(Godot.Control)"/> and free it with <see cref="M:Godot.Node.QueueFree"/>.</para>
|
||
<para>Optionally, you can specify a shortcut parameter. When pressed, this shortcut will toggle the dock's visibility once it's moved to the bottom panel (this shortcut does not affect the dock otherwise). See the default editor bottom panel shortcuts in the Editor Settings for inspiration. Per convention, they all use Alt modifier.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.AddControlToBottomPanel(Godot.Control,System.String)">
|
||
<summary>
|
||
<para>Adds a control to the bottom panel (together with Output, Debug, Animation, etc.). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with <see cref="M:Godot.EditorPlugin.RemoveControlFromBottomPanel(Godot.Control)"/> and free it with <see cref="M:Godot.Node.QueueFree"/>.</para>
|
||
<para>Optionally, you can specify a shortcut parameter. When pressed, this shortcut will toggle the bottom panel's visibility. See the default editor bottom panel shortcuts in the Editor Settings for inspiration. Per convention, they all use Alt modifier.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorPlugin.SceneChangedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorPlugin.SceneChanged"/> event of a <see cref="T:Godot.EditorPlugin"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorPlugin.SceneChanged">
|
||
<summary>
|
||
<para>Emitted when the scene is changed in the editor. The argument will return the root node of the scene that has just become active. If this scene is new and empty, the argument will be <see langword="null"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorPlugin.SceneClosedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorPlugin.SceneClosed"/> event of a <see cref="T:Godot.EditorPlugin"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorPlugin.SceneClosed">
|
||
<summary>
|
||
<para>Emitted when user closes a scene. The argument is a file path to the closed scene.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorPlugin.MainScreenChangedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorPlugin.MainScreenChanged"/> event of a <see cref="T:Godot.EditorPlugin"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorPlugin.MainScreenChanged">
|
||
<summary>
|
||
<para>Emitted when user changes the workspace (<b>2D</b>, <b>3D</b>, <b>Script</b>, <b>AssetLib</b>). Also works with custom screens defined by plugins.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorPlugin.ResourceSavedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorPlugin.ResourceSaved"/> event of a <see cref="T:Godot.EditorPlugin"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorPlugin.ResourceSaved">
|
||
<summary>
|
||
<para>Emitted when the given <c>resource</c> was saved on disc. See also <see cref="E:Godot.EditorPlugin.SceneSaved"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorPlugin.SceneSavedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorPlugin.SceneSaved"/> event of a <see cref="T:Godot.EditorPlugin"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorPlugin.SceneSaved">
|
||
<summary>
|
||
<para>Emitted when a scene was saved on disc. The argument is a file path to the saved scene. See also <see cref="E:Godot.EditorPlugin.ResourceSaved"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorPlugin.ProjectSettingsChanged">
|
||
<summary>
|
||
<para>Emitted when any project setting has changed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorPlugin.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorPlugin.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorPlugin.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._ApplyChanges">
|
||
<summary>
|
||
Cached name for the '_apply_changes' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._Build">
|
||
<summary>
|
||
Cached name for the '_build' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._Clear">
|
||
<summary>
|
||
Cached name for the '_clear' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._DisablePlugin">
|
||
<summary>
|
||
Cached name for the '_disable_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._Edit">
|
||
<summary>
|
||
Cached name for the '_edit' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._EnablePlugin">
|
||
<summary>
|
||
Cached name for the '_enable_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._Forward3DDrawOverViewport">
|
||
<summary>
|
||
Cached name for the '_forward_3d_draw_over_viewport' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._Forward3DForceDrawOverViewport">
|
||
<summary>
|
||
Cached name for the '_forward_3d_force_draw_over_viewport' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._Forward3DGuiInput">
|
||
<summary>
|
||
Cached name for the '_forward_3d_gui_input' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._ForwardCanvasDrawOverViewport">
|
||
<summary>
|
||
Cached name for the '_forward_canvas_draw_over_viewport' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._ForwardCanvasForceDrawOverViewport">
|
||
<summary>
|
||
Cached name for the '_forward_canvas_force_draw_over_viewport' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._ForwardCanvasGuiInput">
|
||
<summary>
|
||
Cached name for the '_forward_canvas_gui_input' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._GetBreakpoints">
|
||
<summary>
|
||
Cached name for the '_get_breakpoints' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._GetPluginIcon">
|
||
<summary>
|
||
Cached name for the '_get_plugin_icon' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._GetPluginName">
|
||
<summary>
|
||
Cached name for the '_get_plugin_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._GetState">
|
||
<summary>
|
||
Cached name for the '_get_state' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._GetUnsavedStatus">
|
||
<summary>
|
||
Cached name for the '_get_unsaved_status' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._GetWindowLayout">
|
||
<summary>
|
||
Cached name for the '_get_window_layout' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._Handles">
|
||
<summary>
|
||
Cached name for the '_handles' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._HasMainScreen">
|
||
<summary>
|
||
Cached name for the '_has_main_screen' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._MakeVisible">
|
||
<summary>
|
||
Cached name for the '_make_visible' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._SaveExternalData">
|
||
<summary>
|
||
Cached name for the '_save_external_data' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._SetState">
|
||
<summary>
|
||
Cached name for the '_set_state' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName._SetWindowLayout">
|
||
<summary>
|
||
Cached name for the '_set_window_layout' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddControlToContainer">
|
||
<summary>
|
||
Cached name for the 'add_control_to_container' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddControlToBottomPanel">
|
||
<summary>
|
||
Cached name for the 'add_control_to_bottom_panel' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddControlToDock">
|
||
<summary>
|
||
Cached name for the 'add_control_to_dock' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveControlFromDocks">
|
||
<summary>
|
||
Cached name for the 'remove_control_from_docks' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveControlFromBottomPanel">
|
||
<summary>
|
||
Cached name for the 'remove_control_from_bottom_panel' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveControlFromContainer">
|
||
<summary>
|
||
Cached name for the 'remove_control_from_container' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.SetDockTabIcon">
|
||
<summary>
|
||
Cached name for the 'set_dock_tab_icon' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddToolMenuItem">
|
||
<summary>
|
||
Cached name for the 'add_tool_menu_item' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddToolSubmenuItem">
|
||
<summary>
|
||
Cached name for the 'add_tool_submenu_item' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveToolMenuItem">
|
||
<summary>
|
||
Cached name for the 'remove_tool_menu_item' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.GetExportAsMenu">
|
||
<summary>
|
||
Cached name for the 'get_export_as_menu' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddCustomType">
|
||
<summary>
|
||
Cached name for the 'add_custom_type' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveCustomType">
|
||
<summary>
|
||
Cached name for the 'remove_custom_type' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddAutoloadSingleton">
|
||
<summary>
|
||
Cached name for the 'add_autoload_singleton' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveAutoloadSingleton">
|
||
<summary>
|
||
Cached name for the 'remove_autoload_singleton' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.UpdateOverlays">
|
||
<summary>
|
||
Cached name for the 'update_overlays' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.MakeBottomPanelItemVisible">
|
||
<summary>
|
||
Cached name for the 'make_bottom_panel_item_visible' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.HideBottomPanel">
|
||
<summary>
|
||
Cached name for the 'hide_bottom_panel' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.GetUndoRedo">
|
||
<summary>
|
||
Cached name for the 'get_undo_redo' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddUndoRedoInspectorHookCallback">
|
||
<summary>
|
||
Cached name for the 'add_undo_redo_inspector_hook_callback' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveUndoRedoInspectorHookCallback">
|
||
<summary>
|
||
Cached name for the 'remove_undo_redo_inspector_hook_callback' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.QueueSaveLayout">
|
||
<summary>
|
||
Cached name for the 'queue_save_layout' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddTranslationParserPlugin">
|
||
<summary>
|
||
Cached name for the 'add_translation_parser_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveTranslationParserPlugin">
|
||
<summary>
|
||
Cached name for the 'remove_translation_parser_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddImportPlugin">
|
||
<summary>
|
||
Cached name for the 'add_import_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveImportPlugin">
|
||
<summary>
|
||
Cached name for the 'remove_import_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddSceneFormatImporterPlugin">
|
||
<summary>
|
||
Cached name for the 'add_scene_format_importer_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveSceneFormatImporterPlugin">
|
||
<summary>
|
||
Cached name for the 'remove_scene_format_importer_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddScenePostImportPlugin">
|
||
<summary>
|
||
Cached name for the 'add_scene_post_import_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveScenePostImportPlugin">
|
||
<summary>
|
||
Cached name for the 'remove_scene_post_import_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddExportPlugin">
|
||
<summary>
|
||
Cached name for the 'add_export_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveExportPlugin">
|
||
<summary>
|
||
Cached name for the 'remove_export_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddExportPlatform">
|
||
<summary>
|
||
Cached name for the 'add_export_platform' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveExportPlatform">
|
||
<summary>
|
||
Cached name for the 'remove_export_platform' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddNode3DGizmoPlugin">
|
||
<summary>
|
||
Cached name for the 'add_node_3d_gizmo_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveNode3DGizmoPlugin">
|
||
<summary>
|
||
Cached name for the 'remove_node_3d_gizmo_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddInspectorPlugin">
|
||
<summary>
|
||
Cached name for the 'add_inspector_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveInspectorPlugin">
|
||
<summary>
|
||
Cached name for the 'remove_inspector_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddResourceConversionPlugin">
|
||
<summary>
|
||
Cached name for the 'add_resource_conversion_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveResourceConversionPlugin">
|
||
<summary>
|
||
Cached name for the 'remove_resource_conversion_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.SetInputEventForwardingAlwaysEnabled">
|
||
<summary>
|
||
Cached name for the 'set_input_event_forwarding_always_enabled' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.SetForceDrawOverForwardingEnabled">
|
||
<summary>
|
||
Cached name for the 'set_force_draw_over_forwarding_enabled' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddContextMenuPlugin">
|
||
<summary>
|
||
Cached name for the 'add_context_menu_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveContextMenuPlugin">
|
||
<summary>
|
||
Cached name for the 'remove_context_menu_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.GetEditorInterface">
|
||
<summary>
|
||
Cached name for the 'get_editor_interface' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.GetScriptCreateDialog">
|
||
<summary>
|
||
Cached name for the 'get_script_create_dialog' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.AddDebuggerPlugin">
|
||
<summary>
|
||
Cached name for the 'add_debugger_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.RemoveDebuggerPlugin">
|
||
<summary>
|
||
Cached name for the 'remove_debugger_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.MethodName.GetPluginVersion">
|
||
<summary>
|
||
Cached name for the 'get_plugin_version' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorPlugin.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.SignalName.SceneChanged">
|
||
<summary>
|
||
Cached name for the 'scene_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.SignalName.SceneClosed">
|
||
<summary>
|
||
Cached name for the 'scene_closed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.SignalName.MainScreenChanged">
|
||
<summary>
|
||
Cached name for the 'main_screen_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.SignalName.ResourceSaved">
|
||
<summary>
|
||
Cached name for the 'resource_saved' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.SignalName.SceneSaved">
|
||
<summary>
|
||
Cached name for the 'scene_saved' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorPlugin.SignalName.ProjectSettingsChanged">
|
||
<summary>
|
||
Cached name for the 'project_settings_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorProperty">
|
||
<summary>
|
||
<para>A custom control for editing properties that can be added to the <see cref="T:Godot.EditorInspector"/>. It is added via <see cref="T:Godot.EditorInspectorPlugin"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorProperty.Label">
|
||
<summary>
|
||
<para>Set this property to change the label (if you want to show one).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorProperty.ReadOnly">
|
||
<summary>
|
||
<para>Used by the inspector, set to <see langword="true"/> when the property is read-only.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorProperty.Checkable">
|
||
<summary>
|
||
<para>Used by the inspector, set to <see langword="true"/> when the property is checkable.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorProperty.Checked">
|
||
<summary>
|
||
<para>Used by the inspector, set to <see langword="true"/> when the property is checked.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorProperty.DrawWarning">
|
||
<summary>
|
||
<para>Used by the inspector, set to <see langword="true"/> when the property is drawn with the editor theme's warning color. This is used for editable children's properties.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorProperty.Keying">
|
||
<summary>
|
||
<para>Used by the inspector, set to <see langword="true"/> when the property can add keys for animation.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorProperty.Deletable">
|
||
<summary>
|
||
<para>Used by the inspector, set to <see langword="true"/> when the property can be deleted by the user.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorProperty.Selectable">
|
||
<summary>
|
||
<para>Used by the inspector, set to <see langword="true"/> when the property is selectable.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorProperty.UseFolding">
|
||
<summary>
|
||
<para>Used by the inspector, set to <see langword="true"/> when the property is using folding.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorProperty.NameSplitRatio">
|
||
<summary>
|
||
<para>Space distribution ratio between the label and the editing field.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorProperty._SetReadOnly(System.Boolean)">
|
||
<summary>
|
||
<para>Called when the read-only status of the property is changed. It may be used to change custom controls into a read-only or modifiable state.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorProperty._UpdateProperty">
|
||
<summary>
|
||
<para>When this virtual function is called, you must update your editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorProperty.GetEditedProperty">
|
||
<summary>
|
||
<para>Gets the edited property. If your editor is for a single property (added via <see cref="M:Godot.EditorInspectorPlugin._ParseProperty(Godot.GodotObject,Godot.Variant.Type,System.String,Godot.PropertyHint,System.String,Godot.PropertyUsageFlags,System.Boolean)"/>), then this will return the property.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorProperty.GetEditedObject">
|
||
<summary>
|
||
<para>Gets the edited object.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorProperty.UpdateProperty">
|
||
<summary>
|
||
<para>Forces refresh of the property display.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorProperty.AddFocusable(Godot.Control)">
|
||
<summary>
|
||
<para>If any of the controls added can gain keyboard focus, add it here. This ensures that focus will be restored if the inspector is refreshed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorProperty.SetBottomEditor(Godot.Control)">
|
||
<summary>
|
||
<para>Puts the <paramref name="editor"/> control below the property label. The control must be previously added using <see cref="M:Godot.Node.AddChild(Godot.Node,System.Boolean,Godot.Node.InternalMode)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorProperty.Deselect">
|
||
<summary>
|
||
<para>Draw property as not selected. Used by the inspector.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorProperty.IsSelected">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if property is drawn as selected. Used by the inspector.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorProperty.Select(System.Int32)">
|
||
<summary>
|
||
<para>Draw property as selected. Used by the inspector.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorProperty.SetObjectAndProperty(Godot.GodotObject,Godot.StringName)">
|
||
<summary>
|
||
<para>Assigns object and property to edit.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorProperty.SetLabelReference(Godot.Control)">
|
||
<summary>
|
||
<para>Used by the inspector, set to a control that will be used as a reference to calculate the size of the label.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorProperty.EmitChanged(Godot.StringName,Godot.Variant,Godot.StringName,System.Boolean)">
|
||
<summary>
|
||
<para>If one or several properties have changed, this must be called. <paramref name="field"/> is used in case your editor can modify fields separately (as an example, Vector3.x). The <paramref name="changing"/> argument avoids the editor requesting this property to be refreshed (leave as <see langword="false"/> if unsure).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorProperty.PropertyChangedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorProperty.PropertyChanged"/> event of a <see cref="T:Godot.EditorProperty"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorProperty.PropertyChanged">
|
||
<summary>
|
||
<para>Do not emit this manually, use the <see cref="M:Godot.EditorProperty.EmitChanged(Godot.StringName,Godot.Variant,Godot.StringName,System.Boolean)"/> method instead.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorProperty.MultiplePropertiesChangedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorProperty.MultiplePropertiesChanged"/> event of a <see cref="T:Godot.EditorProperty"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorProperty.MultiplePropertiesChanged">
|
||
<summary>
|
||
<para>Emit it if you want multiple properties modified at the same time. Do not use if added via <see cref="M:Godot.EditorInspectorPlugin._ParseProperty(Godot.GodotObject,Godot.Variant.Type,System.String,Godot.PropertyHint,System.String,Godot.PropertyUsageFlags,System.Boolean)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorProperty.PropertyKeyedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorProperty.PropertyKeyed"/> event of a <see cref="T:Godot.EditorProperty"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorProperty.PropertyKeyed">
|
||
<summary>
|
||
<para>Emit it if you want to add this value as an animation key (check for keying being enabled first).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorProperty.PropertyDeletedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorProperty.PropertyDeleted"/> event of a <see cref="T:Godot.EditorProperty"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorProperty.PropertyDeleted">
|
||
<summary>
|
||
<para>Emitted when a property was deleted. Used internally.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorProperty.PropertyKeyedWithValueEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorProperty.PropertyKeyedWithValue"/> event of a <see cref="T:Godot.EditorProperty"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorProperty.PropertyKeyedWithValue">
|
||
<summary>
|
||
<para>Emit it if you want to key a property with a single value.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorProperty.PropertyCheckedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorProperty.PropertyChecked"/> event of a <see cref="T:Godot.EditorProperty"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorProperty.PropertyChecked">
|
||
<summary>
|
||
<para>Emitted when a property was checked. Used internally.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorProperty.PropertyFavoritedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorProperty.PropertyFavorited"/> event of a <see cref="T:Godot.EditorProperty"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorProperty.PropertyFavorited">
|
||
<summary>
|
||
<para>Emit it if you want to mark a property as favorited, making it appear at the top of the inspector.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorProperty.PropertyPinnedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorProperty.PropertyPinned"/> event of a <see cref="T:Godot.EditorProperty"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorProperty.PropertyPinned">
|
||
<summary>
|
||
<para>Emit it if you want to mark (or unmark) the value of a property for being saved regardless of being equal to the default value.</para>
|
||
<para>The default value is the one the property will get when the node is just instantiated and can come from an ancestor scene in the inheritance/instantiation chain, a script or a builtin class.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorProperty.PropertyCanRevertChangedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorProperty.PropertyCanRevertChanged"/> event of a <see cref="T:Godot.EditorProperty"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorProperty.PropertyCanRevertChanged">
|
||
<summary>
|
||
<para>Emitted when the revertability (i.e., whether it has a non-default value and thus is displayed with a revert icon) of a property has changed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorProperty.ResourceSelectedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorProperty.ResourceSelected"/> event of a <see cref="T:Godot.EditorProperty"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorProperty.ResourceSelected">
|
||
<summary>
|
||
<para>If you want a sub-resource to be edited, emit this signal with the resource.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorProperty.ObjectIdSelectedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorProperty.ObjectIdSelected"/> event of a <see cref="T:Godot.EditorProperty"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorProperty.ObjectIdSelected">
|
||
<summary>
|
||
<para>Used by sub-inspectors. Emit it if what was selected was an Object ID.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorProperty.SelectedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorProperty.Selected"/> event of a <see cref="T:Godot.EditorProperty"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorProperty.Selected">
|
||
<summary>
|
||
<para>Emitted when selected. Used internally.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorProperty.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorProperty.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorProperty.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorProperty.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.PropertyName.Label">
|
||
<summary>
|
||
Cached name for the 'label' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.PropertyName.ReadOnly">
|
||
<summary>
|
||
Cached name for the 'read_only' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.PropertyName.Checkable">
|
||
<summary>
|
||
Cached name for the 'checkable' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.PropertyName.Checked">
|
||
<summary>
|
||
Cached name for the 'checked' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.PropertyName.DrawWarning">
|
||
<summary>
|
||
Cached name for the 'draw_warning' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.PropertyName.Keying">
|
||
<summary>
|
||
Cached name for the 'keying' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.PropertyName.Deletable">
|
||
<summary>
|
||
Cached name for the 'deletable' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.PropertyName.Selectable">
|
||
<summary>
|
||
Cached name for the 'selectable' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.PropertyName.UseFolding">
|
||
<summary>
|
||
Cached name for the 'use_folding' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.PropertyName.NameSplitRatio">
|
||
<summary>
|
||
Cached name for the 'name_split_ratio' property.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorProperty.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName._SetReadOnly">
|
||
<summary>
|
||
Cached name for the '_set_read_only' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName._UpdateProperty">
|
||
<summary>
|
||
Cached name for the '_update_property' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.SetLabel">
|
||
<summary>
|
||
Cached name for the 'set_label' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.GetLabel">
|
||
<summary>
|
||
Cached name for the 'get_label' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.SetReadOnly">
|
||
<summary>
|
||
Cached name for the 'set_read_only' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.IsReadOnly">
|
||
<summary>
|
||
Cached name for the 'is_read_only' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.SetCheckable">
|
||
<summary>
|
||
Cached name for the 'set_checkable' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.IsCheckable">
|
||
<summary>
|
||
Cached name for the 'is_checkable' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.SetChecked">
|
||
<summary>
|
||
Cached name for the 'set_checked' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.IsChecked">
|
||
<summary>
|
||
Cached name for the 'is_checked' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.SetDrawWarning">
|
||
<summary>
|
||
Cached name for the 'set_draw_warning' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.IsDrawWarning">
|
||
<summary>
|
||
Cached name for the 'is_draw_warning' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.SetKeying">
|
||
<summary>
|
||
Cached name for the 'set_keying' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.IsKeying">
|
||
<summary>
|
||
Cached name for the 'is_keying' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.SetDeletable">
|
||
<summary>
|
||
Cached name for the 'set_deletable' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.IsDeletable">
|
||
<summary>
|
||
Cached name for the 'is_deletable' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.GetEditedProperty">
|
||
<summary>
|
||
Cached name for the 'get_edited_property' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.GetEditedObject">
|
||
<summary>
|
||
Cached name for the 'get_edited_object' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.UpdateProperty">
|
||
<summary>
|
||
Cached name for the 'update_property' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.AddFocusable">
|
||
<summary>
|
||
Cached name for the 'add_focusable' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.SetBottomEditor">
|
||
<summary>
|
||
Cached name for the 'set_bottom_editor' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.SetSelectable">
|
||
<summary>
|
||
Cached name for the 'set_selectable' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.IsSelectable">
|
||
<summary>
|
||
Cached name for the 'is_selectable' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.SetUseFolding">
|
||
<summary>
|
||
Cached name for the 'set_use_folding' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.IsUsingFolding">
|
||
<summary>
|
||
Cached name for the 'is_using_folding' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.SetNameSplitRatio">
|
||
<summary>
|
||
Cached name for the 'set_name_split_ratio' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.GetNameSplitRatio">
|
||
<summary>
|
||
Cached name for the 'get_name_split_ratio' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.Deselect">
|
||
<summary>
|
||
Cached name for the 'deselect' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.IsSelected">
|
||
<summary>
|
||
Cached name for the 'is_selected' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.Select">
|
||
<summary>
|
||
Cached name for the 'select' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.SetObjectAndProperty">
|
||
<summary>
|
||
Cached name for the 'set_object_and_property' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.SetLabelReference">
|
||
<summary>
|
||
Cached name for the 'set_label_reference' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.MethodName.EmitChanged">
|
||
<summary>
|
||
Cached name for the 'emit_changed' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorProperty.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.SignalName.PropertyChanged">
|
||
<summary>
|
||
Cached name for the 'property_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.SignalName.MultiplePropertiesChanged">
|
||
<summary>
|
||
Cached name for the 'multiple_properties_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.SignalName.PropertyKeyed">
|
||
<summary>
|
||
Cached name for the 'property_keyed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.SignalName.PropertyDeleted">
|
||
<summary>
|
||
Cached name for the 'property_deleted' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.SignalName.PropertyKeyedWithValue">
|
||
<summary>
|
||
Cached name for the 'property_keyed_with_value' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.SignalName.PropertyChecked">
|
||
<summary>
|
||
Cached name for the 'property_checked' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.SignalName.PropertyFavorited">
|
||
<summary>
|
||
Cached name for the 'property_favorited' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.SignalName.PropertyPinned">
|
||
<summary>
|
||
Cached name for the 'property_pinned' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.SignalName.PropertyCanRevertChanged">
|
||
<summary>
|
||
Cached name for the 'property_can_revert_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.SignalName.ResourceSelected">
|
||
<summary>
|
||
Cached name for the 'resource_selected' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.SignalName.ObjectIdSelected">
|
||
<summary>
|
||
Cached name for the 'object_id_selected' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorProperty.SignalName.Selected">
|
||
<summary>
|
||
Cached name for the 'selected' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourceConversionPlugin">
|
||
<summary>
|
||
<para><see cref="T:Godot.EditorResourceConversionPlugin"/> is invoked when the context menu is brought up for a resource in the editor inspector. Relevant conversion plugins will appear as menu options to convert the given resource to a target type.</para>
|
||
<para>Below shows an example of a basic plugin that will convert an <see cref="T:Godot.ImageTexture"/> to a <see cref="T:Godot.PortableCompressedTexture2D"/>.</para>
|
||
<para></para>
|
||
<para>To use an <see cref="T:Godot.EditorResourceConversionPlugin"/>, register it using the <see cref="M:Godot.EditorPlugin.AddResourceConversionPlugin(Godot.EditorResourceConversionPlugin)"/> method first.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourceConversionPlugin._Convert(Godot.Resource)">
|
||
<summary>
|
||
<para>Takes an input <see cref="T:Godot.Resource"/> and converts it to the type given in <see cref="M:Godot.EditorResourceConversionPlugin._ConvertsTo"/>. The returned <see cref="T:Godot.Resource"/> is the result of the conversion, and the input <see cref="T:Godot.Resource"/> remains unchanged.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourceConversionPlugin._ConvertsTo">
|
||
<summary>
|
||
<para>Returns the class name of the target type of <see cref="T:Godot.Resource"/> that this plugin converts source resources to.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourceConversionPlugin._Handles(Godot.Resource)">
|
||
<summary>
|
||
<para>Called to determine whether a particular <see cref="T:Godot.Resource"/> can be converted to the target resource type by this plugin.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourceConversionPlugin.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorResourceConversionPlugin.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorResourceConversionPlugin.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorResourceConversionPlugin.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourceConversionPlugin.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourceConversionPlugin.MethodName._Convert">
|
||
<summary>
|
||
Cached name for the '_convert' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourceConversionPlugin.MethodName._ConvertsTo">
|
||
<summary>
|
||
Cached name for the '_converts_to' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourceConversionPlugin.MethodName._Handles">
|
||
<summary>
|
||
Cached name for the '_handles' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourceConversionPlugin.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourcePicker">
|
||
<summary>
|
||
<para>This <see cref="T:Godot.Control"/> node is used in the editor's Inspector dock to allow editing of <see cref="T:Godot.Resource"/> type properties. It provides options for creating, loading, saving and converting resources. Can be used with <see cref="T:Godot.EditorInspectorPlugin"/> to recreate the same behavior.</para>
|
||
<para><b>Note:</b> This <see cref="T:Godot.Control"/> does not include any editor for the resource, as editing is controlled by the Inspector dock itself or sub-Inspectors.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorResourcePicker.BaseType">
|
||
<summary>
|
||
<para>The base type of allowed resource types. Can be a comma-separated list of several options.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorResourcePicker.EditedResource">
|
||
<summary>
|
||
<para>The edited resource value.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorResourcePicker.Editable">
|
||
<summary>
|
||
<para>If <see langword="true"/>, the value can be selected and edited.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorResourcePicker.ToggleMode">
|
||
<summary>
|
||
<para>If <see langword="true"/>, the main button with the resource preview works in the toggle mode. Use <see cref="M:Godot.EditorResourcePicker.SetTogglePressed(System.Boolean)"/> to manually set the state.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePicker._HandleMenuSelected(System.Int32)">
|
||
<summary>
|
||
<para>This virtual method can be implemented to handle context menu items not handled by default. See <see cref="M:Godot.EditorResourcePicker._SetCreateOptions(Godot.GodotObject)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePicker._SetCreateOptions(Godot.GodotObject)">
|
||
<summary>
|
||
<para>This virtual method is called when updating the context menu of <see cref="T:Godot.EditorResourcePicker"/>. Implement this method to override the "New ..." items with your own options. <paramref name="menuNode"/> is a reference to the <see cref="T:Godot.PopupMenu"/> node.</para>
|
||
<para><b>Note:</b> Implement <see cref="M:Godot.EditorResourcePicker._HandleMenuSelected(System.Int32)"/> to handle these custom items.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePicker.GetAllowedTypes">
|
||
<summary>
|
||
<para>Returns a list of all allowed types and subtypes corresponding to the <see cref="P:Godot.EditorResourcePicker.BaseType"/>. If the <see cref="P:Godot.EditorResourcePicker.BaseType"/> is empty, an empty list is returned.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePicker.SetTogglePressed(System.Boolean)">
|
||
<summary>
|
||
<para>Sets the toggle mode state for the main button. Works only if <see cref="P:Godot.EditorResourcePicker.ToggleMode"/> is set to <see langword="true"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourcePicker.ResourceSelectedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorResourcePicker.ResourceSelected"/> event of a <see cref="T:Godot.EditorResourcePicker"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorResourcePicker.ResourceSelected">
|
||
<summary>
|
||
<para>Emitted when the resource value was set and user clicked to edit it. When <c>inspect</c> is <see langword="true"/>, the signal was caused by the context menu "Edit" or "Inspect" option.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourcePicker.ResourceChangedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorResourcePicker.ResourceChanged"/> event of a <see cref="T:Godot.EditorResourcePicker"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorResourcePicker.ResourceChanged">
|
||
<summary>
|
||
<para>Emitted when the value of the edited resource was changed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePicker.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePicker.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePicker.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorResourcePicker.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.PropertyName.BaseType">
|
||
<summary>
|
||
Cached name for the 'base_type' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.PropertyName.EditedResource">
|
||
<summary>
|
||
Cached name for the 'edited_resource' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.PropertyName.Editable">
|
||
<summary>
|
||
Cached name for the 'editable' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.PropertyName.ToggleMode">
|
||
<summary>
|
||
Cached name for the 'toggle_mode' property.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourcePicker.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.MethodName._HandleMenuSelected">
|
||
<summary>
|
||
Cached name for the '_handle_menu_selected' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.MethodName._SetCreateOptions">
|
||
<summary>
|
||
Cached name for the '_set_create_options' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.MethodName.SetBaseType">
|
||
<summary>
|
||
Cached name for the 'set_base_type' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.MethodName.GetBaseType">
|
||
<summary>
|
||
Cached name for the 'get_base_type' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.MethodName.GetAllowedTypes">
|
||
<summary>
|
||
Cached name for the 'get_allowed_types' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.MethodName.SetEditedResource">
|
||
<summary>
|
||
Cached name for the 'set_edited_resource' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.MethodName.GetEditedResource">
|
||
<summary>
|
||
Cached name for the 'get_edited_resource' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.MethodName.SetToggleMode">
|
||
<summary>
|
||
Cached name for the 'set_toggle_mode' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.MethodName.IsToggleMode">
|
||
<summary>
|
||
Cached name for the 'is_toggle_mode' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.MethodName.SetTogglePressed">
|
||
<summary>
|
||
Cached name for the 'set_toggle_pressed' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.MethodName.SetEditable">
|
||
<summary>
|
||
Cached name for the 'set_editable' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.MethodName.IsEditable">
|
||
<summary>
|
||
Cached name for the 'is_editable' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourcePicker.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.SignalName.ResourceSelected">
|
||
<summary>
|
||
Cached name for the 'resource_selected' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePicker.SignalName.ResourceChanged">
|
||
<summary>
|
||
Cached name for the 'resource_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourcePreview">
|
||
<summary>
|
||
<para>This node is used to generate previews for resources or files.</para>
|
||
<para><b>Note:</b> This class shouldn't be instantiated directly. Instead, access the singleton using <see cref="M:Godot.EditorInterface.GetResourcePreviewer"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePreview.QueueResourcePreview(System.String,Godot.GodotObject,Godot.StringName,Godot.Variant)">
|
||
<summary>
|
||
<para>Queue a resource file located at <paramref name="path"/> for preview. Once the preview is ready, the <paramref name="receiver"/>'s <paramref name="receiverFunc"/> will be called. The <paramref name="receiverFunc"/> must take the following four arguments: <see cref="T:System.String"/> path, <see cref="T:Godot.Texture2D"/> preview, <see cref="T:Godot.Texture2D"/> thumbnail_preview, <see cref="T:Godot.Variant"/> userdata. <paramref name="userdata"/> can be anything, and will be returned when <paramref name="receiverFunc"/> is called.</para>
|
||
<para><b>Note:</b> If it was not possible to create the preview the <paramref name="receiverFunc"/> will still be called, but the preview will be <see langword="null"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePreview.QueueEditedResourcePreview(Godot.Resource,Godot.GodotObject,Godot.StringName,Godot.Variant)">
|
||
<summary>
|
||
<para>Queue the <paramref name="resource"/> being edited for preview. Once the preview is ready, the <paramref name="receiver"/>'s <paramref name="receiverFunc"/> will be called. The <paramref name="receiverFunc"/> must take the following four arguments: <see cref="T:System.String"/> path, <see cref="T:Godot.Texture2D"/> preview, <see cref="T:Godot.Texture2D"/> thumbnail_preview, <see cref="T:Godot.Variant"/> userdata. <paramref name="userdata"/> can be anything, and will be returned when <paramref name="receiverFunc"/> is called.</para>
|
||
<para><b>Note:</b> If it was not possible to create the preview the <paramref name="receiverFunc"/> will still be called, but the preview will be <see langword="null"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePreview.AddPreviewGenerator(Godot.EditorResourcePreviewGenerator)">
|
||
<summary>
|
||
<para>Create an own, custom preview generator.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePreview.RemovePreviewGenerator(Godot.EditorResourcePreviewGenerator)">
|
||
<summary>
|
||
<para>Removes a custom preview generator.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePreview.CheckForInvalidation(System.String)">
|
||
<summary>
|
||
<para>Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourcePreview.PreviewInvalidatedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.EditorResourcePreview.PreviewInvalidated"/> event of a <see cref="T:Godot.EditorResourcePreview"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorResourcePreview.PreviewInvalidated">
|
||
<summary>
|
||
<para>Emitted if a preview was invalidated (changed). <c>path</c> corresponds to the path of the preview.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePreview.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePreview.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePreview.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorResourcePreview.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourcePreview.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePreview.MethodName.QueueResourcePreview">
|
||
<summary>
|
||
Cached name for the 'queue_resource_preview' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePreview.MethodName.QueueEditedResourcePreview">
|
||
<summary>
|
||
Cached name for the 'queue_edited_resource_preview' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePreview.MethodName.AddPreviewGenerator">
|
||
<summary>
|
||
Cached name for the 'add_preview_generator' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePreview.MethodName.RemovePreviewGenerator">
|
||
<summary>
|
||
Cached name for the 'remove_preview_generator' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePreview.MethodName.CheckForInvalidation">
|
||
<summary>
|
||
Cached name for the 'check_for_invalidation' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourcePreview.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePreview.SignalName.PreviewInvalidated">
|
||
<summary>
|
||
Cached name for the 'preview_invalidated' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourcePreviewGenerator">
|
||
<summary>
|
||
<para>Custom code to generate previews. Check <c>EditorSettings.filesystem/file_dialog/thumbnail_size</c> to find a proper size to generate previews at.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePreviewGenerator._CanGenerateSmallPreview">
|
||
<summary>
|
||
<para>If this function returns <see langword="true"/>, the generator will call <see cref="M:Godot.EditorResourcePreviewGenerator._Generate(Godot.Resource,Godot.Vector2I,Godot.Collections.Dictionary)"/> or <see cref="M:Godot.EditorResourcePreviewGenerator._GenerateFromPath(System.String,Godot.Vector2I,Godot.Collections.Dictionary)"/> for small previews as well.</para>
|
||
<para>By default, it returns <see langword="false"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePreviewGenerator._Generate(Godot.Resource,Godot.Vector2I,Godot.Collections.Dictionary)">
|
||
<summary>
|
||
<para>Generate a preview from a given resource with the specified size. This must always be implemented.</para>
|
||
<para>Returning <see langword="null"/> is an OK way to fail and let another generator take care.</para>
|
||
<para>Care must be taken because this function is always called from a thread (not the main thread).</para>
|
||
<para><paramref name="metadata"/> dictionary can be modified to store file-specific metadata that can be used in <see cref="M:Godot.EditorResourceTooltipPlugin._MakeTooltipForPath(System.String,Godot.Collections.Dictionary,Godot.Control)"/> (like image size, sample length etc.).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePreviewGenerator._GenerateFromPath(System.String,Godot.Vector2I,Godot.Collections.Dictionary)">
|
||
<summary>
|
||
<para>Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call <see cref="M:Godot.EditorResourcePreviewGenerator._Generate(Godot.Resource,Godot.Vector2I,Godot.Collections.Dictionary)"/>.</para>
|
||
<para>Returning <see langword="null"/> is an OK way to fail and let another generator take care.</para>
|
||
<para>Care must be taken because this function is always called from a thread (not the main thread).</para>
|
||
<para><paramref name="metadata"/> dictionary can be modified to store file-specific metadata that can be used in <see cref="M:Godot.EditorResourceTooltipPlugin._MakeTooltipForPath(System.String,Godot.Collections.Dictionary,Godot.Control)"/> (like image size, sample length etc.).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePreviewGenerator._GenerateSmallPreviewAutomatically">
|
||
<summary>
|
||
<para>If this function returns <see langword="true"/>, the generator will automatically generate the small previews from the normal preview texture generated by the methods <see cref="M:Godot.EditorResourcePreviewGenerator._Generate(Godot.Resource,Godot.Vector2I,Godot.Collections.Dictionary)"/> or <see cref="M:Godot.EditorResourcePreviewGenerator._GenerateFromPath(System.String,Godot.Vector2I,Godot.Collections.Dictionary)"/>.</para>
|
||
<para>By default, it returns <see langword="false"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePreviewGenerator._Handles(System.String)">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if your generator supports the resource of type <paramref name="type"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePreviewGenerator.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePreviewGenerator.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorResourcePreviewGenerator.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorResourcePreviewGenerator.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourcePreviewGenerator.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePreviewGenerator.MethodName._CanGenerateSmallPreview">
|
||
<summary>
|
||
Cached name for the '_can_generate_small_preview' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePreviewGenerator.MethodName._Generate">
|
||
<summary>
|
||
Cached name for the '_generate' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePreviewGenerator.MethodName._GenerateFromPath">
|
||
<summary>
|
||
Cached name for the '_generate_from_path' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePreviewGenerator.MethodName._GenerateSmallPreviewAutomatically">
|
||
<summary>
|
||
Cached name for the '_generate_small_preview_automatically' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourcePreviewGenerator.MethodName._Handles">
|
||
<summary>
|
||
Cached name for the '_handles' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourcePreviewGenerator.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourceTooltipPlugin">
|
||
<summary>
|
||
<para>Resource tooltip plugins are used by <see cref="T:Godot.FileSystemDock"/> to generate customized tooltips for specific resources. E.g. tooltip for a <see cref="T:Godot.Texture2D"/> displays a bigger preview and the texture's dimensions.</para>
|
||
<para>A plugin must be first registered with <see cref="M:Godot.FileSystemDock.AddResourceTooltipPlugin(Godot.EditorResourceTooltipPlugin)"/>. When the user hovers a resource in filesystem dock which is handled by the plugin, <see cref="M:Godot.EditorResourceTooltipPlugin._MakeTooltipForPath(System.String,Godot.Collections.Dictionary,Godot.Control)"/> is called to create the tooltip. It works similarly to <see cref="M:Godot.Control._MakeCustomTooltip(System.String)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourceTooltipPlugin._Handles(System.String)">
|
||
<summary>
|
||
<para>Return <see langword="true"/> if the plugin is going to handle the given <see cref="T:Godot.Resource"/> <paramref name="type"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourceTooltipPlugin._MakeTooltipForPath(System.String,Godot.Collections.Dictionary,Godot.Control)">
|
||
<summary>
|
||
<para>Create and return a tooltip that will be displayed when the user hovers a resource under the given <paramref name="path"/> in filesystem dock.</para>
|
||
<para>The <paramref name="metadata"/> dictionary is provided by preview generator (see <see cref="M:Godot.EditorResourcePreviewGenerator._Generate(Godot.Resource,Godot.Vector2I,Godot.Collections.Dictionary)"/>).</para>
|
||
<para><paramref name="base"/> is the base default tooltip, which is a <see cref="T:Godot.VBoxContainer"/> with a file name, type and size labels. If another plugin handled the same file type, <paramref name="base"/> will be output from the previous plugin. For best result, make sure the base tooltip is part of the returned <see cref="T:Godot.Control"/>.</para>
|
||
<para><b>Note:</b> It's unadvised to use <see cref="M:Godot.ResourceLoader.Load(System.String,System.String,Godot.ResourceLoader.CacheMode)"/>, especially with heavy resources like models or textures, because it will make the editor unresponsive when creating the tooltip. You can use <see cref="M:Godot.EditorResourceTooltipPlugin.RequestThumbnail(System.String,Godot.TextureRect)"/> if you want to display a preview in your tooltip.</para>
|
||
<para><b>Note:</b> If you decide to discard the <paramref name="base"/>, make sure to call <see cref="M:Godot.Node.QueueFree"/>, because it's not freed automatically.</para>
|
||
<para><code>
|
||
func _make_tooltip_for_path(path, metadata, base):
|
||
var t_rect = TextureRect.new()
|
||
request_thumbnail(path, t_rect)
|
||
base.add_child(t_rect) # The TextureRect will appear at the bottom of the tooltip.
|
||
return base
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourceTooltipPlugin.RequestThumbnail(System.String,Godot.TextureRect)">
|
||
<summary>
|
||
<para>Requests a thumbnail for the given <see cref="T:Godot.TextureRect"/>. The thumbnail is created asynchronously by <see cref="T:Godot.EditorResourcePreview"/> and automatically set when available.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorResourceTooltipPlugin.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorResourceTooltipPlugin.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorResourceTooltipPlugin.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorResourceTooltipPlugin.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourceTooltipPlugin.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourceTooltipPlugin.MethodName._Handles">
|
||
<summary>
|
||
Cached name for the '_handles' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourceTooltipPlugin.MethodName._MakeTooltipForPath">
|
||
<summary>
|
||
Cached name for the '_make_tooltip_for_path' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorResourceTooltipPlugin.MethodName.RequestThumbnail">
|
||
<summary>
|
||
Cached name for the 'request_thumbnail' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorResourceTooltipPlugin.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporter">
|
||
<summary>
|
||
<para><see cref="T:Godot.EditorSceneFormatImporter"/> allows to define an importer script for a third-party 3D format.</para>
|
||
<para>To use <see cref="T:Godot.EditorSceneFormatImporter"/>, register it using the <see cref="M:Godot.EditorPlugin.AddSceneFormatImporterPlugin(Godot.EditorSceneFormatImporter,System.Boolean)"/> method first.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSceneFormatImporter.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSceneFormatImporter.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSceneFormatImporter.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporter.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporter.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSceneFormatImporter.MethodName._GetExtensions">
|
||
<summary>
|
||
Cached name for the '_get_extensions' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSceneFormatImporter.MethodName._GetImportFlags">
|
||
<summary>
|
||
Cached name for the '_get_import_flags' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSceneFormatImporter.MethodName._GetImportOptions">
|
||
<summary>
|
||
Cached name for the '_get_import_options' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSceneFormatImporter.MethodName._GetOptionVisibility">
|
||
<summary>
|
||
Cached name for the '_get_option_visibility' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSceneFormatImporter.MethodName._ImportScene">
|
||
<summary>
|
||
Cached name for the '_import_scene' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporter.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporterBlend">
|
||
<summary>
|
||
<para>Imports Blender scenes in the <c>.blend</c> file format through the glTF 2.0 3D import pipeline. This importer requires Blender to be installed by the user, so that it can be used to export the scene as glTF 2.0.</para>
|
||
<para>The location of the Blender binary is set via the <c>filesystem/import/blender/blender_path</c> editor setting.</para>
|
||
<para>This importer is only used if <c>ProjectSettings.filesystem/import/blender/enabled</c> is enabled, otherwise <c>.blend</c> files present in the project folder are not imported.</para>
|
||
<para>Blend import requires Blender 3.0.</para>
|
||
<para>Internally, the EditorSceneFormatImporterBlend uses the Blender glTF "Use Original" mode to reference external textures.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSceneFormatImporterBlend.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSceneFormatImporterBlend.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSceneFormatImporterBlend.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporterBlend.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporterBlend.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporterBlend.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporterFbx2Gltf">
|
||
<summary>
|
||
<para>Imports Autodesk FBX 3D scenes by way of converting them to glTF 2.0 using the FBX2glTF command line tool.</para>
|
||
<para>The location of the FBX2glTF binary is set via the <c>EditorSettings.filesystem/import/fbx/fbx2gltf_path</c> editor setting.</para>
|
||
<para>This importer is only used if <c>ProjectSettings.filesystem/import/fbx2gltf/enabled</c> is set to <see langword="true"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSceneFormatImporterFbx2Gltf.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSceneFormatImporterFbx2Gltf.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSceneFormatImporterFbx2Gltf.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporterFbx2Gltf.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporterFbx2Gltf.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporterFbx2Gltf.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSceneFormatImporterGltf.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSceneFormatImporterGltf.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSceneFormatImporterGltf.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporterGltf.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporterGltf.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporterGltf.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporterUfbx">
|
||
<summary>
|
||
<para>EditorSceneFormatImporterUFBX is designed to load FBX files and supports both binary and ASCII FBX files from version 3000 onward. This class supports various 3D object types like meshes, skins, blend shapes, materials, and rigging information. The class aims for feature parity with the official FBX SDK and supports FBX 7.4 specifications.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSceneFormatImporterUfbx.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSceneFormatImporterUfbx.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSceneFormatImporterUfbx.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporterUfbx.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporterUfbx.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSceneFormatImporterUfbx.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorScenePostImport">
|
||
<summary>
|
||
<para>Imported scenes can be automatically modified right after import by setting their <b>Custom Script</b> Import property to a <c>tool</c> script that inherits from this class.</para>
|
||
<para>The <see cref="M:Godot.EditorScenePostImport._PostImport(Godot.Node)"/> callback receives the imported scene's root node and returns the modified version of the scene:</para>
|
||
<para><code>
|
||
using Godot;
|
||
|
||
// This sample changes all node names.
|
||
// Called right after the scene is imported and gets the root node.
|
||
[Tool]
|
||
public partial class NodeRenamer : EditorScenePostImport
|
||
{
|
||
public override GodotObject _PostImport(Node scene)
|
||
{
|
||
// Change all node names to "modified_[oldnodename]"
|
||
Iterate(scene);
|
||
return scene; // Remember to return the imported scene
|
||
}
|
||
|
||
public void Iterate(Node node)
|
||
{
|
||
if (node != null)
|
||
{
|
||
node.Name = $"modified_{node.Name}";
|
||
foreach (Node child in node.GetChildren())
|
||
{
|
||
Iterate(child);
|
||
}
|
||
}
|
||
}
|
||
}
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImport._PostImport(Godot.Node)">
|
||
<summary>
|
||
<para>Called after the scene was imported. This method must return the modified version of the scene.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImport.GetSourceFile">
|
||
<summary>
|
||
<para>Returns the source file path which got imported (e.g. <c>res://scene.dae</c>).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImport.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImport.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImport.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorScenePostImport.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorScenePostImport.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScenePostImport.MethodName._PostImport">
|
||
<summary>
|
||
Cached name for the '_post_import' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScenePostImport.MethodName.GetSourceFile">
|
||
<summary>
|
||
Cached name for the 'get_source_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorScenePostImport.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorScenePostImportPlugin">
|
||
<summary>
|
||
<para>This plugin type exists to modify the process of importing scenes, allowing to change the content as well as add importer options at every stage of the process.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImportPlugin._GetImportOptions(System.String)">
|
||
<summary>
|
||
<para>Override to add general import options. These will appear in the main import dock on the editor. Add options via <see cref="M:Godot.EditorScenePostImportPlugin.AddImportOption(System.String,Godot.Variant)"/> and <see cref="M:Godot.EditorScenePostImportPlugin.AddImportOptionAdvanced(Godot.Variant.Type,System.String,Godot.Variant,Godot.PropertyHint,System.String,System.Int32)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImportPlugin._GetInternalImportOptions(System.Int32)">
|
||
<summary>
|
||
<para>Override to add internal import options. These will appear in the 3D scene import dialog. Add options via <see cref="M:Godot.EditorScenePostImportPlugin.AddImportOption(System.String,Godot.Variant)"/> and <see cref="M:Godot.EditorScenePostImportPlugin.AddImportOptionAdvanced(Godot.Variant.Type,System.String,Godot.Variant,Godot.PropertyHint,System.String,System.Int32)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImportPlugin._GetInternalOptionUpdateViewRequired(System.Int32,System.String)">
|
||
<summary>
|
||
<para>Should return <see langword="true"/> if the 3D view of the import dialog needs to update when changing the given option.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImportPlugin._GetInternalOptionVisibility(System.Int32,System.Boolean,System.String)">
|
||
<summary>
|
||
<para>Should return <see langword="true"/> to show the given option, <see langword="false"/> to hide the given option, or <see langword="null"/> to ignore.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImportPlugin._GetOptionVisibility(System.String,System.Boolean,System.String)">
|
||
<summary>
|
||
<para>Should return <see langword="true"/> to show the given option, <see langword="false"/> to hide the given option, or <see langword="null"/> to ignore.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImportPlugin._InternalProcess(System.Int32,Godot.Node,Godot.Node,Godot.Resource)">
|
||
<summary>
|
||
<para>Process a specific node or resource for a given category.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImportPlugin._PostProcess(Godot.Node)">
|
||
<summary>
|
||
<para>Post process the scene. This function is called after the final scene has been configured.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImportPlugin._PreProcess(Godot.Node)">
|
||
<summary>
|
||
<para>Pre Process the scene. This function is called right after the scene format loader loaded the scene and no changes have been made.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImportPlugin.GetOptionValue(Godot.StringName)">
|
||
<summary>
|
||
<para>Query the value of an option. This function can only be called from those querying visibility, or processing.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImportPlugin.AddImportOption(System.String,Godot.Variant)">
|
||
<summary>
|
||
<para>Add a specific import option (name and default value only). This function can only be called from <see cref="M:Godot.EditorScenePostImportPlugin._GetImportOptions(System.String)"/> and <see cref="M:Godot.EditorScenePostImportPlugin._GetInternalImportOptions(System.Int32)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImportPlugin.AddImportOptionAdvanced(Godot.Variant.Type,System.String,Godot.Variant,Godot.PropertyHint,System.String,System.Int32)">
|
||
<summary>
|
||
<para>Add a specific import option. This function can only be called from <see cref="M:Godot.EditorScenePostImportPlugin._GetImportOptions(System.String)"/> and <see cref="M:Godot.EditorScenePostImportPlugin._GetInternalImportOptions(System.Int32)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImportPlugin.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImportPlugin.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorScenePostImportPlugin.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorScenePostImportPlugin.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorScenePostImportPlugin.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScenePostImportPlugin.MethodName._GetImportOptions">
|
||
<summary>
|
||
Cached name for the '_get_import_options' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScenePostImportPlugin.MethodName._GetInternalImportOptions">
|
||
<summary>
|
||
Cached name for the '_get_internal_import_options' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScenePostImportPlugin.MethodName._GetInternalOptionUpdateViewRequired">
|
||
<summary>
|
||
Cached name for the '_get_internal_option_update_view_required' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScenePostImportPlugin.MethodName._GetInternalOptionVisibility">
|
||
<summary>
|
||
Cached name for the '_get_internal_option_visibility' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScenePostImportPlugin.MethodName._GetOptionVisibility">
|
||
<summary>
|
||
Cached name for the '_get_option_visibility' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScenePostImportPlugin.MethodName._InternalProcess">
|
||
<summary>
|
||
Cached name for the '_internal_process' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScenePostImportPlugin.MethodName._PostProcess">
|
||
<summary>
|
||
Cached name for the '_post_process' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScenePostImportPlugin.MethodName._PreProcess">
|
||
<summary>
|
||
Cached name for the '_pre_process' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScenePostImportPlugin.MethodName.GetOptionValue">
|
||
<summary>
|
||
Cached name for the 'get_option_value' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScenePostImportPlugin.MethodName.AddImportOption">
|
||
<summary>
|
||
Cached name for the 'add_import_option' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScenePostImportPlugin.MethodName.AddImportOptionAdvanced">
|
||
<summary>
|
||
Cached name for the 'add_import_option_advanced' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorScenePostImportPlugin.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorScript">
|
||
<summary>
|
||
<para>Scripts extending this class and implementing its <see cref="M:Godot.EditorScript._Run"/> method can be executed from the Script Editor's <b>File > Run</b> menu option (or by pressing Ctrl + Shift + X) while the editor is running. This is useful for adding custom in-editor functionality to Godot. For more complex additions, consider using <see cref="T:Godot.EditorPlugin"/>s instead.</para>
|
||
<para><b>Note:</b> Extending scripts need to have <c>tool</c> mode enabled.</para>
|
||
<para><b>Example:</b> Running the following script prints "Hello from the Godot Editor!":</para>
|
||
<para><code>
|
||
using Godot;
|
||
|
||
[Tool]
|
||
public partial class HelloEditor : EditorScript
|
||
{
|
||
public override void _Run()
|
||
{
|
||
GD.Print("Hello from the Godot Editor!");
|
||
}
|
||
}
|
||
</code></para>
|
||
<para><b>Note:</b> The script is run in the Editor context, which means the output is visible in the console window started with the Editor (stdout) instead of the usual Godot <b>Output</b> dock.</para>
|
||
<para><b>Note:</b> EditorScript is <see cref="T:Godot.RefCounted"/>, meaning it is destroyed when nothing references it. This can cause errors during asynchronous operations if there are no references to the script.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScript._Run">
|
||
<summary>
|
||
<para>This method is executed by the Editor when <b>File > Run</b> is used.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScript.AddRootNode(Godot.Node)">
|
||
<summary>
|
||
<para>Makes <paramref name="node"/> root of the currently opened scene. Only works if the scene is empty. If the <paramref name="node"/> is a scene instance, an inheriting scene will be created.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScript.GetScene">
|
||
<summary>
|
||
<para>Returns the edited (current) scene's root <see cref="T:Godot.Node"/>. Equivalent of <see cref="M:Godot.EditorInterface.GetEditedSceneRoot"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScript.GetEditorInterface">
|
||
<summary>
|
||
<para>Returns the <see cref="T:Godot.EditorInterface"/> singleton instance.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScript.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorScript.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorScript.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorScript.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorScript.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScript.MethodName._Run">
|
||
<summary>
|
||
Cached name for the '_run' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScript.MethodName.AddRootNode">
|
||
<summary>
|
||
Cached name for the 'add_root_node' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScript.MethodName.GetScene">
|
||
<summary>
|
||
Cached name for the 'get_scene' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScript.MethodName.GetEditorInterface">
|
||
<summary>
|
||
Cached name for the 'get_editor_interface' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorScript.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorScriptPicker">
|
||
<summary>
|
||
<para>Similar to <see cref="T:Godot.EditorResourcePicker"/> this <see cref="T:Godot.Control"/> node is used in the editor's Inspector dock, but only to edit the <c>script</c> property of a <see cref="T:Godot.Node"/>. Default options for creating new resources of all possible subtypes are replaced with dedicated buttons that open the "Attach Node Script" dialog. Can be used with <see cref="T:Godot.EditorInspectorPlugin"/> to recreate the same behavior.</para>
|
||
<para><b>Note:</b> You must set the <see cref="P:Godot.EditorScriptPicker.ScriptOwner"/> for the custom context menu items to work.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorScriptPicker.ScriptOwner">
|
||
<summary>
|
||
<para>The owner <see cref="T:Godot.Node"/> of the script property that holds the edited resource.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorScriptPicker.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorScriptPicker.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorScriptPicker.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorScriptPicker.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScriptPicker.PropertyName.ScriptOwner">
|
||
<summary>
|
||
Cached name for the 'script_owner' property.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorScriptPicker.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScriptPicker.MethodName.SetScriptOwner">
|
||
<summary>
|
||
Cached name for the 'set_script_owner' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorScriptPicker.MethodName.GetScriptOwner">
|
||
<summary>
|
||
Cached name for the 'get_script_owner' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorScriptPicker.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSelection">
|
||
<summary>
|
||
<para>This object manages the SceneTree selection in the editor.</para>
|
||
<para><b>Note:</b> This class shouldn't be instantiated directly. Instead, access the singleton using <see cref="M:Godot.EditorInterface.GetSelection"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSelection.Clear">
|
||
<summary>
|
||
<para>Clear the selection.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSelection.AddNode(Godot.Node)">
|
||
<summary>
|
||
<para>Adds a node to the selection.</para>
|
||
<para><b>Note:</b> The newly selected node will not be automatically edited in the inspector. If you want to edit a node, use <see cref="M:Godot.EditorInterface.EditNode(Godot.Node)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSelection.RemoveNode(Godot.Node)">
|
||
<summary>
|
||
<para>Removes a node from the selection.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSelection.GetSelectedNodes">
|
||
<summary>
|
||
<para>Returns the list of selected nodes.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSelection.GetTransformableSelectedNodes">
|
||
<summary>
|
||
<para>Returns the list of selected nodes, optimized for transform operations (i.e. moving them, rotating, etc.). This list can be used to avoid situations where a node is selected and is also a child/grandchild.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorSelection.SelectionChanged">
|
||
<summary>
|
||
<para>Emitted when the selection changes.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSelection.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSelection.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSelection.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorSelection.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSelection.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSelection.MethodName.Clear">
|
||
<summary>
|
||
Cached name for the 'clear' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSelection.MethodName.AddNode">
|
||
<summary>
|
||
Cached name for the 'add_node' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSelection.MethodName.RemoveNode">
|
||
<summary>
|
||
Cached name for the 'remove_node' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSelection.MethodName.GetSelectedNodes">
|
||
<summary>
|
||
Cached name for the 'get_selected_nodes' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSelection.MethodName.GetTransformableSelectedNodes">
|
||
<summary>
|
||
Cached name for the 'get_transformable_selected_nodes' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSelection.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSelection.SignalName.SelectionChanged">
|
||
<summary>
|
||
Cached name for the 'selection_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSettings">
|
||
<summary>
|
||
<para>Object that holds the project-independent editor settings. These settings are generally visible in the <b>Editor > Editor Settings</b> menu.</para>
|
||
<para>Property names use slash delimiters to distinguish sections. Setting values can be of any <see cref="T:Godot.Variant"/> type. It's recommended to use <c>snake_case</c> for editor settings to be consistent with the Godot editor itself.</para>
|
||
<para>Accessing the settings can be done using the following methods, such as:</para>
|
||
<para><code>
|
||
EditorSettings settings = EditorInterface.Singleton.GetEditorSettings();
|
||
// `settings.set("some/property", value)` also works as this class overrides `_set()` internally.
|
||
settings.SetSetting("some/property", Value);
|
||
// `settings.get("some/property", value)` also works as this class overrides `_get()` internally.
|
||
settings.GetSetting("some/property");
|
||
Godot.Collections.Array<Godot.Collections.Dictionary> listOfSettings = settings.GetPropertyList();
|
||
</code></para>
|
||
<para><b>Note:</b> This class shouldn't be instantiated directly. Instead, access the singleton using <see cref="M:Godot.EditorInterface.GetEditorSettings"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.NotificationEditorSettingsChanged">
|
||
<summary>
|
||
<para>Emitted after any editor setting has changed. It's used by various editor plugins to update their visuals on theme changes or logic on configuration changes.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.HasSetting(System.String)">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if the setting specified by <paramref name="name"/> exists, <see langword="false"/> otherwise.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.SetSetting(System.String,Godot.Variant)">
|
||
<summary>
|
||
<para>Sets the <paramref name="value"/> of the setting specified by <paramref name="name"/>. This is equivalent to using <see cref="M:Godot.GodotObject.Set(Godot.StringName,Godot.Variant)"/> on the EditorSettings instance.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.GetSetting(System.String)">
|
||
<summary>
|
||
<para>Returns the value of the setting specified by <paramref name="name"/>. This is equivalent to using <see cref="M:Godot.GodotObject.Get(Godot.StringName)"/> on the EditorSettings instance.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.Erase(System.String)">
|
||
<summary>
|
||
<para>Erases the setting whose name is specified by <paramref name="property"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.SetInitialValue(Godot.StringName,Godot.Variant,System.Boolean)">
|
||
<summary>
|
||
<para>Sets the initial value of the setting specified by <paramref name="name"/> to <paramref name="value"/>. This is used to provide a value for the Revert button in the Editor Settings. If <paramref name="updateCurrent"/> is <see langword="true"/>, the setting is reset to <paramref name="value"/> as well.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.AddPropertyInfo(Godot.Collections.Dictionary)">
|
||
<summary>
|
||
<para>Adds a custom property info to a property. The dictionary must contain:</para>
|
||
<para>- <c>name</c>: <see cref="T:System.String"/> (the name of the property)</para>
|
||
<para>- <c>type</c>: <see cref="T:System.Int32"/> (see <see cref="T:Godot.Variant.Type"/>)</para>
|
||
<para>- optionally <c>hint</c>: <see cref="T:System.Int32"/> (see <see cref="T:Godot.PropertyHint"/>) and <c>hint_string</c>: <see cref="T:System.String"/></para>
|
||
<para><code>
|
||
var settings = GetEditorInterface().GetEditorSettings();
|
||
settings.Set("category/property_name", 0);
|
||
|
||
var propertyInfo = new Godot.Collections.Dictionary
|
||
{
|
||
{"name", "category/propertyName"},
|
||
{"type", Variant.Type.Int},
|
||
{"hint", PropertyHint.Enum},
|
||
{"hint_string", "one,two,three"}
|
||
};
|
||
|
||
settings.AddPropertyInfo(propertyInfo);
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.SetProjectMetadata(System.String,System.String,Godot.Variant)">
|
||
<summary>
|
||
<para>Sets project-specific metadata with the <paramref name="section"/>, <paramref name="key"/> and <paramref name="data"/> specified. This metadata is stored outside the project folder and therefore won't be checked into version control. See also <see cref="M:Godot.EditorSettings.GetProjectMetadata(System.String,System.String,Godot.Variant)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.GetProjectMetadata(System.String,System.String,Godot.Variant)">
|
||
<summary>
|
||
<para>Returns project-specific metadata for the <paramref name="section"/> and <paramref name="key"/> specified. If the metadata doesn't exist, <paramref name="default"/> will be returned instead. See also <see cref="M:Godot.EditorSettings.SetProjectMetadata(System.String,System.String,Godot.Variant)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.SetFavorites(System.String[])">
|
||
<summary>
|
||
<para>Sets the list of favorite files and directories for this project.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.SetFavorites(System.ReadOnlySpan{System.String})">
|
||
<summary>
|
||
<para>Sets the list of favorite files and directories for this project.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.GetFavorites">
|
||
<summary>
|
||
<para>Returns the list of favorite files and directories for this project.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.SetRecentDirs(System.String[])">
|
||
<summary>
|
||
<para>Sets the list of recently visited folders in the file dialog for this project.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.SetRecentDirs(System.ReadOnlySpan{System.String})">
|
||
<summary>
|
||
<para>Sets the list of recently visited folders in the file dialog for this project.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.GetRecentDirs">
|
||
<summary>
|
||
<para>Returns the list of recently visited folders in the file dialog for this project.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.SetBuiltinActionOverride(System.String,Godot.Collections.Array{Godot.InputEvent})">
|
||
<summary>
|
||
<para>Overrides the built-in editor action <paramref name="name"/> with the input actions defined in <paramref name="actionsList"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.CheckChangedSettingsInGroup(System.String)">
|
||
<summary>
|
||
<para>Checks if any settings with the prefix <paramref name="settingPrefix"/> exist in the set of changed settings. See also <see cref="M:Godot.EditorSettings.GetChangedSettings"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.GetChangedSettings">
|
||
<summary>
|
||
<para>Gets an array of the settings which have been changed since the last save. Note that internally <c>changed_settings</c> is cleared after a successful save, so generally the most appropriate place to use this method is when processing <see cref="F:Godot.EditorSettings.NotificationEditorSettingsChanged"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.MarkSettingChanged(System.String)">
|
||
<summary>
|
||
<para>Marks the passed editor setting as being changed, see <see cref="M:Godot.EditorSettings.GetChangedSettings"/>. Only settings which exist (see <see cref="M:Godot.EditorSettings.HasSetting(System.String)"/>) will be accepted.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorSettings.SettingsChanged">
|
||
<summary>
|
||
<para>Emitted after any editor setting has changed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSettings.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorSettings.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSettings.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.MethodName.HasSetting">
|
||
<summary>
|
||
Cached name for the 'has_setting' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.MethodName.SetSetting">
|
||
<summary>
|
||
Cached name for the 'set_setting' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.MethodName.GetSetting">
|
||
<summary>
|
||
Cached name for the 'get_setting' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.MethodName.Erase">
|
||
<summary>
|
||
Cached name for the 'erase' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.MethodName.SetInitialValue">
|
||
<summary>
|
||
Cached name for the 'set_initial_value' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.MethodName.AddPropertyInfo">
|
||
<summary>
|
||
Cached name for the 'add_property_info' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.MethodName.SetProjectMetadata">
|
||
<summary>
|
||
Cached name for the 'set_project_metadata' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.MethodName.GetProjectMetadata">
|
||
<summary>
|
||
Cached name for the 'get_project_metadata' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.MethodName.SetFavorites">
|
||
<summary>
|
||
Cached name for the 'set_favorites' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.MethodName.GetFavorites">
|
||
<summary>
|
||
Cached name for the 'get_favorites' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.MethodName.SetRecentDirs">
|
||
<summary>
|
||
Cached name for the 'set_recent_dirs' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.MethodName.GetRecentDirs">
|
||
<summary>
|
||
Cached name for the 'get_recent_dirs' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.MethodName.SetBuiltinActionOverride">
|
||
<summary>
|
||
Cached name for the 'set_builtin_action_override' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.MethodName.CheckChangedSettingsInGroup">
|
||
<summary>
|
||
Cached name for the 'check_changed_settings_in_group' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.MethodName.GetChangedSettings">
|
||
<summary>
|
||
Cached name for the 'get_changed_settings' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.MethodName.MarkSettingChanged">
|
||
<summary>
|
||
Cached name for the 'mark_setting_changed' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSettings.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSettings.SignalName.SettingsChanged">
|
||
<summary>
|
||
Cached name for the 'settings_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSpinSlider">
|
||
<summary>
|
||
<para>This <see cref="T:Godot.Control"/> node is used in the editor's Inspector dock to allow editing of numeric values. Can be used with <see cref="T:Godot.EditorInspectorPlugin"/> to recreate the same behavior.</para>
|
||
<para>If the <see cref="P:Godot.Range.Step"/> value is <c>1</c>, the <see cref="T:Godot.EditorSpinSlider"/> will display up/down arrows, similar to <see cref="T:Godot.SpinBox"/>. If the <see cref="P:Godot.Range.Step"/> value is not <c>1</c>, a slider will be displayed instead.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorSpinSlider.Label">
|
||
<summary>
|
||
<para>The text that displays to the left of the value.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorSpinSlider.Suffix">
|
||
<summary>
|
||
<para>The suffix to display after the value (in a faded color). This should generally be a plural word. You may have to use an abbreviation if the suffix is too long to be displayed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorSpinSlider.ReadOnly">
|
||
<summary>
|
||
<para>If <see langword="true"/>, the slider can't be interacted with.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorSpinSlider.Flat">
|
||
<summary>
|
||
<para>If <see langword="true"/>, the slider will not draw background.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:Godot.EditorSpinSlider.HideSlider">
|
||
<summary>
|
||
<para>If <see langword="true"/>, the slider and up/down arrows are hidden.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorSpinSlider.Grabbed">
|
||
<summary>
|
||
<para>Emitted when the spinner/slider is grabbed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorSpinSlider.Ungrabbed">
|
||
<summary>
|
||
<para>Emitted when the spinner/slider is ungrabbed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorSpinSlider.UpdownPressed">
|
||
<summary>
|
||
<para>Emitted when the updown button is pressed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorSpinSlider.ValueFocusEntered">
|
||
<summary>
|
||
<para>Emitted when the value form gains focus.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.EditorSpinSlider.ValueFocusExited">
|
||
<summary>
|
||
<para>Emitted when the value form loses focus.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSpinSlider.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSpinSlider.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSpinSlider.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorSpinSlider.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.PropertyName.Label">
|
||
<summary>
|
||
Cached name for the 'label' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.PropertyName.Suffix">
|
||
<summary>
|
||
Cached name for the 'suffix' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.PropertyName.ReadOnly">
|
||
<summary>
|
||
Cached name for the 'read_only' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.PropertyName.Flat">
|
||
<summary>
|
||
Cached name for the 'flat' property.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.PropertyName.HideSlider">
|
||
<summary>
|
||
Cached name for the 'hide_slider' property.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSpinSlider.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.MethodName.SetLabel">
|
||
<summary>
|
||
Cached name for the 'set_label' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.MethodName.GetLabel">
|
||
<summary>
|
||
Cached name for the 'get_label' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.MethodName.SetSuffix">
|
||
<summary>
|
||
Cached name for the 'set_suffix' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.MethodName.GetSuffix">
|
||
<summary>
|
||
Cached name for the 'get_suffix' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.MethodName.SetReadOnly">
|
||
<summary>
|
||
Cached name for the 'set_read_only' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.MethodName.IsReadOnly">
|
||
<summary>
|
||
Cached name for the 'is_read_only' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.MethodName.SetFlat">
|
||
<summary>
|
||
Cached name for the 'set_flat' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.MethodName.IsFlat">
|
||
<summary>
|
||
Cached name for the 'is_flat' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.MethodName.SetHideSlider">
|
||
<summary>
|
||
Cached name for the 'set_hide_slider' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.MethodName.IsHidingSlider">
|
||
<summary>
|
||
Cached name for the 'is_hiding_slider' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSpinSlider.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.SignalName.Grabbed">
|
||
<summary>
|
||
Cached name for the 'grabbed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.SignalName.Ungrabbed">
|
||
<summary>
|
||
Cached name for the 'ungrabbed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.SignalName.UpdownPressed">
|
||
<summary>
|
||
Cached name for the 'updown_pressed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.SignalName.ValueFocusEntered">
|
||
<summary>
|
||
Cached name for the 'value_focus_entered' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSpinSlider.SignalName.ValueFocusExited">
|
||
<summary>
|
||
Cached name for the 'value_focus_exited' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSyntaxHighlighter">
|
||
<summary>
|
||
<para>Base class that all <see cref="T:Godot.SyntaxHighlighter"/>s used by the <see cref="T:Godot.ScriptEditor"/> extend from.</para>
|
||
<para>Add a syntax highlighter to an individual script by calling <see cref="M:Godot.ScriptEditorBase.AddSyntaxHighlighter(Godot.EditorSyntaxHighlighter)"/>. To apply to all scripts on open, call <see cref="M:Godot.ScriptEditor.RegisterSyntaxHighlighter(Godot.EditorSyntaxHighlighter)"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSyntaxHighlighter._GetName">
|
||
<summary>
|
||
<para>Virtual method which can be overridden to return the syntax highlighter name.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSyntaxHighlighter._GetSupportedLanguages">
|
||
<summary>
|
||
<para>Virtual method which can be overridden to return the supported language names.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorSyntaxHighlighter.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSyntaxHighlighter.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorSyntaxHighlighter.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorSyntaxHighlighter.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSyntaxHighlighter.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSyntaxHighlighter.MethodName._GetName">
|
||
<summary>
|
||
Cached name for the '_get_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorSyntaxHighlighter.MethodName._GetSupportedLanguages">
|
||
<summary>
|
||
Cached name for the '_get_supported_languages' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorSyntaxHighlighter.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorToaster">
|
||
<summary>
|
||
<para>This object manages the functionality and display of toast notifications within the editor, ensuring timely and informative alerts are presented to users.</para>
|
||
<para><b>Note:</b> This class shouldn't be instantiated directly. Instead, access the singleton using <see cref="M:Godot.EditorInterface.GetEditorToaster"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorToaster.Severity.Info">
|
||
<summary>
|
||
<para>Toast will display with an INFO severity.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorToaster.Severity.Warning">
|
||
<summary>
|
||
<para>Toast will display with a WARNING severity and have a corresponding color.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorToaster.Severity.Error">
|
||
<summary>
|
||
<para>Toast will display with an ERROR severity and have a corresponding color.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorToaster.PushToast(System.String,Godot.EditorToaster.Severity,System.String)">
|
||
<summary>
|
||
<para>Pushes a toast notification to the editor for display.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorToaster.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorToaster.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorToaster.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorToaster.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorToaster.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorToaster.MethodName.PushToast">
|
||
<summary>
|
||
Cached name for the 'push_toast' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorToaster.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorTranslationParserPlugin">
|
||
<summary>
|
||
<para><see cref="T:Godot.EditorTranslationParserPlugin"/> is invoked when a file is being parsed to extract strings that require translation. To define the parsing and string extraction logic, override the <see cref="M:Godot.EditorTranslationParserPlugin._ParseFile(System.String,Godot.Collections.Array{System.String},Godot.Collections.Array{Godot.Collections.Array})"/> method in script.</para>
|
||
<para>Add the extracted strings to argument <c>msgids</c> or <c>msgids_context_plural</c> if context or plural is used.</para>
|
||
<para>When adding to <c>msgids_context_plural</c>, you must add the data using the format <c>["A", "B", "C"]</c>, where <c>A</c> represents the extracted string, <c>B</c> represents the context, and <c>C</c> represents the plural version of the extracted string. If you want to add only context but not plural, put <c>""</c> for the plural slot. The idea is the same if you only want to add plural but not context. See the code below for concrete examples.</para>
|
||
<para>The extracted strings will be written into a POT file selected by user under "POT Generation" in "Localization" tab in "Project Settings" menu.</para>
|
||
<para>Below shows an example of a custom parser that extracts strings from a CSV file to write into a POT.</para>
|
||
<para><code>
|
||
using Godot;
|
||
|
||
[Tool]
|
||
public partial class CustomParser : EditorTranslationParserPlugin
|
||
{
|
||
public override void _ParseFile(string path, Godot.Collections.Array<string> msgids, Godot.Collections.Array<Godot.Collections.Array> msgidsContextPlural)
|
||
{
|
||
using var file = FileAccess.Open(path, FileAccess.ModeFlags.Read);
|
||
string text = file.GetAsText();
|
||
string[] splitStrs = text.Split(",", allowEmpty: false);
|
||
foreach (string s in splitStrs)
|
||
{
|
||
msgids.Add(s);
|
||
//GD.Print($"Extracted string: {s}");
|
||
}
|
||
}
|
||
|
||
public override string[] _GetRecognizedExtensions()
|
||
{
|
||
return new string[] { "csv" };
|
||
}
|
||
}
|
||
</code></para>
|
||
<para>To add a translatable string associated with context or plural, add it to <c>msgids_context_plural</c>:</para>
|
||
<para><code>
|
||
// This will add a message with msgid "Test 1", msgctxt "context", and msgid_plural "test 1 plurals".
|
||
msgidsContextPlural.Add(new Godot.Collections.Array{"Test 1", "context", "test 1 Plurals"});
|
||
// This will add a message with msgid "A test without context" and msgid_plural "plurals".
|
||
msgidsContextPlural.Add(new Godot.Collections.Array{"A test without context", "", "plurals"});
|
||
// This will add a message with msgid "Only with context" and msgctxt "a friendly context".
|
||
msgidsContextPlural.Add(new Godot.Collections.Array{"Only with context", "a friendly context", ""});
|
||
</code></para>
|
||
<para><b>Note:</b> If you override parsing logic for standard script types (GDScript, C#, etc.), it would be better to load the <c>path</c> argument using <see cref="M:Godot.ResourceLoader.Load(System.String,System.String,Godot.ResourceLoader.CacheMode)"/>. This is because built-in scripts are loaded as <see cref="T:Godot.Resource"/> type, not <see cref="T:Godot.FileAccess"/> type. For example:</para>
|
||
<para><code>
|
||
public override void _ParseFile(string path, Godot.Collections.Array<string> msgids, Godot.Collections.Array<Godot.Collections.Array> msgidsContextPlural)
|
||
{
|
||
var res = ResourceLoader.Load<Script>(path, "Script");
|
||
string text = res.SourceCode;
|
||
// Parsing logic.
|
||
}
|
||
|
||
public override string[] _GetRecognizedExtensions()
|
||
{
|
||
return new string[] { "gd" };
|
||
}
|
||
</code></para>
|
||
<para>To use <see cref="T:Godot.EditorTranslationParserPlugin"/>, register it using the <see cref="M:Godot.EditorPlugin.AddTranslationParserPlugin(Godot.EditorTranslationParserPlugin)"/> method first.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorTranslationParserPlugin._GetComments(Godot.Collections.Array{System.String},Godot.Collections.Array{System.String})">
|
||
<summary>
|
||
<para>If overridden, called after <see cref="M:Godot.EditorTranslationParserPlugin._ParseFile(System.String,Godot.Collections.Array{System.String},Godot.Collections.Array{Godot.Collections.Array})"/> to get comments for the parsed entries. This method should fill the arrays with the same number of elements and in the same order as <see cref="M:Godot.EditorTranslationParserPlugin._ParseFile(System.String,Godot.Collections.Array{System.String},Godot.Collections.Array{Godot.Collections.Array})"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorTranslationParserPlugin._GetRecognizedExtensions">
|
||
<summary>
|
||
<para>Gets the list of file extensions to associate with this parser, e.g. <c>["csv"]</c>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorTranslationParserPlugin._ParseFile(System.String,Godot.Collections.Array{System.String},Godot.Collections.Array{Godot.Collections.Array})">
|
||
<summary>
|
||
<para>Override this method to define a custom parsing logic to extract the translatable strings.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorTranslationParserPlugin.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorTranslationParserPlugin.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorTranslationParserPlugin.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorTranslationParserPlugin.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorTranslationParserPlugin.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorTranslationParserPlugin.MethodName._GetComments">
|
||
<summary>
|
||
Cached name for the '_get_comments' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorTranslationParserPlugin.MethodName._GetRecognizedExtensions">
|
||
<summary>
|
||
Cached name for the '_get_recognized_extensions' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorTranslationParserPlugin.MethodName._ParseFile">
|
||
<summary>
|
||
Cached name for the '_parse_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorTranslationParserPlugin.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorVcsInterface">
|
||
<summary>
|
||
<para>Defines the API that the editor uses to extract information from the underlying VCS. The implementation of this API is included in VCS plugins, which are GDExtension plugins that inherit <see cref="T:Godot.EditorVcsInterface"/> and are attached (on demand) to the singleton instance of <see cref="T:Godot.EditorVcsInterface"/>. Instead of performing the task themselves, all the virtual functions listed below are calling the internally overridden functions in the VCS plugins to provide a plug-n-play experience. A custom VCS plugin is supposed to inherit from <see cref="T:Godot.EditorVcsInterface"/> and override each of these virtual functions.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.ChangeType.New">
|
||
<summary>
|
||
<para>A new file has been added.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.ChangeType.Modified">
|
||
<summary>
|
||
<para>An earlier added file has been modified.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.ChangeType.Renamed">
|
||
<summary>
|
||
<para>An earlier added file has been renamed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.ChangeType.Deleted">
|
||
<summary>
|
||
<para>An earlier added file has been deleted.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.ChangeType.Typechange">
|
||
<summary>
|
||
<para>An earlier added file has been typechanged.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.ChangeType.Unmerged">
|
||
<summary>
|
||
<para>A file is left unmerged.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.TreeArea.Commit">
|
||
<summary>
|
||
<para>A commit is encountered from the commit area.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.TreeArea.Staged">
|
||
<summary>
|
||
<para>A file is encountered from the staged area.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.TreeArea.Unstaged">
|
||
<summary>
|
||
<para>A file is encountered from the unstaged area.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._CheckoutBranch(System.String)">
|
||
<summary>
|
||
<para>Checks out a <paramref name="branchName"/> in the VCS.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._Commit(System.String)">
|
||
<summary>
|
||
<para>Commits the currently staged changes and applies the commit <paramref name="msg"/> to the resulting commit.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._CreateBranch(System.String)">
|
||
<summary>
|
||
<para>Creates a new branch named <paramref name="branchName"/> in the VCS.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._CreateRemote(System.String,System.String)">
|
||
<summary>
|
||
<para>Creates a new remote destination with name <paramref name="remoteName"/> and points it to <paramref name="remoteUrl"/>. This can be an HTTPS remote or an SSH remote.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._DiscardFile(System.String)">
|
||
<summary>
|
||
<para>Discards the changes made in a file present at <paramref name="filePath"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._Fetch(System.String)">
|
||
<summary>
|
||
<para>Fetches new changes from the <paramref name="remote"/>, but doesn't write changes to the current working directory. Equivalent to <c>git fetch</c>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._GetBranchList">
|
||
<summary>
|
||
<para>Gets an instance of an <see cref="T:Godot.Collections.Array"/> of <see cref="T:System.String"/>s containing available branch names in the VCS.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._GetCurrentBranchName">
|
||
<summary>
|
||
<para>Gets the current branch name defined in the VCS.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._GetDiff(System.String,System.Int32)">
|
||
<summary>
|
||
<para>Returns an array of <see cref="T:Godot.Collections.Dictionary"/> items (see <see cref="M:Godot.EditorVcsInterface.CreateDiffFile(System.String,System.String)"/>, <see cref="M:Godot.EditorVcsInterface.CreateDiffHunk(System.Int32,System.Int32,System.Int32,System.Int32)"/>, <see cref="M:Godot.EditorVcsInterface.CreateDiffLine(System.Int32,System.Int32,System.String,System.String)"/>, <see cref="M:Godot.EditorVcsInterface.AddLineDiffsIntoDiffHunk(Godot.Collections.Dictionary,Godot.Collections.Array{Godot.Collections.Dictionary})"/> and <see cref="M:Godot.EditorVcsInterface.AddDiffHunksIntoDiffFile(Godot.Collections.Dictionary,Godot.Collections.Array{Godot.Collections.Dictionary})"/>), each containing information about a diff. If <paramref name="identifier"/> is a file path, returns a file diff, and if it is a commit identifier, then returns a commit diff.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._GetLineDiff(System.String,System.String)">
|
||
<summary>
|
||
<para>Returns an <see cref="T:Godot.Collections.Array"/> of <see cref="T:Godot.Collections.Dictionary"/> items (see <see cref="M:Godot.EditorVcsInterface.CreateDiffHunk(System.Int32,System.Int32,System.Int32,System.Int32)"/>), each containing a line diff between a file at <paramref name="filePath"/> and the <paramref name="text"/> which is passed in.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._GetModifiedFilesData">
|
||
<summary>
|
||
<para>Returns an <see cref="T:Godot.Collections.Array"/> of <see cref="T:Godot.Collections.Dictionary"/> items (see <see cref="M:Godot.EditorVcsInterface.CreateStatusFile(System.String,Godot.EditorVcsInterface.ChangeType,Godot.EditorVcsInterface.TreeArea)"/>), each containing the status data of every modified file in the project folder.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._GetPreviousCommits(System.Int32)">
|
||
<summary>
|
||
<para>Returns an <see cref="T:Godot.Collections.Array"/> of <see cref="T:Godot.Collections.Dictionary"/> items (see <see cref="M:Godot.EditorVcsInterface.CreateCommit(System.String,System.String,System.String,System.Int64,System.Int64)"/>), each containing the data for a past commit.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._GetRemotes">
|
||
<summary>
|
||
<para>Returns an <see cref="T:Godot.Collections.Array"/> of <see cref="T:System.String"/>s, each containing the name of a remote configured in the VCS.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._GetVcsName">
|
||
<summary>
|
||
<para>Returns the name of the underlying VCS provider.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._Initialize(System.String)">
|
||
<summary>
|
||
<para>Initializes the VCS plugin when called from the editor. Returns whether or not the plugin was successfully initialized. A VCS project is initialized at <paramref name="projectPath"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._Pull(System.String)">
|
||
<summary>
|
||
<para>Pulls changes from the remote. This can give rise to merge conflicts.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._Push(System.String,System.Boolean)">
|
||
<summary>
|
||
<para>Pushes changes to the <paramref name="remote"/>. If <paramref name="force"/> is <see langword="true"/>, a force push will override the change history already present on the remote.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._RemoveBranch(System.String)">
|
||
<summary>
|
||
<para>Remove a branch from the local VCS.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._RemoveRemote(System.String)">
|
||
<summary>
|
||
<para>Remove a remote from the local VCS.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._SetCredentials(System.String,System.String,System.String,System.String,System.String)">
|
||
<summary>
|
||
<para>Set user credentials in the underlying VCS. <paramref name="userName"/> and <paramref name="password"/> are used only during HTTPS authentication unless not already mentioned in the remote URL. <paramref name="sshPublicKeyPath"/>, <paramref name="sshPrivateKeyPath"/>, and <paramref name="sshPassphrase"/> are only used during SSH authentication.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._ShutDown">
|
||
<summary>
|
||
<para>Shuts down VCS plugin instance. Called when the user either closes the editor or shuts down the VCS plugin through the editor UI.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._StageFile(System.String)">
|
||
<summary>
|
||
<para>Stages the file present at <paramref name="filePath"/> to the staged area.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface._UnstageFile(System.String)">
|
||
<summary>
|
||
<para>Unstages the file present at <paramref name="filePath"/> from the staged area to the unstaged area.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface.CreateDiffLine(System.Int32,System.Int32,System.String,System.String)">
|
||
<summary>
|
||
<para>Helper function to create a <see cref="T:Godot.Collections.Dictionary"/> for storing a line diff. <paramref name="newLineNo"/> is the line number in the new file (can be <c>-1</c> if the line is deleted). <paramref name="oldLineNo"/> is the line number in the old file (can be <c>-1</c> if the line is added). <paramref name="content"/> is the diff text. <paramref name="status"/> is a single character string which stores the line origin.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface.CreateDiffHunk(System.Int32,System.Int32,System.Int32,System.Int32)">
|
||
<summary>
|
||
<para>Helper function to create a <see cref="T:Godot.Collections.Dictionary"/> for storing diff hunk data. <paramref name="oldStart"/> is the starting line number in old file. <paramref name="newStart"/> is the starting line number in new file. <paramref name="oldLines"/> is the number of lines in the old file. <paramref name="newLines"/> is the number of lines in the new file.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface.CreateDiffFile(System.String,System.String)">
|
||
<summary>
|
||
<para>Helper function to create a <see cref="T:Godot.Collections.Dictionary"/> for storing old and new diff file paths.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface.CreateCommit(System.String,System.String,System.String,System.Int64,System.Int64)">
|
||
<summary>
|
||
<para>Helper function to create a commit <see cref="T:Godot.Collections.Dictionary"/> item. <paramref name="msg"/> is the commit message of the commit. <paramref name="author"/> is a single human-readable string containing all the author's details, e.g. the email and name configured in the VCS. <paramref name="id"/> is the identifier of the commit, in whichever format your VCS may provide an identifier to commits. <paramref name="unixTimestamp"/> is the UTC Unix timestamp of when the commit was created. <paramref name="offsetMinutes"/> is the timezone offset in minutes, recorded from the system timezone where the commit was created.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface.CreateStatusFile(System.String,Godot.EditorVcsInterface.ChangeType,Godot.EditorVcsInterface.TreeArea)">
|
||
<summary>
|
||
<para>Helper function to create a <see cref="T:Godot.Collections.Dictionary"/> used by editor to read the status of a file.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface.AddDiffHunksIntoDiffFile(Godot.Collections.Dictionary,Godot.Collections.Array{Godot.Collections.Dictionary})">
|
||
<summary>
|
||
<para>Helper function to add an array of <paramref name="diffHunks"/> into a <paramref name="diffFile"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface.AddLineDiffsIntoDiffHunk(Godot.Collections.Dictionary,Godot.Collections.Array{Godot.Collections.Dictionary})">
|
||
<summary>
|
||
<para>Helper function to add an array of <paramref name="lineDiffs"/> into a <paramref name="diffHunk"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface.PopupError(System.String)">
|
||
<summary>
|
||
<para>Pops up an error message in the editor which is shown as coming from the underlying VCS. Use this to show VCS specific error messages.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.EditorVcsInterface.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.EditorVcsInterface.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorVcsInterface.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._CheckoutBranch">
|
||
<summary>
|
||
Cached name for the '_checkout_branch' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._Commit">
|
||
<summary>
|
||
Cached name for the '_commit' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._CreateBranch">
|
||
<summary>
|
||
Cached name for the '_create_branch' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._CreateRemote">
|
||
<summary>
|
||
Cached name for the '_create_remote' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._DiscardFile">
|
||
<summary>
|
||
Cached name for the '_discard_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._Fetch">
|
||
<summary>
|
||
Cached name for the '_fetch' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._GetBranchList">
|
||
<summary>
|
||
Cached name for the '_get_branch_list' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._GetCurrentBranchName">
|
||
<summary>
|
||
Cached name for the '_get_current_branch_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._GetDiff">
|
||
<summary>
|
||
Cached name for the '_get_diff' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._GetLineDiff">
|
||
<summary>
|
||
Cached name for the '_get_line_diff' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._GetModifiedFilesData">
|
||
<summary>
|
||
Cached name for the '_get_modified_files_data' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._GetPreviousCommits">
|
||
<summary>
|
||
Cached name for the '_get_previous_commits' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._GetRemotes">
|
||
<summary>
|
||
Cached name for the '_get_remotes' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._GetVcsName">
|
||
<summary>
|
||
Cached name for the '_get_vcs_name' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._Initialize">
|
||
<summary>
|
||
Cached name for the '_initialize' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._Pull">
|
||
<summary>
|
||
Cached name for the '_pull' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._Push">
|
||
<summary>
|
||
Cached name for the '_push' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._RemoveBranch">
|
||
<summary>
|
||
Cached name for the '_remove_branch' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._RemoveRemote">
|
||
<summary>
|
||
Cached name for the '_remove_remote' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._SetCredentials">
|
||
<summary>
|
||
Cached name for the '_set_credentials' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._ShutDown">
|
||
<summary>
|
||
Cached name for the '_shut_down' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._StageFile">
|
||
<summary>
|
||
Cached name for the '_stage_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName._UnstageFile">
|
||
<summary>
|
||
Cached name for the '_unstage_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName.CreateDiffLine">
|
||
<summary>
|
||
Cached name for the 'create_diff_line' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName.CreateDiffHunk">
|
||
<summary>
|
||
Cached name for the 'create_diff_hunk' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName.CreateDiffFile">
|
||
<summary>
|
||
Cached name for the 'create_diff_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName.CreateCommit">
|
||
<summary>
|
||
Cached name for the 'create_commit' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName.CreateStatusFile">
|
||
<summary>
|
||
Cached name for the 'create_status_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName.AddDiffHunksIntoDiffFile">
|
||
<summary>
|
||
Cached name for the 'add_diff_hunks_into_diff_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName.AddLineDiffsIntoDiffHunk">
|
||
<summary>
|
||
Cached name for the 'add_line_diffs_into_diff_hunk' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.EditorVcsInterface.MethodName.PopupError">
|
||
<summary>
|
||
Cached name for the 'popup_error' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.EditorVcsInterface.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.FileSystemDock">
|
||
<summary>
|
||
<para>This class is available only in <see cref="T:Godot.EditorPlugin"/>s and can't be instantiated. You can access it using <see cref="M:Godot.EditorInterface.GetFileSystemDock"/>.</para>
|
||
<para>While <see cref="T:Godot.FileSystemDock"/> doesn't expose any methods for file manipulation, it can listen for various file-related signals.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.FileSystemDock.NavigateToPath(System.String)">
|
||
<summary>
|
||
<para>Sets the given <paramref name="path"/> as currently selected, ensuring that the selected file/directory is visible.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.FileSystemDock.AddResourceTooltipPlugin(Godot.EditorResourceTooltipPlugin)">
|
||
<summary>
|
||
<para>Registers a new <see cref="T:Godot.EditorResourceTooltipPlugin"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.FileSystemDock.RemoveResourceTooltipPlugin(Godot.EditorResourceTooltipPlugin)">
|
||
<summary>
|
||
<para>Removes an <see cref="T:Godot.EditorResourceTooltipPlugin"/>. Fails if the plugin wasn't previously added.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.FileSystemDock.InheritEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.FileSystemDock.Inherit"/> event of a <see cref="T:Godot.FileSystemDock"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.FileSystemDock.Inherit">
|
||
<summary>
|
||
<para>Emitted when a new scene is created that inherits the scene at <c>file</c> path.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.FileSystemDock.InstantiateEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.FileSystemDock.Instantiate"/> event of a <see cref="T:Godot.FileSystemDock"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.FileSystemDock.Instantiate">
|
||
<summary>
|
||
<para>Emitted when the given scenes are being instantiated in the editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.FileSystemDock.ResourceRemovedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.FileSystemDock.ResourceRemoved"/> event of a <see cref="T:Godot.FileSystemDock"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.FileSystemDock.ResourceRemoved">
|
||
<summary>
|
||
<para>Emitted when an external <c>resource</c> had its file removed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.FileSystemDock.FileRemovedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.FileSystemDock.FileRemoved"/> event of a <see cref="T:Godot.FileSystemDock"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.FileSystemDock.FileRemoved">
|
||
<summary>
|
||
<para>Emitted when the given <c>file</c> was removed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.FileSystemDock.FolderRemovedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.FileSystemDock.FolderRemoved"/> event of a <see cref="T:Godot.FileSystemDock"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.FileSystemDock.FolderRemoved">
|
||
<summary>
|
||
<para>Emitted when the given <c>folder</c> was removed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.FileSystemDock.FilesMovedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.FileSystemDock.FilesMoved"/> event of a <see cref="T:Godot.FileSystemDock"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.FileSystemDock.FilesMoved">
|
||
<summary>
|
||
<para>Emitted when a file is moved from <c>oldFile</c> path to <c>newFile</c> path.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.FileSystemDock.FolderMovedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.FileSystemDock.FolderMoved"/> event of a <see cref="T:Godot.FileSystemDock"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.FileSystemDock.FolderMoved">
|
||
<summary>
|
||
<para>Emitted when a folder is moved from <c>oldFolder</c> path to <c>newFolder</c> path.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.FileSystemDock.FolderColorChanged">
|
||
<summary>
|
||
<para>Emitted when folders change color.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.FileSystemDock.DisplayModeChanged">
|
||
<summary>
|
||
<para>Emitted when the user switches file display mode or split mode.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.FileSystemDock.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.FileSystemDock.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.FileSystemDock.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.FileSystemDock.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.FileSystemDock.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.FileSystemDock.MethodName.NavigateToPath">
|
||
<summary>
|
||
Cached name for the 'navigate_to_path' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.FileSystemDock.MethodName.AddResourceTooltipPlugin">
|
||
<summary>
|
||
Cached name for the 'add_resource_tooltip_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.FileSystemDock.MethodName.RemoveResourceTooltipPlugin">
|
||
<summary>
|
||
Cached name for the 'remove_resource_tooltip_plugin' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.FileSystemDock.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.FileSystemDock.SignalName.Inherit">
|
||
<summary>
|
||
Cached name for the 'inherit' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.FileSystemDock.SignalName.Instantiate">
|
||
<summary>
|
||
Cached name for the 'instantiate' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.FileSystemDock.SignalName.ResourceRemoved">
|
||
<summary>
|
||
Cached name for the 'resource_removed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.FileSystemDock.SignalName.FileRemoved">
|
||
<summary>
|
||
Cached name for the 'file_removed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.FileSystemDock.SignalName.FolderRemoved">
|
||
<summary>
|
||
Cached name for the 'folder_removed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.FileSystemDock.SignalName.FilesMoved">
|
||
<summary>
|
||
Cached name for the 'files_moved' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.FileSystemDock.SignalName.FolderMoved">
|
||
<summary>
|
||
Cached name for the 'folder_moved' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.FileSystemDock.SignalName.FolderColorChanged">
|
||
<summary>
|
||
Cached name for the 'folder_color_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.FileSystemDock.SignalName.DisplayModeChanged">
|
||
<summary>
|
||
Cached name for the 'display_mode_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.GDScriptSyntaxHighlighter">
|
||
<summary>
|
||
<para><b>Note:</b> This class can only be used for editor plugins because it relies on editor settings.</para>
|
||
<para><code>
|
||
var codePreview = new TextEdit();
|
||
var highlighter = new GDScriptSyntaxHighlighter();
|
||
codePreview.SyntaxHighlighter = highlighter;
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.GDScriptSyntaxHighlighter.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.GDScriptSyntaxHighlighter.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.GDScriptSyntaxHighlighter.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.GDScriptSyntaxHighlighter.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.GDScriptSyntaxHighlighter.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.GDScriptSyntaxHighlighter.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.GridMapEditorPlugin">
|
||
<summary>
|
||
<para>GridMapEditorPlugin provides access to the <see cref="T:Godot.GridMap"/> editor functionality.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.GridMapEditorPlugin.GetCurrentGridMap">
|
||
<summary>
|
||
<para>Returns the <see cref="T:Godot.GridMap"/> node currently edited by the grid map editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.GridMapEditorPlugin.SetSelection(Godot.Vector3I,Godot.Vector3I)">
|
||
<summary>
|
||
<para>Selects the cells inside the given bounds from <paramref name="begin"/> to <paramref name="end"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.GridMapEditorPlugin.ClearSelection">
|
||
<summary>
|
||
<para>Deselects any currently selected cells.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.GridMapEditorPlugin.GetSelection">
|
||
<summary>
|
||
<para>Returns the cell coordinate bounds of the current selection. Use <see cref="M:Godot.GridMapEditorPlugin.HasSelection"/> to check if there is an active selection.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.GridMapEditorPlugin.HasSelection">
|
||
<summary>
|
||
<para>Returns <see langword="true"/> if there are selected cells.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.GridMapEditorPlugin.GetSelectedCells">
|
||
<summary>
|
||
<para>Returns an array of <see cref="T:Godot.Vector3I"/>s with the selected cells' coordinates.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.GridMapEditorPlugin.SetSelectedPaletteItem(System.Int32)">
|
||
<summary>
|
||
<para>Selects the <see cref="T:Godot.MeshLibrary"/> item with the given index in the grid map editor's palette. If a negative index is given, no item will be selected. If a value greater than the last index is given, the last item will be selected.</para>
|
||
<para><b>Note:</b> The indices might not be in the same order as they appear in the editor's interface.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.GridMapEditorPlugin.GetSelectedPaletteItem">
|
||
<summary>
|
||
<para>Returns the index of the selected <see cref="T:Godot.MeshLibrary"/> item in the grid map editor's palette or <c>-1</c> if no item is selected.</para>
|
||
<para><b>Note:</b> The indices might not be in the same order as they appear in the editor's interface.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.GridMapEditorPlugin.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.GridMapEditorPlugin.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.GridMapEditorPlugin.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.GridMapEditorPlugin.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.GridMapEditorPlugin.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.GridMapEditorPlugin.MethodName.GetCurrentGridMap">
|
||
<summary>
|
||
Cached name for the 'get_current_grid_map' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.GridMapEditorPlugin.MethodName.SetSelection">
|
||
<summary>
|
||
Cached name for the 'set_selection' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.GridMapEditorPlugin.MethodName.ClearSelection">
|
||
<summary>
|
||
Cached name for the 'clear_selection' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.GridMapEditorPlugin.MethodName.GetSelection">
|
||
<summary>
|
||
Cached name for the 'get_selection' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.GridMapEditorPlugin.MethodName.HasSelection">
|
||
<summary>
|
||
Cached name for the 'has_selection' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.GridMapEditorPlugin.MethodName.GetSelectedCells">
|
||
<summary>
|
||
Cached name for the 'get_selected_cells' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.GridMapEditorPlugin.MethodName.SetSelectedPaletteItem">
|
||
<summary>
|
||
Cached name for the 'set_selected_palette_item' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.GridMapEditorPlugin.MethodName.GetSelectedPaletteItem">
|
||
<summary>
|
||
Cached name for the 'get_selected_palette_item' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.GridMapEditorPlugin.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterBMFont">
|
||
<summary>
|
||
<para>The BMFont format is a format created by the <a href="https://www.angelcode.com/products/bmfont/">BMFont</a> program. Many BMFont-compatible programs also exist, like <a href="https://www.bmglyph.com/">BMGlyph</a>.</para>
|
||
<para>Compared to <see cref="T:Godot.ResourceImporterImageFont"/>, <see cref="T:Godot.ResourceImporterBMFont"/> supports bitmap fonts with varying glyph widths/heights.</para>
|
||
<para>See also <see cref="T:Godot.ResourceImporterDynamicFont"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterBMFont.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterBMFont.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterBMFont.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterBMFont.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterBMFont.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterBMFont.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterBitMap">
|
||
<summary>
|
||
<para><see cref="T:Godot.Bitmap"/> resources are typically used as click masks in <see cref="T:Godot.TextureButton"/> and <see cref="T:Godot.TouchScreenButton"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterBitMap.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterBitMap.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterBitMap.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterBitMap.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterBitMap.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterBitMap.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterCsvTranslation">
|
||
<summary>
|
||
<para>Comma-separated values are a plain text table storage format. The format's simplicity makes it easy to edit in any text editor or spreadsheet software. This makes it a common choice for game localization.</para>
|
||
<para><b>Example CSV file:</b></para>
|
||
<para><code>
|
||
keys,en,es,ja
|
||
GREET,"Hello, friend!","Hola, amigo!",こんにちは
|
||
ASK,How are you?,Cómo está?,元気ですか
|
||
BYE,Goodbye,Adiós,さようなら
|
||
QUOTE,"""Hello"" said the man.","""Hola"" dijo el hombre.",「こんにちは」男は言いました
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterCsvTranslation.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterCsvTranslation.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterCsvTranslation.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterCsvTranslation.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterCsvTranslation.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterCsvTranslation.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterDynamicFont">
|
||
<summary>
|
||
<para>Unlike bitmap fonts, dynamic fonts can be resized to any size and still look crisp. Dynamic fonts also optionally support MSDF font rendering, which allows for run-time scale changes with no re-rasterization cost.</para>
|
||
<para>While WOFF and especially WOFF2 tend to result in smaller file sizes, there is no universally "better" font format. In most situations, it's recommended to use the font format that was shipped on the font developer's website.</para>
|
||
<para>See also <see cref="T:Godot.ResourceImporterBMFont"/> and <see cref="T:Godot.ResourceImporterImageFont"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterDynamicFont.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterDynamicFont.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterDynamicFont.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterDynamicFont.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterDynamicFont.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterDynamicFont.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterImage">
|
||
<summary>
|
||
<para>This importer imports <see cref="T:Godot.Image"/> resources, as opposed to <see cref="T:Godot.CompressedTexture2D"/>. If you need to render the image in 2D or 3D, use <see cref="T:Godot.ResourceImporterTexture"/> instead.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterImage.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterImage.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterImage.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterImage.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterImage.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterImage.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterImageFont">
|
||
<summary>
|
||
<para>This image-based workflow can be easier to use than <see cref="T:Godot.ResourceImporterBMFont"/>, but it requires all glyphs to have the same width and height, glyph advances and drawing offsets can be customized. This makes <see cref="T:Godot.ResourceImporterImageFont"/> most suited to fixed-width fonts.</para>
|
||
<para>See also <see cref="T:Godot.ResourceImporterDynamicFont"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterImageFont.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterImageFont.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterImageFont.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterImageFont.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterImageFont.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterImageFont.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterLayeredTexture">
|
||
<summary>
|
||
<para>This imports a 3-dimensional texture, which can then be used in custom shaders, as a <see cref="T:Godot.FogMaterial"/> density map or as a <see cref="T:Godot.GpuParticlesAttractorVectorField3D"/>. See also <see cref="T:Godot.ResourceImporterTexture"/> and <see cref="T:Godot.ResourceImporterTextureAtlas"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterLayeredTexture.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterLayeredTexture.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterLayeredTexture.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterLayeredTexture.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterLayeredTexture.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterLayeredTexture.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterMP3">
|
||
<summary>
|
||
<para>MP3 is a lossy audio format, with worse audio quality compared to <see cref="T:Godot.ResourceImporterOggVorbis"/> at a given bitrate.</para>
|
||
<para>In most cases, it's recommended to use Ogg Vorbis over MP3. However, if you're using an MP3 sound source with no higher quality source available, then it's recommended to use the MP3 file directly to avoid double lossy compression.</para>
|
||
<para>MP3 requires more CPU to decode than <see cref="T:Godot.ResourceImporterWav"/>. If you need to play a lot of simultaneous sounds, it's recommended to use WAV for those sounds instead, especially if targeting low-end devices.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterMP3.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterMP3.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterMP3.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterMP3.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterMP3.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterMP3.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterObj">
|
||
<summary>
|
||
<para>Unlike <see cref="T:Godot.ResourceImporterScene"/>, <see cref="T:Godot.ResourceImporterObj"/> will import a single <see cref="T:Godot.Mesh"/> resource by default instead of importing a <see cref="T:Godot.PackedScene"/>. This makes it easier to use the <see cref="T:Godot.Mesh"/> resource in nodes that expect direct <see cref="T:Godot.Mesh"/> resources, such as <see cref="T:Godot.GridMap"/>, <see cref="T:Godot.GpuParticles3D"/> or <see cref="T:Godot.CpuParticles3D"/>. Note that it is still possible to save mesh resources from 3D scenes using the <b>Advanced Import Settings</b> dialog, regardless of the source format.</para>
|
||
<para>See also <see cref="T:Godot.ResourceImporterScene"/>, which is used for more advanced 3D formats such as glTF.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterObj.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterObj.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterObj.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterObj.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterObj.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterObj.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterOggVorbis">
|
||
<summary>
|
||
<para>Ogg Vorbis is a lossy audio format, with better audio quality compared to <see cref="T:Godot.ResourceImporterMP3"/> at a given bitrate.</para>
|
||
<para>In most cases, it's recommended to use Ogg Vorbis over MP3. However, if you're using an MP3 sound source with no higher quality source available, then it's recommended to use the MP3 file directly to avoid double lossy compression.</para>
|
||
<para>Ogg Vorbis requires more CPU to decode than <see cref="T:Godot.ResourceImporterWav"/>. If you need to play a lot of simultaneous sounds, it's recommended to use WAV for those sounds instead, especially if targeting low-end devices.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterOggVorbis.LoadFromBuffer(System.Byte[])">
|
||
<summary>
|
||
<para>This method loads audio data from a PackedByteArray buffer into an AudioStreamOggVorbis object.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterOggVorbis.LoadFromBuffer(System.ReadOnlySpan{System.Byte})">
|
||
<summary>
|
||
<para>This method loads audio data from a PackedByteArray buffer into an AudioStreamOggVorbis object.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterOggVorbis.LoadFromFile(System.String)">
|
||
<summary>
|
||
<para>This method loads audio data from a file into an AudioStreamOggVorbis object. The file path is provided as a string.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterOggVorbis.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterOggVorbis.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterOggVorbis.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterOggVorbis.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterOggVorbis.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ResourceImporterOggVorbis.MethodName.LoadFromBuffer">
|
||
<summary>
|
||
Cached name for the 'load_from_buffer' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ResourceImporterOggVorbis.MethodName.LoadFromFile">
|
||
<summary>
|
||
Cached name for the 'load_from_file' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterOggVorbis.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterScene">
|
||
<summary>
|
||
<para>See also <see cref="T:Godot.ResourceImporterObj"/>, which is used for OBJ models that can be imported as an independent <see cref="T:Godot.Mesh"/> or a scene.</para>
|
||
<para>Additional options (such as extracting individual meshes or materials to files) are available in the <b>Advanced Import Settings</b> dialog. This dialog can be accessed by double-clicking a 3D scene in the FileSystem dock or by selecting a 3D scene in the FileSystem dock, going to the Import dock and choosing <b>Advanced</b>.</para>
|
||
<para><b>Note:</b> <see cref="T:Godot.ResourceImporterScene"/> is <i>not</i> used for <see cref="T:Godot.PackedScene"/>s, such as <c>.tscn</c> and <c>.scn</c> files.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterScene.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterScene.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterScene.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterScene.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterScene.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterScene.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterShaderFile">
|
||
<summary>
|
||
<para>This imports native GLSL shaders as <see cref="T:Godot.RDShaderFile"/> resources, for use with low-level <see cref="T:Godot.RenderingDevice"/> operations. This importer does <i>not</i> handle <c>.gdshader</c> files.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterShaderFile.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterShaderFile.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterShaderFile.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterShaderFile.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterShaderFile.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterShaderFile.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterTexture">
|
||
<summary>
|
||
<para>This importer imports <see cref="T:Godot.CompressedTexture2D"/> resources. If you need to process the image in scripts in a more convenient way, use <see cref="T:Godot.ResourceImporterImage"/> instead. See also <see cref="T:Godot.ResourceImporterLayeredTexture"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterTexture.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterTexture.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterTexture.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterTexture.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterTexture.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterTexture.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterTextureAtlas">
|
||
<summary>
|
||
<para>This imports a collection of textures from a PNG image into an <see cref="T:Godot.AtlasTexture"/> or 2D <see cref="T:Godot.ArrayMesh"/>. This can be used to save memory when importing 2D animations from spritesheets. Texture atlases are only supported in 2D rendering, not 3D. See also <see cref="T:Godot.ResourceImporterTexture"/> and <see cref="T:Godot.ResourceImporterLayeredTexture"/>.</para>
|
||
<para><b>Note:</b> <see cref="T:Godot.ResourceImporterTextureAtlas"/> does not handle importing <see cref="T:Godot.TileSetAtlasSource"/>, which is created using the <see cref="T:Godot.TileSet"/> editor instead.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterTextureAtlas.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterTextureAtlas.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterTextureAtlas.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterTextureAtlas.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterTextureAtlas.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterTextureAtlas.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterWav">
|
||
<summary>
|
||
<para>WAV is an uncompressed format, which can provide higher quality compared to Ogg Vorbis and MP3. It also has the lowest CPU cost to decode. This means high numbers of WAV sounds can be played at the same time, even on low-end devices.</para>
|
||
<para>By default, Godot imports WAV files using the lossy Quite OK Audio compression. You may change this by setting the <c>compress/mode</c> property.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterWav.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterWav.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ResourceImporterWav.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterWav.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterWav.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ResourceImporterWav.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptCreateDialog">
|
||
<summary>
|
||
<para>The <see cref="T:Godot.ScriptCreateDialog"/> creates script files according to a given template for a given scripting language. The standard use is to configure its fields prior to calling one of the <see cref="M:Godot.Window.Popup(System.Nullable{Godot.Rect2I})"/> methods.</para>
|
||
<para><code>
|
||
public override void _Ready()
|
||
{
|
||
var dialog = new ScriptCreateDialog();
|
||
dialog.Config("Node", "res://NewNode.cs"); // For in-engine types.
|
||
dialog.Config("\"res://BaseNode.cs\"", "res://DerivedNode.cs"); // For script types.
|
||
dialog.PopupCentered();
|
||
}
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ScriptCreateDialog.Config(System.String,System.String,System.Boolean,System.Boolean)">
|
||
<summary>
|
||
<para>Prefills required fields to configure the ScriptCreateDialog for use.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptCreateDialog.ScriptCreatedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.ScriptCreateDialog.ScriptCreated"/> event of a <see cref="T:Godot.ScriptCreateDialog"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.ScriptCreateDialog.ScriptCreated">
|
||
<summary>
|
||
<para>Emitted when the user clicks the OK button.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ScriptCreateDialog.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ScriptCreateDialog.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ScriptCreateDialog.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ScriptCreateDialog.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptCreateDialog.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptCreateDialog.MethodName.Config">
|
||
<summary>
|
||
Cached name for the 'config' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptCreateDialog.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptCreateDialog.SignalName.ScriptCreated">
|
||
<summary>
|
||
Cached name for the 'script_created' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptEditor">
|
||
<summary>
|
||
<para>Godot editor's script editor.</para>
|
||
<para><b>Note:</b> This class shouldn't be instantiated directly. Instead, access the singleton using <see cref="M:Godot.EditorInterface.GetScriptEditor"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditor.GetCurrentEditor">
|
||
<summary>
|
||
<para>Returns the <see cref="T:Godot.ScriptEditorBase"/> object that the user is currently editing.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditor.GetOpenScriptEditors">
|
||
<summary>
|
||
<para>Returns an array with all <see cref="T:Godot.ScriptEditorBase"/> objects which are currently open in editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditor.GetBreakpoints">
|
||
<summary>
|
||
<para>Returns array of breakpoints.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditor.RegisterSyntaxHighlighter(Godot.EditorSyntaxHighlighter)">
|
||
<summary>
|
||
<para>Registers the <see cref="T:Godot.EditorSyntaxHighlighter"/> to the editor, the <see cref="T:Godot.EditorSyntaxHighlighter"/> will be available on all open scripts.</para>
|
||
<para><b>Note:</b> Does not apply to scripts that are already opened.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditor.UnregisterSyntaxHighlighter(Godot.EditorSyntaxHighlighter)">
|
||
<summary>
|
||
<para>Unregisters the <see cref="T:Godot.EditorSyntaxHighlighter"/> from the editor.</para>
|
||
<para><b>Note:</b> The <see cref="T:Godot.EditorSyntaxHighlighter"/> will still be applied to scripts that are already opened.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditor.GotoLine(System.Int32)">
|
||
<summary>
|
||
<para>Goes to the specified line in the current script.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditor.GetCurrentScript">
|
||
<summary>
|
||
<para>Returns a <see cref="T:Godot.Script"/> that is currently active in editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditor.GetOpenScripts">
|
||
<summary>
|
||
<para>Returns an array with all <see cref="T:Godot.Script"/> objects which are currently open in editor.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditor.OpenScriptCreateDialog(System.String,System.String)">
|
||
<summary>
|
||
<para>Opens the script create dialog. The script will extend <paramref name="baseName"/>. The file extension can be omitted from <paramref name="basePath"/>. It will be added based on the selected scripting language.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditor.GotoHelp(System.String)">
|
||
<summary>
|
||
<para>Opens help for the given topic. The <paramref name="topic"/> is an encoded string that controls which class, method, constant, signal, annotation, property, or theme item should be focused.</para>
|
||
<para>The supported <paramref name="topic"/> formats include <c>class_name:class</c>, <c>class_method:class:method</c>, <c>class_constant:class:constant</c>, <c>class_signal:class:signal</c>, <c>class_annotation:class:@annotation</c>, <c>class_property:class:property</c>, and <c>class_theme_item:class:item</c>, where <c>class</c> is the class name, <c>method</c> is the method name, <c>constant</c> is the constant name, <c>signal</c> is the signal name, <c>annotation</c> is the annotation name, <c>property</c> is the property name, and <c>item</c> is the theme item.</para>
|
||
<para><code>
|
||
# Shows help for the Node class.
|
||
class_name:Node
|
||
# Shows help for the global min function.
|
||
# Global objects are accessible in the `@GlobalScope` namespace, shown here.
|
||
class_method:@GlobalScope:min
|
||
# Shows help for get_viewport in the Node class.
|
||
class_method:Node:get_viewport
|
||
# Shows help for the Input constant MOUSE_BUTTON_MIDDLE.
|
||
class_constant:Input:MOUSE_BUTTON_MIDDLE
|
||
# Shows help for the BaseButton signal pressed.
|
||
class_signal:BaseButton:pressed
|
||
# Shows help for the CanvasItem property visible.
|
||
class_property:CanvasItem:visible
|
||
# Shows help for the GDScript annotation export.
|
||
# Annotations should be prefixed with the `@` symbol in the descriptor, as shown here.
|
||
class_annotation:@GDScript:@export
|
||
# Shows help for the GraphNode theme item named panel_selected.
|
||
class_theme_item:GraphNode:panel_selected
|
||
</code></para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditor.UpdateDocsFromScript(Godot.Script)">
|
||
<summary>
|
||
<para>Updates the documentation for the given <paramref name="script"/> if the script's documentation is currently open.</para>
|
||
<para><b>Note:</b> This should be called whenever the script is changed to keep the open documentation state up to date.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptEditor.EditorScriptChangedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.ScriptEditor.EditorScriptChanged"/> event of a <see cref="T:Godot.ScriptEditor"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.ScriptEditor.EditorScriptChanged">
|
||
<summary>
|
||
<para>Emitted when user changed active script. Argument is a freshly activated <see cref="T:Godot.Script"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptEditor.ScriptCloseEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.ScriptEditor.ScriptClose"/> event of a <see cref="T:Godot.ScriptEditor"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.ScriptEditor.ScriptClose">
|
||
<summary>
|
||
<para>Emitted when editor is about to close the active script. Argument is a <see cref="T:Godot.Script"/> that is going to be closed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditor.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditor.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditor.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ScriptEditor.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptEditor.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditor.MethodName.GetCurrentEditor">
|
||
<summary>
|
||
Cached name for the 'get_current_editor' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditor.MethodName.GetOpenScriptEditors">
|
||
<summary>
|
||
Cached name for the 'get_open_script_editors' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditor.MethodName.GetBreakpoints">
|
||
<summary>
|
||
Cached name for the 'get_breakpoints' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditor.MethodName.RegisterSyntaxHighlighter">
|
||
<summary>
|
||
Cached name for the 'register_syntax_highlighter' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditor.MethodName.UnregisterSyntaxHighlighter">
|
||
<summary>
|
||
Cached name for the 'unregister_syntax_highlighter' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditor.MethodName.GotoLine">
|
||
<summary>
|
||
Cached name for the 'goto_line' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditor.MethodName.GetCurrentScript">
|
||
<summary>
|
||
Cached name for the 'get_current_script' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditor.MethodName.GetOpenScripts">
|
||
<summary>
|
||
Cached name for the 'get_open_scripts' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditor.MethodName.OpenScriptCreateDialog">
|
||
<summary>
|
||
Cached name for the 'open_script_create_dialog' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditor.MethodName.GotoHelp">
|
||
<summary>
|
||
Cached name for the 'goto_help' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditor.MethodName.UpdateDocsFromScript">
|
||
<summary>
|
||
Cached name for the 'update_docs_from_script' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptEditor.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditor.SignalName.EditorScriptChanged">
|
||
<summary>
|
||
Cached name for the 'editor_script_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditor.SignalName.ScriptClose">
|
||
<summary>
|
||
Cached name for the 'script_close' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptEditorBase">
|
||
<summary>
|
||
<para>Base editor for editing scripts in the <see cref="T:Godot.ScriptEditor"/>. This does not include documentation items.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditorBase.GetBaseEditor">
|
||
<summary>
|
||
<para>Returns the underlying <see cref="T:Godot.Control"/> used for editing scripts. For text scripts, this is a <see cref="T:Godot.CodeEdit"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditorBase.AddSyntaxHighlighter(Godot.EditorSyntaxHighlighter)">
|
||
<summary>
|
||
<para>Adds a <see cref="T:Godot.EditorSyntaxHighlighter"/> to the open script.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.ScriptEditorBase.NameChanged">
|
||
<summary>
|
||
<para>Emitted after script validation or when the edited resource has changed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.ScriptEditorBase.EditedScriptChanged">
|
||
<summary>
|
||
<para>Emitted after script validation.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptEditorBase.RequestHelpEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.ScriptEditorBase.RequestHelp"/> event of a <see cref="T:Godot.ScriptEditorBase"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.ScriptEditorBase.RequestHelp">
|
||
<summary>
|
||
<para>Emitted when the user requests contextual help.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptEditorBase.RequestOpenScriptAtLineEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.ScriptEditorBase.RequestOpenScriptAtLine"/> event of a <see cref="T:Godot.ScriptEditorBase"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.ScriptEditorBase.RequestOpenScriptAtLine">
|
||
<summary>
|
||
<para>Emitted when the user requests to view a specific line of a script, similar to <see cref="E:Godot.ScriptEditorBase.GoToMethod"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.ScriptEditorBase.RequestSaveHistory">
|
||
<summary>
|
||
<para>Emitted when the user contextual goto and the item is in the same script.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptEditorBase.RequestSavePreviousStateEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.ScriptEditorBase.RequestSavePreviousState"/> event of a <see cref="T:Godot.ScriptEditorBase"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.ScriptEditorBase.RequestSavePreviousState">
|
||
<summary>
|
||
<para>Emitted when the user changes current script or moves caret by 10 or more columns within the same script.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptEditorBase.GoToHelpEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.ScriptEditorBase.GoToHelp"/> event of a <see cref="T:Godot.ScriptEditorBase"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.ScriptEditorBase.GoToHelp">
|
||
<summary>
|
||
<para>Emitted when the user requests a specific documentation page.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptEditorBase.SearchInFilesRequestedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.ScriptEditorBase.SearchInFilesRequested"/> event of a <see cref="T:Godot.ScriptEditorBase"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.ScriptEditorBase.SearchInFilesRequested">
|
||
<summary>
|
||
<para>Emitted when the user request to search text in the file system.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptEditorBase.ReplaceInFilesRequestedEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.ScriptEditorBase.ReplaceInFilesRequested"/> event of a <see cref="T:Godot.ScriptEditorBase"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.ScriptEditorBase.ReplaceInFilesRequested">
|
||
<summary>
|
||
<para>Emitted when the user request to find and replace text in the file system.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptEditorBase.GoToMethodEventHandler">
|
||
<summary>
|
||
Represents the method that handles the <see cref="E:Godot.ScriptEditorBase.GoToMethod"/> event of a <see cref="T:Godot.ScriptEditorBase"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="E:Godot.ScriptEditorBase.GoToMethod">
|
||
<summary>
|
||
<para>Emitted when the user requests to view a specific method of a script, similar to <see cref="E:Godot.ScriptEditorBase.RequestOpenScriptAtLine"/>.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditorBase.InvokeGodotClassMethod(Godot.NativeInterop.godot_string_name@,Godot.NativeInterop.NativeVariantPtrArgs,Godot.NativeInterop.godot_variant@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to invoke.</param>
|
||
<param name="args">Arguments to use with the invoked method.</param>
|
||
<param name="ret">Value returned by the invoked method.</param>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditorBase.HasGodotClassMethod(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="method">Name of the method to check for.</param>
|
||
</member>
|
||
<member name="M:Godot.ScriptEditorBase.HasGodotClassSignal(Godot.NativeInterop.godot_string_name@)">
|
||
<summary>
|
||
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.
|
||
</summary>
|
||
<param name="signal">Name of the signal to check for.</param>
|
||
</member>
|
||
<member name="T:Godot.ScriptEditorBase.PropertyName">
|
||
<summary>
|
||
Cached StringNames for the properties and fields contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptEditorBase.MethodName">
|
||
<summary>
|
||
Cached StringNames for the methods contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditorBase.MethodName.GetBaseEditor">
|
||
<summary>
|
||
Cached name for the 'get_base_editor' method.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditorBase.MethodName.AddSyntaxHighlighter">
|
||
<summary>
|
||
Cached name for the 'add_syntax_highlighter' method.
|
||
</summary>
|
||
</member>
|
||
<member name="T:Godot.ScriptEditorBase.SignalName">
|
||
<summary>
|
||
Cached StringNames for the signals contained in this class, for fast lookup.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditorBase.SignalName.NameChanged">
|
||
<summary>
|
||
Cached name for the 'name_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditorBase.SignalName.EditedScriptChanged">
|
||
<summary>
|
||
Cached name for the 'edited_script_changed' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditorBase.SignalName.RequestHelp">
|
||
<summary>
|
||
Cached name for the 'request_help' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditorBase.SignalName.RequestOpenScriptAtLine">
|
||
<summary>
|
||
Cached name for the 'request_open_script_at_line' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditorBase.SignalName.RequestSaveHistory">
|
||
<summary>
|
||
Cached name for the 'request_save_history' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditorBase.SignalName.RequestSavePreviousState">
|
||
<summary>
|
||
Cached name for the 'request_save_previous_state' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditorBase.SignalName.GoToHelp">
|
||
<summary>
|
||
Cached name for the 'go_to_help' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditorBase.SignalName.SearchInFilesRequested">
|
||
<summary>
|
||
Cached name for the 'search_in_files_requested' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditorBase.SignalName.ReplaceInFilesRequested">
|
||
<summary>
|
||
Cached name for the 'replace_in_files_requested' signal.
|
||
</summary>
|
||
</member>
|
||
<member name="F:Godot.ScriptEditorBase.SignalName.GoToMethod">
|
||
<summary>
|
||
Cached name for the 'go_to_method' signal.
|
||
</summary>
|
||
</member>
|
||
</members>
|
||
</doc>
|