Struct Ask 

pub struct Ask {
    pub title: String,
    pub body: String,
    pub choices: Vec<Choice>,
    pub free_text: bool,
    pub initial: Option<String>,
    pub multiline: bool,
    pub inline: bool,
    pub multiple: bool,
}

A question for the user. Spawn it with the agent it is about (ForAgent), if any; it is an open effect, recorded with its answer. To change an open question, spawn the new one and insert SupersededBy(new) on the old one: the old one settles as superseded and a front shows the new one in its place, keeping the user’s ticks. An old one that is a hold releases what it holds as it settles, so move the hold first.

Fields

title: String

The question, in a line.

body: String

What it is about, such as a command to run; may be empty.

choices: Vec<Choice>

The answers to choose from, in order; the first is the default.

free_text: bool

Whether a line of text answers it too, alone or as a note on a choice.

initial: Option<String>

The text a typed answer starts from, for the user to edit.

multiline: bool

Whether a typed answer may span lines.

inline: bool

Whether a front shows it beside the work, leaving the keys to the input, rather than in front of it. The user’s next line to the agent is then a message, not its answer.

multiple: bool

Whether the user may take several of its choices, which the Answer then holds.

Implementations

impl Ask

pub fn new(title: impl Into<String>) -> Self

A question titled title, without choices yet.

pub fn yes_no(title: impl Into<String>) -> Self

A question answered yes or no.

pub fn body(self, body: impl Into<String>) -> Self

The same question, about body.

pub fn choice(self, id: impl Into<String>, label: impl Into<String>) -> Self

The same question, offering id read as label.

pub fn with(self, choice: Choice) -> Self

The same question, offering choice.

pub fn free_text(self) -> Self

The same question, also answered by a line of text.

pub fn initial(self, text: impl Into<String>) -> Self

The same question, answered by text that starts from text, which the user edits.

pub fn multiline(self) -> Self

The same question, answered by text that may span lines.

pub fn inline(self) -> Self

The same question, shown beside the work: the user keeps the input and answers it when they choose.

pub fn multiple(self) -> Self

The same question, answered by any number of its choices, none included.

Trait Implementations

impl Clone for Ask

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for Ask

where Self: Send + Sync + 'static,

Required Components: Name.

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn on_add() -> Option<ComponentHook>

Gets the on_add ComponentHook for this Component if one is defined.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

const HAS_SUMMARY_TICK: bool = false

Set this constant to true if the component should track a summary tick.

impl Debug for Ask

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Ask

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Ask

impl PartialEq for Ask

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Ask

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Ask