Root-Luck icon

Luck

Adds a luck stat to the game.

By Root
Last updated 2 hours ago
Total downloads 71
Total rating 0 
Categories Custom Cards Utilities
Dependency string Root-Luck-0.1.2
Dependants 0 other packages depend on this package

This mod requires the following mods to function

Root-RarityLib-1.3.0 icon
Root-RarityLib

A utility library for adding custom rarities to the game.

Preferred version: 1.3.0
Pykess-ModdingUtils-0.4.8 icon
Pykess-ModdingUtils

Utilities aimed at making modding easier and more accessible

Preferred version: 0.4.8
willis81808-UnboundLib-3.2.14 icon
willis81808-UnboundLib

This is a helpful utility for ROUNDS modders aimed at simplifying common tasks.

Preferred version: 3.2.14

README

By default luck increases the chance of seeing rarer cards. but it can also be used by other mods to improve the likelihood of chance based effects.

Usage as a library:

to have a card adjust a player's luck, add the Luck component to a card either in unity or in SetupCard, then set LuckAdd and/or LuckMult accordingly.

to have a luck based chance event, call Player.GetComponent<Luck>().RollLuck(chance) where chance is a float between 0.0 and 1.0 (inclusive) representing the base % likelihood of the event occurring.

if you are using the CustomCard component to make your card, in SetupCard you want the following code:

Luck luck = cardInfo.GetOrAddComponent<Luck>();
luck.LuckAdd = //the value you want to increase the player's luck by
luck.LuckMult = //the value you want to multiply the player's luck by
// note you likely wont be using both Add and Mult in the same card.