Struct Game

Source
pub struct Game<S: Resource + Send + Sync + 'static> { /* private fields */ }
Expand description

A Game represents the entire game and its data. By default the game will spawn an empty window, and exit upon Esc or closing of the window. Under the hood, Rusty Engine syncs the game data to Bevy to power most of the underlying functionality.

Game forwards method calls to Engine when it can, so you should be able to use all of the methods from Engine on Game during your game setup in your main() function.

Implementations§

Source§

impl<S: Resource + Send + Sync + 'static> Game<S>

Source

pub fn new() -> Self

Create an new, empty Game with an empty Engine

Source

pub fn window_settings(&mut self, window: Window) -> &mut Self

Use this to set properties of the native OS window before running the game. See the window example for more information.

Source

pub fn run(&mut self, initial_game_state: S)

Start the game.

Source

pub fn add_logic(&mut self, logic_function: fn(&mut Engine, &mut S))

logic_function is a function or closure that takes two parameters and returns nothing:

  • engine: &mut Engine
  • game_state, which is a mutable reference (&mut) to the game state struct you defined, or &mut () if you didn’t define one.

Methods from Deref<Target = Engine>§

Source

pub fn add_sprite<T: Into<String>, P: Into<PathBuf>>( &mut self, label: T, file_or_preset: P, ) -> &mut Sprite

Create and add a Sprite to the game. Use the &mut Sprite that is returned to adjust the translation, rotation, etc. Use a unique label for each sprite. Attempting to add two sprites with the same label will cause a crash.

Source

pub fn add_text<T, S>(&mut self, label: T, text: S) -> &mut Text
where T: Into<String>, S: Into<String>,

Create and add a Text to the game. Use the &mut Text that is returned to adjust the translation, rotation, etc. Use a unique label for each text. Attempting to add two texts with the same label will cause a crash.

Trait Implementations§

Source§

impl<S: Resource + Send + Sync + 'static> Default for Game<S>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<S: Resource + Send + Sync + 'static> Deref for Game<S>

Source§

type Target = Engine

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<S: Resource + Send + Sync + 'static> DerefMut for Game<S>

Source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

Auto Trait Implementations§

§

impl<S> !Freeze for Game<S>

§

impl<S> !RefUnwindSafe for Game<S>

§

impl<S> Send for Game<S>

§

impl<S> !Sync for Game<S>

§

impl<S> Unpin for Game<S>

§

impl<S> !UnwindSafe for Game<S>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

Source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

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.
Source§

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

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

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.
Source§

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.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using data from the given World.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

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<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> WasmNotSend for T
where T: Send,