Struct ark_api::applet::Applet

NOTE: This doesn’t really have much in the way of security implications, but it can be annoying for the user to get their clipboard contents overridden at any time. Use with care.

source

pub fn set_player_clipboard_string(self, player_id: PlayerId, string: &str)

Try to set the contents of the system clipboard of the given player to the supplied string.

If there is no such player, this does nothing.

NOTE: This doesn’t really have much in the way of security implications, but it can be annoying for the user to get their clipboard contents overridden at any time. Use with care.

source

pub fn clipboard_string(self) -> Option<String>

Gets the contents of the system clipboard, if any.

NOTE: The existence of this has serious security implications that we need to work through later. We might need to add limitations like only allowing reading the clipboard after a certain keyboard shortcut, or Paste message, or something similar. Maybe a special permission flag for clipboard access. The clipboard could contain sensitive information so it’s not good to allow just any app to easily sniff it.

Tracked in https://github.com/EmbarkStudios/ark/issues/4491

source

pub fn launch_argument(self) -> String

Gets the launch argument string, if one is available

This can be used to implement module-specific deep-linking to launch a module into a specific mode or action described by a URL parameter

Example

If an applet is launched with the URL https://ark.link/module/cube-simple?cid=zUnGgApwEF8PP4NqxYjHcS8NdxQXzLuc3L5F9DDgGqcc5&arg=THIS%20is%20TEST this would make this function return THIS is TEST.

NOTE: Only a single URL parameter named arg is allowed. Any parameters will be ignored.

source

pub fn launch_applet_with_url(self, url: &str)

Launch a module applet from a URL

This will panic if the URL is not a correctly formatted Ark module URL, example valid URLs:

https://ark.link/module/cube-simple?cid=zUnGgApwEF8PP4NqxYjHcS8NdxQXzLuc3L5F9DDgGqcc5&arg=THIS%20is%20TEST
ark://module/cube-simple

Ark will start to load the applet specified in the URL, and if it fails it will prompt the user that. In the meantime the current module will continue to run. There is currently no way for the module itself to know if the other applet module was successfully launched.

Ark will load the latests published module by the given name if no cid is specified.

Example

Load a module with some argument:

/// Start `module` with the `applet().launch_argument() == arg`
fn launch_module_with_arg(module: &str, arg: &str) {
   applet().launch_applet_with_url(format!("ark://module/{}?arg={}", module, percent_encode(arg)));
}

source

pub fn request_quit(self)

Requests that the applet is terminated gracefully.

The module will not quit immediately but will continue running its current update loop.

The host is free to ignore this request, delay it, or ask the user for confirmation.

source

pub fn broadcast_message(msg: &str, duration: f32)

Broadcasts a message to the entire world, in multiplayer sessions, to be displayed for the specified duration (in milliseconds). This doesn’t show up in single player sessions.

source

pub fn show_virtual_keyboard( self, player_id: PlayerId, command: VirtualKeyboardCommand )

Request the virtual keyboard to be shown or hidden for the specified player

Key events generated by the virtual keyboard can be retrieved through Applet::input_events_player

Calling this for players on non touch devices will be ignored

source

pub fn detach_player(player: PlayerId, parameters: &str) -> DetachPlayerRequest

👎Deprecated: Use updated detach_players instead

Requests to detach a player to another instance of this applet that runs with the given command and arguments.

source

pub fn detach_players( players: &[PlayerId], target: DetachPlayerTarget, bubble: &str ) -> Result<DetachPlayerRequest, DetachPlayerError>

Requests to detach one or more players to another instance of this applet within the given bubble. A bubble can be seen as a filter for the matchmaker. For example if I’m looking for a specific world and provide a bubble string the matchmaker will only look at servers that are tagged with the same bubble string and matchmake within those.

The target specifies where the players should end up. See DetachPlayerTarget for the different options.

source

pub fn notify_finished_hot_reload(is_success: bool)

When a detach player requests causes a hot-reload, indicate that the hot-reload is done and that the applet is in a ready state for further use.

This will panic if there was not hot-reload happening. As such it should only be called after the hot-reload entrypoint has been called and the applet is done performing the hot-reloading steps. It should be called only once per hot-reload request, and it will panic if it’s called multiple times for the same hot-reload request.

source