This mod provides a framework for creating weighted randomized tables of Game Stages. If you do not know what a game stage is, it is highly recommended that you familiarize yourself with the Game Stage mod first. The basic idea of this mod is that modpacks cad define a table of game stages They can then use a command provided by this mod to award a player a random stage from that table. This mod also requires a basic understanding of CraftTweaker scripting to use it effectively.
For in depth examples, please checkout the GitHub page. There is also a Discord server where you can ask for help and advice.
Commands
- /stagetable - Provides a list of all commands added by this mod.
- /stagetable dump - Generates a file containing information about all the stage tables.
- /stagetable award <player> <table> - Attempts to award a player with a random stage from the specified table.
- /stagetable silentaward <player> <table> - Same as the award command, but doesn't notify the player about it.
Basic Terminology
- Stage Table - A named table that contains stage entries.
- Stage Entry - An entry in a stage table. Each entry has a stage that will be awarded, a weight value, and a list of conditions.
- Stage Condition - A condition that must be met for a stage entry to be awardable to a given player.
Weighted Randomness
Weight is a form of probability system where the possible outcomes have unequal odds of happening The percent chance of any given outcome can be calculated by dividing the weight of a specific entry by the total weight of all entries in a table. For example if an entry has a weight of one, and the total weight is 9, there is a 10% chance of the first outcome. Weighted randomness is commonly used when the pool of outcomes needs to be flexible. If you are still unsure, you can run the dump command which will generate visual tables based on the tables that you have created.
CraftTweaker Scripting
Below is an example script that shows the various things made available. For more precise information please check here for the exact information.
// Basic imports used in this script import crafttweaker.player.IPlayer;// Creates a new stage table with the name exampleTable val testTable = stageTables.createTable("exampleTable");
// Creates a new stage entry for stage "one" with a weight of 5. val entryOne = testTable.createEntry("one", 5);
// Creates a new stage entry for stage "two" with a weight of 5. val entryTwo = testTable.createEntry("two", 5);
// Prevent entryTwo from being selected unless the player has stage "four". entryTwo.addStageCondition("four");
// Creates a new stage entry for stage "three" with a weight of 1. val entryThree = testTable.createEntry("three", 1);
// Adds a custom condition to aquiring this entry using ZenScript. // In this case, it's only valid if the player is in creative mode. entryThree.addCondition(function(player as IPlayer) { return player.creative; });
