From 5cd7210cd84afb1e3846fbe0e39baa1e79962e2e Mon Sep 17 00:00:00 2001 From: Ben Culkin Date: Mon, 13 Apr 2020 18:35:08 -0400 Subject: Add some javadoc Add some javadoc comments --- .../bjc/rgens/parser/elements/ChanceCaseElement.java | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'src/main/java/bjc/rgens/parser/elements/ChanceCaseElement.java') diff --git a/src/main/java/bjc/rgens/parser/elements/ChanceCaseElement.java b/src/main/java/bjc/rgens/parser/elements/ChanceCaseElement.java index 483a103..1edccd3 100644 --- a/src/main/java/bjc/rgens/parser/elements/ChanceCaseElement.java +++ b/src/main/java/bjc/rgens/parser/elements/ChanceCaseElement.java @@ -2,11 +2,27 @@ package bjc.rgens.parser.elements; import bjc.rgens.parser.GenerationState; +/** + * A case element that has a '1 in n' chance to generate something. + * @author Ben Culkin + * + */ public class ChanceCaseElement extends CaseElement { + /** + * The case element to generate. + */ public final CaseElement elm; + /** + * The 'rarity' of generating output. + */ public int chance; + /** + * Create a new chance case element. + * @param elm The element to generate. + * @param chance The 'n' in the '1 in n' chance to generate the element. + */ public ChanceCaseElement(CaseElement elm, int chance) { super(elm.spacing); @@ -14,6 +30,7 @@ public class ChanceCaseElement extends CaseElement { this.chance = chance; } + @Override public void generate(GenerationState state) { if(state.rnd.nextInt(chance) == 0) elm.generate(state); } -- cgit v1.2.3