Struct TooltipPlugin 

pub struct TooltipPlugin {
    pub container: Entity,
    pub text: Entity,
    pub enabled: bool,
}

A Plugin that sets up the tooltip widget system.

Use the TooltipSettings resource to make changes while the app is already running.

Fields

container: Entity

Set a custom entity for TooltipSettings::container, or spawn the default container entity if None.

This entity should include all of the required components of Node, with Visibility::Hidden and Node::position_type set to PositionType::Absolute.

text: Entity

Set a custom entity for TooltipSettings::text, or spawn the default text entity if None.

This entity should include all of the required components of Node, along with a RichText component, and be a child of Self::container.

enabled: bool

Whether or not the tooltip system should initially be enabled.

Trait Implementations

impl Default for TooltipPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for TooltipPlugin

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.