Struct amethyst_controls::FlyControlBundle

pub struct FlyControlBundle<T: BindingTypes> { /* fields omitted */ }

The bundle that creates a flying movement system.

Note: Will not actually create a moving entity. It will only register the needed resources and systems.

You might want to add "fly_movement" and "free_rotation" as dependencies of the TransformSystem in order to apply changes made by these systems in the same frame. Adding this bundle will grab the mouse, hide it and keep it centered.

Type parameters

• T: This are the keys the InputHandler is using for axes and actions. Often, this is a StringBindings.

Systems

This bundle adds the following systems:

• FlyMovementSystem
• FreeRotationSystem
• MouseFocusUpdateSystem
• CursorHideSystem

Implementations

impl<T: BindingTypes> FlyControlBundle<T>

pub fn new(
    right_input_axis: Option<T::Axis>,
    up_input_axis: Option<T::Axis>,
    forward_input_axis: Option<T::Axis>
) -> Self

Builds a new fly control bundle using the provided axes as controls.

pub fn with_sensitivity(self, x: f32, y: f32) -> Self

Alters the mouse sensitivy on this FlyControlBundle

pub fn with_speed(self, speed: f32) -> Self

Alters the speed on this FlyControlBundle.

Trait Implementations

impl<T: Debug + BindingTypes> Debug for FlyControlBundle<T> where
    T::Axis: Debug,
    T::Axis: Debug,
    T::Axis: Debug, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, 'b, T: BindingTypes> SystemBundle<'a, 'b> for FlyControlBundle<T>

fn build(
    self,
    world: &mut World,
    builder: &mut DispatcherBuilder<'a, 'b>
) -> Result<(), Error>

Build and add ECS resources, register components, add systems etc to the Application.