Struct widgetry::mapspace::world::ObjectBuilder

pub struct ObjectBuilder<'a, ID: ObjectID> {
    world: &'a mut World<ID>,
    id: ID,
    hitbox: Option<Polygon>,
    zorder: usize,
    draw_normal: Option<ToggleZoomedBuilder>,
    draw_hover: Option<ToggleZoomedBuilder>,
    tooltip: Option<Text>,
    clickable: bool,
    draggable: bool,
    keybindings: Vec<(MultiKey, &'static str)>,
}

This provides a builder API for adding objects to a World.

Fields

world: &'a mut World<ID>

id: ID

hitbox: Option<Polygon>

zorder: usize

draw_normal: Option<ToggleZoomedBuilder>

draw_hover: Option<ToggleZoomedBuilder>

tooltip: Option<Text>

clickable: bool

draggable: bool

keybindings: Vec<(MultiKey, &'static str)>

Implementations

impl<'a, ID: ObjectID> ObjectBuilder<'a, ID>

pub fn hitbox(self, polygon: Polygon) -> Self

Specifies the geometry of the object. Required.

pub fn zorder(self, zorder: usize) -> Self

Provides ordering for overlapping objects. Higher values are “on top” of lower values.

pub fn draw<I: Into<ToggleZoomedBuilder>>(self, normal: I) -> Self

Specifies how to draw this object normally (while not hovering on it)

pub fn draw_color(self, color: Color) -> Self

Draw the object by coloring its hitbox

pub fn draw_color_unzoomed(self, color: Color) -> Self

Draw the object by coloring its hitbox, only when unzoomed. Show nothing when zoomed.

pub fn drawn_in_master_batch(self) -> Self

Indicate that an object doesn’t need to be drawn individually. A call to draw_master_batch covers it.

pub fn draw_hovered<I: Into<ToggleZoomedBuilder>>(self, hovered: I) -> Self

Specifies how to draw the object while the cursor is hovering on it. Note that an object isn’t considered hoverable unless this is specified!

pub fn draw_hover_rewrite(self, rewrite: RewriteColor) -> Self

Draw the object in a hovered state by transforming the normal drawing.

pub fn hover_alpha(self, alpha: f32) -> Self

Draw the object in a hovered state by changing the alpha value of the normal drawing.

pub fn hover_outline(self, color: Color, thickness: Distance) -> Self

Draw the object in a hovered state by adding an outline to the normal drawing. The specified color and thickness will be used when unzoomed. For the zoomed view, the color’s opacity and the thickness will be halved.

pub fn hover_color(self, color: Color) -> Self

Draw the object in a hovered state by coloring its hitbox. Useful when drawn_in_master_batch is used and there’s no normal drawn polygon.

pub fn invisibly_hoverable(self) -> Self

Mark that an object is hoverable, but don’t actually draw anything while hovering on it

pub fn tooltip(self, txt: Text) -> Self

Draw a tooltip while hovering over this object.

pub fn clickable(self) -> Self

Mark the object as clickable. WorldOutcome::ClickedObject will be fired.

pub fn set_clickable(self, clickable: bool) -> Self

Mark the object as clickable or not. WorldOutcome::ClickedObject will be fired.

pub fn draggable(self) -> Self

Mark the object as draggable. The user can hover on this object, then click and drag it. WorldOutcome::Dragging events will be fired.

Note that dragging an object doesn’t transform it at all (for example, by translating its hitbox). The caller is responsible for doing that.

pub fn hotkey<I: Into<MultiKey>>(self, key: I, action: &'static str) -> Self

While the user hovers over this object, they can press a key to perform the specified action. WorldOutcome::Keypress will be fired.

pub fn build(self, ctx: &EventCtx<'_>)

Finalize the object, adding it to the World.