pistoncore-current 0.0.3

DEPRECATED. Use `current`.
Documentation
  • Coverage
  • 77.78%
    7 out of 9 items documented0 out of 7 items with examples
  • Size
  • Source code size: 7.71 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1.66 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 12s Average build duration of successful builds.
  • all releases: 12s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • PistonDevelopers/current
    22 5 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • bvssvni github:pistondevelopers:publish

current Build Status

A library for setting current values for stack scope, such as application structure

Example project: Sea Birds' Breakfast

How to use it

See Best coding practices with current objects

This also posts safety guidelines for the library.

Motivation

In game programming, there are many kinds of "current" values:

  • The current window
  • The current device
  • The current sound driver
  • The current player object

There are two ways to use this library:

  • An unsafe version that ease refactoring between current objects and mutable references
  • A safe version that can be used in experimental library design

By setting these up as "current" values, you don't have to pass them around to each method. For example, you can write code like this (demonstrating the unsafe version):

e.press(|button| {
    let gun = unsafe { &mut *current_gun() };
    let player = unsafe { &mut *current_player() };
    if button == SHOOT {
        gun.shoot(player.aim);
    }
});

How to contribute