Struct gdnative_bindings_lily::EditorVCSInterface [−][src]
pub struct EditorVCSInterface { /* fields omitted */ }
Expand description
tools class EditorVCSInterface
inherits Object
(unsafe).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Class hierarchy
EditorVCSInterface inherits methods from:
Tool
This class is used to interact with Godot’s editor.
Safety
All types in the Godot API have “interior mutability” in Rust parlance.
To enforce that the official thread-safety guidelines are
followed, the typestate pattern is used in the Ref
and TRef
smart pointers,
and the Instance
API. The typestate Access
in these types tracks whether the
access is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations
Creates a version commit if the addon is initialized, else returns without doing anything. Uses the files which have been staged previously, with the commit message set to a value as provided as in the argument.
Returns an [Array] of Dictionary objects containing the diff output from the VCS in use, if a VCS addon is initialized, else returns an empty [Array] object. The diff contents also consist of some contextual lines which provide context to the observed line change in the file. Each Dictionary object has the line diff contents under the keys:
"content"
to store a String containing the line contents"status"
to store a String which contains"+"
in case the content is a line addition but it stores a"-"
in case of deletion and an empty string in the case the line content is neither an addition nor a deletion."new_line_number"
to store an integer containing the new line number of the line content."line_count"
to store an integer containing the number of lines in the line content."old_line_number"
to store an integer containing the old line number of the line content."offset"
to store the offset of the line change since the first contextual line content.
Returns a Dictionary containing the path of the detected file change mapped to an integer signifying what kind of a change the corresponding file has experienced. The following integer values are being used to signify that the detected file is:
0
: New to the VCS working directory1
: Modified2
: Renamed3
: Deleted4
: Typechanged
Returns the project name of the VCS working directory.
Returns the name of the VCS if the VCS has been initialized, else return an empty string.
Initializes the VCS addon if not already. Uses the argument value as the path to the working directory of the project. Creates the initial commit if required. Returns true
if no failure occurs, else returns false
.
Returns true
if the addon is ready to respond to function calls, else returns false
.
Returns true
if the VCS addon has been initialized, else returns false
.
Shuts down the VCS addon to allow cleanup code to run on call. Returns true
is no failure occurs, else returns false
.
Stages the file which should be committed when [method EditorVCSInterface.commit] is called. Argument should contain the absolute path.
Unstages the file which was staged previously to be committed, so that it is no longer committed when [method EditorVCSInterface.commit] is called. Argument should contain the absolute path.
Methods from Deref<Target = Object>
Adds a user-defined signal
. Arguments are optional, but can be added as an [Array] of dictionaries, each containing name: String
and type: int
(see [enum Variant.Type]) entries.
Default Arguments
arguments
-[ ]
Sample code is GDScript unless otherwise noted.
Calls the method
on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:
call("set", "position", Vector2(42.0, 0.0))
Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).
Safety
This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).
pub unsafe fn call_deferred(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
pub unsafe fn call_deferred(
&self,
method: impl Into<GodotString>,
varargs: &[Variant]
) -> Variant
Sample code is GDScript unless otherwise noted.
Calls the method
on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:
call_deferred("set", "position", Vector2(42.0, 0.0))
Note: In C#, the method name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined methods where you should use the same convention as in the C# source (typically PascalCase).
Safety
This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).
pub unsafe fn callv(
&self,
method: impl Into<GodotString>,
arg_array: VariantArray
) -> Variant
pub unsafe fn callv(
&self,
method: impl Into<GodotString>,
arg_array: VariantArray
) -> Variant
Sample code is GDScript unless otherwise noted.
Calls the method
on the object and returns the result. Contrarily to [method call], this method does not support a variable number of arguments but expects all parameters to be via a single [Array].
callv("set", [ "position", Vector2(42.0, 0.0) ])
Safety
This function bypasses Rust’s static type checks (aliasing, thread boundaries, calls to free(), …).
Returns true
if the object can translate strings. See [method set_message_translation] and [method tr].
pub fn connect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>,
binds: VariantArray,
flags: i64
) -> GodotResult
pub fn connect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>,
binds: VariantArray,
flags: i64
) -> GodotResult
Sample code is GDScript unless otherwise noted.
Connects a signal
to a method
on a target
object. Pass optional binds
to the call as an [Array] of parameters. These parameters will be passed to the method after any parameter used in the call to [method emit_signal]. Use flags
to set deferred or one-shot connections. See [enum ConnectFlags] constants.
A signal
can only be connected once to a method
. It will throw an error if already connected, unless the signal was connected with [constant CONNECT_REFERENCE_COUNTED]. To avoid this, first, use [method is_connected] to check for existing connections.
If the target
is destroyed in the game’s lifecycle, the connection will be lost.
Examples:
connect("pressed", self, "_on_Button_pressed") # BaseButton signal
connect("text_entered", self, "_on_LineEdit_text_entered") # LineEdit signal
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # User-defined signal
An example of the relationship between binds
passed to [method connect] and parameters used when calling [method emit_signal]:
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # weapon_type and damage are passed last
emit_signal("hit", "Dark lord", 5) # "Dark lord" and 5 are passed first
func _on_Player_hit(hit_by, level, weapon_type, damage):
print("Hit by %s (lvl %d) with weapon %s for %d damage" % [hit_by, level, weapon_type, damage])
Default Arguments
binds
-[ ]
flags
-0
pub fn disconnect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
)
pub fn disconnect(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
)
Disconnects a signal
from a method
on the given target
.
If you try to disconnect a connection that does not exist, the method will throw an error. Use [method is_connected] to ensure that the connection exists.
Sample code is GDScript unless otherwise noted.
Emits the given signal
. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example:
emit_signal("hit", weapon_type, damage)
emit_signal("game_over")
Returns the Variant value of the given property
. If the property
doesn’t exist, this will return null
.
Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).
Returns the object’s class as a String.
Returns an [Array] of dictionaries with information about signals that are connected to the object. Each Dictionary contains three String entries:
source
is a reference to the signal emitter.signal_name
is the name of the connected signal.method_name
is the name of the method to which the signal is connected.
Gets the object’s property indexed by the given NodePath. The node path should be relative to the current object and can use the colon character (:
) to access nested properties. Examples: "position:x"
or "material:next_pass:blend_mode"
.
Returns the object’s unique instance ID. This ID can be saved in EncodedObjectAsID, and can be used to retrieve the object instance with [method @GDScript.instance_from_id].
Returns the object’s metadata entry for the given name
.
Returns the object’s metadata as a [PoolStringArray].
Returns the object’s methods and their signatures as an [Array].
Returns the object’s property list as an [Array] of dictionaries.
Each property’s Dictionary contain at least name: String
and type: int
(see [enum Variant.Type]) entries. Optionally, it can also include hint: int
(see [enum PropertyHint]), hint_string: String
, and usage: int
(see [enum PropertyUsageFlags]).
Returns the object’s Script instance, or null
if none is assigned.
Returns an [Array] of connections for the given signal
.
Returns the list of signals as an [Array] of dictionaries.
Returns true
if a metadata entry is found with the given name
.
Returns true
if the object contains the given method
.
Returns true
if the given signal
exists.
Returns true
if the given user-defined signal
exists. Only signals added using [method add_user_signal] are taken into account.
Returns true
if signal emission blocking is enabled.
Returns true
if the object inherits from the given class
.
pub fn is_connected(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
) -> bool
pub fn is_connected(
&self,
signal: impl Into<GodotString>,
target: impl AsArg<Object>,
method: impl Into<GodotString>
) -> bool
Returns true
if a connection exists for a given signal
, target
, and method
.
Returns true
if the [method Node.queue_free] method was called for the object.
Send a given notification to the object, which will also trigger a call to the [method _notification] method of all classes that the object inherits from.
If reversed
is true
, [method _notification] is called first on the object’s own class, and then up to its successive parent classes. If reversed
is false
, [method _notification] is called first on the highest ancestor (Object itself), and then down to its successive inheriting classes.
Default Arguments
reversed
-false
Notify the editor that the property list has changed, so that editor plugins can take the new values into account. Does nothing on export builds.
Removes a given entry from the object’s metadata. See also [method set_meta].
Assigns a new value to the given property. If the property
does not exist, nothing will happen.
Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).
If set to true
, signal emission is blocked.
Assigns a new value to the given property, after the current frame’s physics step. This is equivalent to calling [method set] via [method call_deferred], i.e. call_deferred("set", property, value)
.
Note: In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn’t apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase).
Sample code is GDScript unless otherwise noted.
Assigns a new value to the property identified by the NodePath. The node path should be relative to the current object and can use the colon character (:
) to access nested properties. Example:
set_indexed("position", Vector2(42, 0))
set_indexed("position:y", -10)
print(position) # (42, -10)
Defines whether the object can translate strings (with calls to [method tr]). Enabled by default.
Adds, changes or removes a given entry in the object’s metadata. Metadata are serialized and can take any Variant value.
To remove a given entry from the object’s metadata, use [method remove_meta]. Metadata is also removed if its value is set to null
. This means you can also use set_meta("name", null)
to remove metadata for "name"
.
Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality. If the object already had a script, the previous script instance will be freed and its variables and state will be lost. The new script’s [method _init] method will be called.
Translates a message using translation catalogs configured in the Project Settings.
Only works if message translation is enabled (which it is by default), otherwise it returns the message
unchanged. See [method set_message_translation].
Trait Implementations
type RefKind = ManuallyManaged
type RefKind = ManuallyManaged
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
Creates a persistent reference to the same Godot object with thread-local thread access. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for EditorVCSInterface
impl !Send for EditorVCSInterface
impl !Sync for EditorVCSInterface
impl Unpin for EditorVCSInterface
impl UnwindSafe for EditorVCSInterface