Trait amethyst_inspector::Inspect

pub trait Inspect<'a>: Component {
type SystemData: SystemData<'a>;
    fn inspect(data: &mut Self::SystemData, entity: Entity) { ... }
    fn can_add(data: &mut Self::SystemData, entity: Entity) -> bool { ... }
    fn can_remove(data: &mut Self::SystemData, entity: Entity) -> bool { ... }
    fn add(data: &mut Self::SystemData, entity: Entity) { ... }
    fn setup(data: &mut Self::SystemData, entity: Option<Entity>) { ... }
}

Any component implementing Inspect and included in your inspect! will show up in the inspector Whether the component is addable is decided by can_add(...)

Associated Types

type SystemData: SystemData<'a>

Loading content...

Provided methods

fn inspect(data: &mut Self::SystemData, entity: Entity)

This method is only ran if the component contains the selected entity

fn can_add(data: &mut Self::SystemData, entity: Entity) -> bool

Decide if this component can be added (e.g. because it requires another component)

fn can_remove(data: &mut Self::SystemData, entity: Entity) -> bool

Decide if this component can be removed (e.g. because it's required by another component)

fn add(data: &mut Self::SystemData, entity: Entity)

fn setup(data: &mut Self::SystemData, entity: Option<Entity>)

This method is ran on all entities, even if none are selected

Loading content...

Implementations on Foreign Types

impl<'a> Inspect<'a> for Blink

type SystemData = (ReadStorage<'a, Self>, Read<'a, LazyUpdate>)

fn can_add(_: &mut Self::SystemData, _: Entity) -> bool

fn inspect((storage, lazy): &mut Self::SystemData, entity: Entity)

fn add((_storage, lazy): &mut Self::SystemData, entity: Entity)

fn can_remove(data: &mut Self::SystemData, entity: Entity) -> bool

fn setup(data: &mut Self::SystemData, entity: Option<Entity>)

impl<'a> Inspect<'a> for Named

type SystemData = (ReadStorage<'a, Self>, Read<'a, LazyUpdate>)

fn can_add(_: &mut Self::SystemData, _: Entity) -> bool

fn inspect((storage, lazy): &mut Self::SystemData, entity: Entity)

fn add((_, lazy): &mut Self::SystemData, entity: Entity)

fn can_remove(data: &mut Self::SystemData, entity: Entity) -> bool

fn setup(data: &mut Self::SystemData, entity: Option<Entity>)

impl<'a> Inspect<'a> for Rgba

type SystemData = (ReadStorage<'a, Self>, Read<'a, LazyUpdate>)

fn can_add(_: &mut Self::SystemData, _: Entity) -> bool

fn inspect((storage, lazy): &mut Self::SystemData, entity: Entity)

fn add((_storage, lazy): &mut Self::SystemData, entity: Entity)

fn can_remove(data: &mut Self::SystemData, entity: Entity) -> bool

fn setup(data: &mut Self::SystemData, entity: Option<Entity>)

impl<'a> Inspect<'a> for SpriteRender

type SystemData = (ReadStorage<'a, Self>, ReadExpect<'a, AssetStorage<SpriteSheet>>, Read<'a, SpriteList>, Read<'a, LazyUpdate>)

fn inspect(
    (storage, sprites, sprite_list, lazy): &mut Self::SystemData,
    entity: Entity
)

fn can_add((_, _, sprite_list, _): &mut Self::SystemData, _: Entity) -> bool

fn add((_, _, sprite_list, lazy): &mut Self::SystemData, entity: Entity)

fn can_remove(data: &mut Self::SystemData, entity: Entity) -> bool

fn setup(data: &mut Self::SystemData, entity: Option<Entity>)

impl<'a> Inspect<'a> for TextureHandle

type SystemData = (ReadStorage<'a, Self>, Read<'a, TextureList>, Read<'a, LazyUpdate>)

fn inspect((storage, texture_list, lazy): &mut Self::SystemData, entity: Entity)

fn can_add((_, texture_list, _): &mut Self::SystemData, _: Entity) -> bool

fn add((_, texture_list, lazy): &mut Self::SystemData, entity: Entity)

fn can_remove(data: &mut Self::SystemData, entity: Entity) -> bool

fn setup(data: &mut Self::SystemData, entity: Option<Entity>)

impl<'a> Inspect<'a> for Transform<f32>

type SystemData = (ReadStorage<'a, Self>, Read<'a, LazyUpdate>, Write<'a, TransformInspectorData>)

fn can_add(_: &mut Self::SystemData, _: Entity) -> bool

fn inspect((storage, lazy, data): &mut Self::SystemData, entity: Entity)

fn add((_storage, lazy, _): &mut Self::SystemData, entity: Entity)

fn can_remove(data: &mut Self::SystemData, entity: Entity) -> bool

fn setup(data: &mut Self::SystemData, entity: Option<Entity>)

impl<'a> Inspect<'a> for UiText

type SystemData = (ReadStorage<'a, Self>, ReadStorage<'a, UiTransform>, ReadExpect<'a, Loader>, ReadExpect<'a, AssetStorage<FontAsset>>, Read<'a, FontList>, Read<'a, LazyUpdate>)

fn can_add(_: &mut Self::SystemData, _: Entity) -> bool

fn inspect(
    (storage, _, _, _, font_list, lazy): &mut Self::SystemData,
    entity: Entity
)

fn add(
    (_storage, transforms, loader, fonts, font_list, lazy): &mut Self::SystemData,
    entity: Entity
)

fn can_remove(data: &mut Self::SystemData, entity: Entity) -> bool

fn setup(data: &mut Self::SystemData, entity: Option<Entity>)

impl<'a> Inspect<'a> for UiTransform

type SystemData = (ReadStorage<'a, Self>, Read<'a, LazyUpdate>)

fn can_add(_: &mut Self::SystemData, _: Entity) -> bool

fn inspect((storage, lazy): &mut Self::SystemData, entity: Entity)

fn add((_, lazy): &mut Self::SystemData, entity: Entity)

fn can_remove(data: &mut Self::SystemData, entity: Entity) -> bool

fn setup(data: &mut Self::SystemData, entity: Option<Entity>)

impl<'a> Inspect<'a> for Hidden

type SystemData = Read<'a, LazyUpdate>

fn can_add(_: &mut Self::SystemData, _: Entity) -> bool

fn add(lazy: &mut Self::SystemData, entity: Entity)

fn inspect(data: &mut Self::SystemData, entity: Entity)

fn can_remove(data: &mut Self::SystemData, entity: Entity) -> bool

fn setup(data: &mut Self::SystemData, entity: Option<Entity>)

impl<'a> Inspect<'a> for HiddenPropagate

type SystemData = Read<'a, LazyUpdate>

fn can_add(_: &mut Self::SystemData, _: Entity) -> bool

fn add(lazy: &mut Self::SystemData, entity: Entity)

fn inspect(data: &mut Self::SystemData, entity: Entity)

fn can_remove(data: &mut Self::SystemData, entity: Entity) -> bool

fn setup(data: &mut Self::SystemData, entity: Option<Entity>)

impl<'a> Inspect<'a> for ScreenSpace

type SystemData = Read<'a, LazyUpdate>

fn can_add(_: &mut Self::SystemData, _: Entity) -> bool

fn add(lazy: &mut Self::SystemData, entity: Entity)

fn inspect(data: &mut Self::SystemData, entity: Entity)

fn can_remove(data: &mut Self::SystemData, entity: Entity) -> bool

fn setup(data: &mut Self::SystemData, entity: Option<Entity>)

impl<'a> Inspect<'a> for Transparent

type SystemData = Read<'a, LazyUpdate>

fn can_add(_: &mut Self::SystemData, _: Entity) -> bool

fn add(lazy: &mut Self::SystemData, entity: Entity)

fn inspect(data: &mut Self::SystemData, entity: Entity)

fn can_remove(data: &mut Self::SystemData, entity: Entity) -> bool

fn setup(data: &mut Self::SystemData, entity: Option<Entity>)

impl<'a> Inspect<'a> for Flipped

type SystemData = (Read<'a, LazyUpdate>, ReadStorage<'a, Self>)

fn inspect((lazy, storage): &mut Self::SystemData, entity: Entity)

fn can_add(_: &mut Self::SystemData, _: Entity) -> bool

fn add((lazy): &mut Self::SystemData, entity: Entity)

fn can_remove(data: &mut Self::SystemData, entity: Entity) -> bool

fn setup(data: &mut Self::SystemData, entity: Option<Entity>)

Loading content...

Implementors

impl<'a> Inspect<'a> for UiTransformDebug

type SystemData = (ReadStorage<'a, Self>, ReadStorage<'a, UiTransform>, ReadStorage<'a, Transform<f32>>, ReadStorage<'a, Parent>, ReadExpect<'a, ParentHierarchy>, ReadExpect<'a, ScreenDimensions>, ReadStorage<'a, Named>, ReadStorage<'a, Camera>, Entities<'a>, Read<'a, LazyUpdate>)

fn setup(
    (storage, ui_transforms, transforms, _, _, dimensions, _, cameras, entities, lazy): &mut Self::SystemData,
    inspectee: Option<Entity>
)

fn inspect(
    (storage, _, _, _, _, _, names, cameras, entities, lazy): &mut Self::SystemData,
    entity: Entity
)

fn can_add(
    (_, ui_transforms, _, _, _, _, _, cameras, entities, _): &mut Self::SystemData,
    entity: Entity
) -> bool

fn add(
    (_, _, _, _, _, _, _, cameras, entities, lazy): &mut Self::SystemData,
    entity: Entity
)

fn can_remove(data: &mut Self::SystemData, entity: Entity) -> bool

Loading content...