Crate rollenspielsache

Source
Expand description

The Rollenspielsache is a set of tools for managing tabletop RPG games. The goal is to handle the mechanics seamlessly, allowing you to participate in or run a tabletop encounter without getting distracted by rule clarifications.

This library is the core API defining all the entities involved and their relationships.

§Types

  • Roll
  • RollResult

Modules§

character
Characters - PCs, NPCs, drones.
dice
Dice is responsible for executing dice rolls.
error
Library error type.
game_system
Supported RPG-specific rules.
modifier
All the different types of modifier.
redis
Working with Redis datatypes.
skill
skill.rs is concerned with skills and abilities.

Functions§

ffi_string_free
Helper function to free strings generated by Rust. Clients need to call this to ensure proper cleanup. It is recommended to do iso in a way such that your finding performs this automatically. See the Rust FFI Omnibus for examples.
roll_base
Getter for base
roll_execute
Execute a roll
roll_free
Free the Roll object
roll_from_str
Construct a new Roll object from a string. This is the only way to build at present.
roll_repeat
Getter for repeat
roll_result_free
Free the RollResult object
roll_result_to_json
Get the JSON string from a RollResult
roll_result_to_string
Get the string representation of a roll result
roll_result_total
Get the string representation of a roll result
roll_to_string
Get the string representation of a roll