Struct ayaka_runtime::Context

source ·
pub struct Context { /* private fields */ }
Expand description

The game running context.

Implementations§

source§

impl Context

source

pub fn open<'a>( paths: &'a [impl AsRef<Path>], frontend: FrontendType ) -> impl Future<Output = Result<Self>> + Stream<Item = OpenStatus> + 'a

Open a config file with frontend type.

If the input paths contains only one element, it may be a YAML or an FRFS file. If the input paths contains many element, they should all be FRFS files, and the latter one will override the former one.

source

pub fn set_start_context(&mut self)

Initialize the RawContext at the start of the game.

source

pub fn set_context(&mut self, ctx: RawContext)

Initialize the RawContext with given record.

source

pub fn game(&self) -> &Game

The inner Game object.

source

pub fn root_path(&self) -> &VfsPath

The root path of config.

source

pub fn call(&self, text: &Text) -> Result<String>

Call the part of script with this context.

source

pub fn switch(&mut self, i: usize)

Choose a switch item by index, start by 0.

source

pub fn get_action(&self, loc: &Locale, ctx: &RawContext) -> Result<Action>

Get the Action from [Locale] and RawContext.

source

pub fn next_run(&mut self) -> Option<RawContext>

Step to next line.

source

pub fn current_paragraph_title(&self, loc: &Locale) -> Option<&String>

Get current paragraph title.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for Twhere T: Any,

§

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> ErasedDestructor for Twhere T: 'static,

§

impl<T> MaybeSendSync for Twhere T: Send + Sync,