Struct EditorExportPlatformExtension
#[repr(C)]pub struct EditorExportPlatformExtension { /* private fields */ }
Expand description
Godot class EditorExportPlatformExtension.
Inherits EditorExportPlatform
.
Related symbols:
IEditorExportPlatformExtension
: virtual methods
See also Godot docs for EditorExportPlatformExtension
.
§Construction
This class is reference-counted. You can create a new instance using EditorExportPlatformExtension::new_gd()
.
Implementations§
§impl EditorExportPlatformExtension
impl EditorExportPlatformExtension
pub fn set_config_error(&self, error_text: impl AsArg<GString>)
pub fn get_config_error(&self) -> GString
pub fn set_config_missing_templates(&self, missing_templates: bool)
pub fn get_config_missing_templates(&self) -> bool
Methods from Deref<Target = EditorExportPlatform>§
pub fn get_os_name(&self) -> GString
pub fn create_preset(&mut self) -> Option<Gd<EditorExportPreset>>
pub fn find_export_template( &self, template_file_name: impl AsArg<GString>, ) -> Dictionary
pub fn get_current_presets(&self) -> Array<Variant>
pub fn save_pack(
&mut self,
preset: impl AsArg<Option<Gd<EditorExportPreset>>>,
debug: bool,
path: impl AsArg<GString>,
) -> Dictionary
pub fn save_pack( &mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>>, debug: bool, path: impl AsArg<GString>, ) -> Dictionary
To set the default parameters, use Self::save_pack_ex
and its builder methods. See the book for detailed usage instructions.
pub fn save_pack_ex<'a>( &'a mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>> + 'a, debug: bool, path: impl AsArg<GString> + 'a, ) -> ExSavePack<'a>
pub fn save_zip( &mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>>, debug: bool, path: impl AsArg<GString>, ) -> Dictionary
pub fn save_pack_patch( &mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>>, debug: bool, path: impl AsArg<GString>, ) -> Dictionary
pub fn save_zip_patch( &mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>>, debug: bool, path: impl AsArg<GString>, ) -> Dictionary
pub fn gen_export_flags(&mut self, flags: DebugFlags) -> PackedArray<GString>
pub fn export_project_files(
&mut self,
preset: impl AsArg<Option<Gd<EditorExportPreset>>>,
debug: bool,
save_cb: &Callable,
) -> Error
pub fn export_project_files( &mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>>, debug: bool, save_cb: &Callable, ) -> Error
To set the default parameters, use Self::export_project_files_ex
and its builder methods. See the book for detailed usage instructions.
pub fn export_project_files_ex<'a>( &'a mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>> + 'a, debug: bool, save_cb: &'a Callable, ) -> ExExportProjectFiles<'a>
pub fn export_project(
&mut self,
preset: impl AsArg<Option<Gd<EditorExportPreset>>>,
debug: bool,
path: impl AsArg<GString>,
) -> Error
pub fn export_project( &mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>>, debug: bool, path: impl AsArg<GString>, ) -> Error
To set the default parameters, use Self::export_project_ex
and its builder methods. See the book for detailed usage instructions.
pub fn export_project_ex<'a>( &'a mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>> + 'a, debug: bool, path: impl AsArg<GString> + 'a, ) -> ExExportProject<'a>
pub fn export_pack(
&mut self,
preset: impl AsArg<Option<Gd<EditorExportPreset>>>,
debug: bool,
path: impl AsArg<GString>,
) -> Error
pub fn export_pack( &mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>>, debug: bool, path: impl AsArg<GString>, ) -> Error
To set the default parameters, use Self::export_pack_ex
and its builder methods. See the book for detailed usage instructions.
pub fn export_pack_ex<'a>( &'a mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>> + 'a, debug: bool, path: impl AsArg<GString> + 'a, ) -> ExExportPack<'a>
pub fn export_zip(
&mut self,
preset: impl AsArg<Option<Gd<EditorExportPreset>>>,
debug: bool,
path: impl AsArg<GString>,
) -> Error
pub fn export_zip( &mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>>, debug: bool, path: impl AsArg<GString>, ) -> Error
To set the default parameters, use Self::export_zip_ex
and its builder methods. See the book for detailed usage instructions.
pub fn export_zip_ex<'a>( &'a mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>> + 'a, debug: bool, path: impl AsArg<GString> + 'a, ) -> ExExportZip<'a>
pub fn export_pack_patch(
&mut self,
preset: impl AsArg<Option<Gd<EditorExportPreset>>>,
debug: bool,
path: impl AsArg<GString>,
) -> Error
pub fn export_pack_patch( &mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>>, debug: bool, path: impl AsArg<GString>, ) -> Error
To set the default parameters, use Self::export_pack_patch_ex
and its builder methods. See the book for detailed usage instructions.
pub fn export_pack_patch_ex<'a>( &'a mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>> + 'a, debug: bool, path: impl AsArg<GString> + 'a, ) -> ExExportPackPatch<'a>
pub fn export_zip_patch(
&mut self,
preset: impl AsArg<Option<Gd<EditorExportPreset>>>,
debug: bool,
path: impl AsArg<GString>,
) -> Error
pub fn export_zip_patch( &mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>>, debug: bool, path: impl AsArg<GString>, ) -> Error
To set the default parameters, use Self::export_zip_patch_ex
and its builder methods. See the book for detailed usage instructions.
pub fn export_zip_patch_ex<'a>( &'a mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>> + 'a, debug: bool, path: impl AsArg<GString> + 'a, ) -> ExExportZipPatch<'a>
pub fn clear_messages(&mut self)
pub fn add_message( &mut self, type_: ExportMessageType, category: impl AsArg<GString>, message: impl AsArg<GString>, )
pub fn get_message_count(&self) -> i32
pub fn get_message_type(&self, index: i32) -> ExportMessageType
pub fn get_message_category(&self, index: i32) -> GString
pub fn get_message_text(&self, index: i32) -> GString
pub fn get_worst_message_type(&self) -> ExportMessageType
pub fn ssh_run_on_remote(
&self,
host: impl AsArg<GString>,
port: impl AsArg<GString>,
ssh_arg: &PackedArray<GString>,
cmd_args: impl AsArg<GString>,
) -> Error
pub fn ssh_run_on_remote( &self, host: impl AsArg<GString>, port: impl AsArg<GString>, ssh_arg: &PackedArray<GString>, cmd_args: impl AsArg<GString>, ) -> Error
To set the default parameters, use Self::ssh_run_on_remote_ex
and its builder methods. See the book for detailed usage instructions.
pub fn ssh_run_on_remote_ex<'a>( &'a self, host: impl AsArg<GString> + 'a, port: impl AsArg<GString> + 'a, ssh_arg: &'a PackedArray<GString>, cmd_args: impl AsArg<GString> + 'a, ) -> ExSshRunOnRemote<'a>
pub fn ssh_run_on_remote_no_wait(
&self,
host: impl AsArg<GString>,
port: impl AsArg<GString>,
ssh_args: &PackedArray<GString>,
cmd_args: impl AsArg<GString>,
) -> i64
pub fn ssh_run_on_remote_no_wait( &self, host: impl AsArg<GString>, port: impl AsArg<GString>, ssh_args: &PackedArray<GString>, cmd_args: impl AsArg<GString>, ) -> i64
To set the default parameters, use Self::ssh_run_on_remote_no_wait_ex
and its builder methods. See the book for detailed usage instructions.
pub fn ssh_run_on_remote_no_wait_ex<'a>( &'a self, host: impl AsArg<GString> + 'a, port: impl AsArg<GString> + 'a, ssh_args: &'a PackedArray<GString>, cmd_args: impl AsArg<GString> + 'a, ) -> ExSshRunOnRemoteNoWait<'a>
pub fn ssh_push_to_remote( &self, host: impl AsArg<GString>, port: impl AsArg<GString>, scp_args: &PackedArray<GString>, src_file: impl AsArg<GString>, dst_file: impl AsArg<GString>, ) -> Error
pub fn get_internal_export_files( &mut self, preset: impl AsArg<Option<Gd<EditorExportPreset>>>, debug: bool, ) -> Dictionary
Methods from Deref<Target = RefCounted>§
pub fn get_reference_count(&self) -> i32
Methods from Deref<Target = Object>§
pub fn get_script(&self) -> Option<Gd<Script>>
pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)
pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error
pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error
pub fn get_class(&self) -> GString
pub fn is_class(&self, class: impl AsArg<GString>) -> bool
pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)
pub fn get(&self, property: impl AsArg<StringName>) -> Variant
pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )
pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant
pub fn get_property_list(&self) -> Array<Dictionary>
pub fn get_method_list(&self) -> Array<Dictionary>
pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool
pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant
pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)
pub fn remove_meta(&mut self, name: impl AsArg<StringName>)
pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant
pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant
To set the default parameters, use Self::get_meta_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>
pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool
pub fn get_meta_list(&self) -> Array<StringName>
pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)
pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)
To set the default parameters, use Self::add_user_signal_ex
and its builder methods. See the book for detailed usage instructions.
pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>
pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool
pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)
pub fn emit_signal(
&mut self,
signal: impl AsArg<StringName>,
varargs: &[Variant],
) -> Error
pub fn emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Error
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_emit_signal(
&mut self,
signal: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Error, CallError>
pub fn try_emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Error, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Variant
pub fn call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call_deferred(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Variant
pub fn call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call_deferred(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn set_deferred( &mut self, property: impl AsArg<StringName>, value: &Variant, )
pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant
pub fn has_method(&self, method: impl AsArg<StringName>) -> bool
pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32
pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool
pub fn get_signal_list(&self) -> Array<Dictionary>
pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>
pub fn get_incoming_connections(&self) -> Array<Dictionary>
pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )
pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool
pub fn has_connections(&self, signal: impl AsArg<StringName>) -> bool
pub fn set_block_signals(&mut self, enable: bool)
pub fn is_blocking_signals(&self) -> bool
pub fn notify_property_list_changed(&mut self)
pub fn set_message_translation(&mut self, enable: bool)
pub fn can_translate_messages(&self) -> bool
pub fn tr(&self, message: impl AsArg<StringName>) -> GString
pub fn tr(&self, message: impl AsArg<StringName>) -> GString
To set the default parameters, use Self::tr_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>
pub fn tr_n(
&self,
message: impl AsArg<StringName>,
plural_message: impl AsArg<StringName>,
n: i32,
) -> GString
pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString
To set the default parameters, use Self::tr_n_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>
pub fn get_translation_domain(&self) -> StringName
pub fn set_translation_domain(&mut self, domain: impl AsArg<StringName>)
pub fn is_queued_for_deletion(&self) -> bool
pub fn cancel_free(&mut self)
pub fn notify(&mut self, what: ObjectNotification)
pub fn notify(&mut self, what: ObjectNotification)
⚠️ Sends a Godot notification to all classes inherited by the object.
Triggers calls to on_notification()
, and depending on the notification, also to Godot’s lifecycle callbacks such as ready()
.
Starts from the highest ancestor (the Object
class) and goes down the hierarchy.
See also Godot docs for Object::notification()
.
§Panics
If you call this method on a user-defined object while holding a GdRef
or GdMut
guard on the instance, you will encounter
a panic. The reason is that the receiving virtual method on_notification()
acquires a GdMut
lock dynamically, which must
be exclusive.
pub fn notify_reversed(&mut self, what: ObjectNotification)
pub fn notify_reversed(&mut self, what: ObjectNotification)
⚠️ Like Self::notify()
, but starts at the most-derived class and goes up the hierarchy.
See docs of that method, including the panics.
Trait Implementations§
§impl Bounds for EditorExportPlatformExtension
impl Bounds for EditorExportPlatformExtension
§type Memory = MemRefCounted
type Memory = MemRefCounted
§type Declarer = DeclEngine
type Declarer = DeclEngine
§impl Debug for EditorExportPlatformExtension
impl Debug for EditorExportPlatformExtension
§impl Deref for EditorExportPlatformExtension
impl Deref for EditorExportPlatformExtension
§type Target = EditorExportPlatform
type Target = EditorExportPlatform
§fn deref(&self) -> &<EditorExportPlatformExtension as Deref>::Target
fn deref(&self) -> &<EditorExportPlatformExtension as Deref>::Target
§impl DerefMut for EditorExportPlatformExtension
impl DerefMut for EditorExportPlatformExtension
§fn deref_mut(&mut self) -> &mut <EditorExportPlatformExtension as Deref>::Target
fn deref_mut(&mut self) -> &mut <EditorExportPlatformExtension as Deref>::Target
§impl GodotClass for EditorExportPlatformExtension
impl GodotClass for EditorExportPlatformExtension
§const INIT_LEVEL: InitLevel = crate::init::InitLevel::Editor
const INIT_LEVEL: InitLevel = crate::init::InitLevel::Editor
§type Base = EditorExportPlatform
type Base = EditorExportPlatform
T
. This is always a Godot engine class.§fn class_id() -> ClassId
fn class_id() -> ClassId
§fn class_name() -> ClassId
fn class_name() -> ClassId
class_id()
§fn inherits<Base>() -> boolwhere
Base: GodotClass,
fn inherits<Base>() -> boolwhere
Base: GodotClass,
§impl Inherits<EditorExportPlatform> for EditorExportPlatformExtension
impl Inherits<EditorExportPlatform> for EditorExportPlatformExtension
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl Inherits<Object> for EditorExportPlatformExtension
impl Inherits<Object> for EditorExportPlatformExtension
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl Inherits<RefCounted> for EditorExportPlatformExtension
impl Inherits<RefCounted> for EditorExportPlatformExtension
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl WithSignals for EditorExportPlatformExtension
impl WithSignals for EditorExportPlatformExtension
§type SignalCollection<'c, C: WithSignals> = SignalsOfObject<'c, C>
type SignalCollection<'c, C: WithSignals> = SignalsOfObject<'c, C>
impl GodotDefault for EditorExportPlatformExtension
Auto Trait Implementations§
impl Freeze for EditorExportPlatformExtension
impl RefUnwindSafe for EditorExportPlatformExtension
impl !Send for EditorExportPlatformExtension
impl !Sync for EditorExportPlatformExtension
impl Unpin for EditorExportPlatformExtension
impl UnwindSafe for EditorExportPlatformExtension
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Inherits<T> for Twhere
T: GodotClass,
impl<T> Inherits<T> for Twhere
T: GodotClass,
§const IS_SAME_CLASS: bool = true
const IS_SAME_CLASS: bool = true
Self == Base
. Read more