SlotEngine.SpinResult (core 1.0 API)

java.lang.Object

com.csse3200.game.components.slot.SlotEngine.SpinResult

Enclosing class:: SlotEngine

public static final class SlotEngine.SpinResult extends Object

Immutable object representing the result of a spin.

Constructor Summary

Constructors

Constructor

Description

SpinResult(int[] reels, SlotEngine.Effect effect)

Construct a spin result.
Method Summary

Modifier and Type

Method

Description

Optional<SlotEngine.Effect>

getEffect()

int[]

getReels()

boolean

isEffectTriggered()

String

toString()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- SpinResult
  
  public SpinResult(int[] reels, SlotEngine.Effect effect)
  
  Construct a spin result.
  
  Parameters:
  
  reels - a 3-length array with values in [0..7]
  
  effect - the triggered effect (null if none)
Method Details
- getReels
  
  public int[] getReels()
  
  Returns:
  
  Copy of reels array (length=3).
- isEffectTriggered
  
  public boolean isEffectTriggered()
  
  Returns:
  
  True if an effect was triggered.
- getEffect
  
  public Optional<SlotEngine.Effect> getEffect()
  
  Returns:
  
  The triggered effect wrapped in Optional.
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object