Luck

Qualified name:Ouxsoft\LuckByDice\Luck
Implements:LuckInterface
class Luck
public __construct([])

Luck constructor.

Parameters:
  • $luck (int) – Default: 0
public disable()

Disable luck

public enable()

Enable luck

public get() → int

Gets luck

Returns:int –
public getActiveStatus() → bool

Get whether enabled or disabled

Returns:bool –
public getAdjustment() → string

Get name of selected adjustment algorithm

Returns:string –
public getApplicablePercent() → float

Get applicable luck as random percentage based on current luck

Returns:float –
public modify(int $number) → int

Modifies a number based on current luck

Parameters:
  • $number (int) –
Returns:

int –

public set(int $luck)

Sets luck

Parameters:
  • $luck (int) –
public setAdjustment([])

Set the luck adjustment algorithm

Parameters:
  • $algorithm (int) – Default: self::DEFAULT_ADJUSTMENT
public update([])

Update luck based on percentage of roll outcome

Parameters:
  • $rollPercent (float) – Default: 0.5