Expand description
A crate providing advanced and general features for games. It can be used just as much for simple ascii games than for full distributed mmorpg games.
Structs§
- Effector
Definition - The definition of a stat effector. This modifies temporarily the value of a stat.
- Effector
Definitions - Holds the definitions of the stat effectors.
- Effector
Instance - An active instance of an effector.
- Effector
Set - A collection of currently active effectors.
- Faction
- A team with the ability to claim ownership over terrain. WIP
- Faction
Flags - Fags that modify how a faction behaves and how the claimed terrain behaves.
- Faction
Settings - Settings of the faction module.
- Inventory
- Generics
- Inventory
Builder - Builder for
Inventory. - Item
Definition - An
ItemDefinitionstores the different properties of a type of item. It is a schema that contains the data which isn’t changing between different item instances. - Item
Definition Builder - Builder for
ItemDefinition. - Item
Definitions - A simple repository mapping the key K to the corresponding
ItemDefinition. - Item
Instance - An
ItemInstanceis a stack of item. It refers to theItemDefinition’s key. The associatedItemDefinitioncontains the data describing that object type. An item stack can be composed of one or many of the same item. It can also have a durability, which decreases when the item is used usingInventory::use_item. - Item
Instance Builder - Builder for
ItemInstance. - Item
Transition Batch - A transition in progress.
- Item
Transition Definition - A transition from one or more items into one or more different items. Can be used for all sorts of crafting.
- Item
Transition Definition Builder - Builder for
ItemTransitionDefinition. - Item
Transition Definitions - The definitions of all known stats.
- Land
Claim Settings - The settings related to terrain claiming and how the world is divided into claimable chunks.
- Leveled
- A levelable element. It can be anything: an item, a player, a monster, a skill.
- Loot
Tree - A loot tree based on the lower partial function construct. Each loot tree node has a chance associated with it.
- Loot
Tree Builder - A builder for the
LootTree. - Loot
Tree Node - A weighted node of a loot tree with the corresponding result.
- Skill
Definition - The definition of an usable skill.
- Skill
Definition Builder - Builder for
SkillDefinition. - Skill
Definitions - Holds the definitions of all known skills.
- Skill
Instance - An instance of a skill. There is one per skill per entity that can use it. Holds the cooldown for each skill.
- Skill
Set - The set of skill that can be used by an entity.
- Stat
Condition - Condition based on a stat to activate something.
- Stat
Definition - The definition of a stat. A stat is a named float value optionally constrained between two other values and with a default value. It is used to create effects, conditions and in general to hold state for each entity. For example, it can be used to contain the health or mana of an entity just as well as it can be used to keep track of the number of enemies positioned around an entity.
- Stat
Definition Builder - Builder for
StatDefinition. - Stat
Definitions - The definitions of all known stats.
- Stat
Instance - An instance of a stat. Contains a base value as well as a value after applying the stat effectors.
- Stat
Instance Builder - Builder for
StatInstance. - StatSet
- Holds the instances of all the stats an entity has.
- Tiered
- Tiered element. Simply adds a numerical value to any element.
- Unlockable
- An unlockable element. It can be unlocked to access the inner value if all conditions are met:
- Unlockable
Builder - Builder for
Unlockable. - Unlockables
- A structure holding all unlockables.
- User
- Base struct for the user of a game.
- User
Group - A clan. This is a group of multiple users.
- User
Group Settings - The settings of user groups.
Enums§
- Condition
Lost Reaction - What happens when the transition is stopped or conditions aren’t met anymore for it to continue.
- Effector
Type - The way this effector modifies the stat.
- Faction
Error - Errors that can occur while using factions.
- Inventory
Builder Error - Error type for InventoryBuilder
- Inventory
Sizing Mode - The way the inventory size is handled.
- Item
Definition Builder Error - Error type for ItemDefinitionBuilder
- Item
Error - The different errors that can happen when interacting with the
Inventory. - Item
Instance Builder Error - Error type for ItemInstanceBuilder
- Item
Transition Definition Builder Error - Error type for ItemTransitionDefinitionBuilder
- Move
ToFront Mode - The way items are removed from the inventory. Indicates if empty spots are left, and if not, how to fill them.
- Skill
Definition Builder Error - Error type for SkillDefinitionBuilder
- Stat
Condition Type - A condition based on a stat’s value.
- Stat
Definition Builder Error - Error type for StatDefinitionBuilder
- Stat
Instance Builder Error - Error type for StatInstanceBuilder
- Unlockable
Builder Error - Error type for UnlockableBuilder
- UseMode
- The way items are used in a transition.
Traits§
- Level
For - A trait that can calculate the level for something that can accumulate experience.
We suggest using
PartialFunctionwhen implementing this trait. - Slot
Type - A trait defining which items can be inserted into each inventory slot type.
Type Aliases§
- Faction
Repository - Alias type. List of all known factions.
- Faction
Result - Alias type. Result of faction methods that can fail.
- User
Repository - The list of all known users.