Function getRandom

getRandom<T>(enumObject: T, random: Random<IRandomGenerator<any>>, filter?: ((value: T[keyof T], index: number) => boolean)): Exclude<T[keyof T], AnyFunction>
Returns a random enum entry.
Type Parameters
- T
Parameters
- enumObject: T
  
  The full enumeration. EG: ItemType, CreatureType, DoodadType, etc
- random: Random<IRandomGenerator<any>>
  
  The random instance to use. Defaults to seeded random. Note that using this method in non-game locations may cause seed desyncs!
- Optional filter: ((value: T[keyof T], index: number) => boolean)
  
  Repeats the choice until the random value matches the filter
  - - (value: T[keyof T], index: number): boolean
    - Parameters
      
      value: T[keyof T]
      
      index: number
      
      Returns boolean
Returns Exclude<T[keyof T], AnyFunction>
- Defined in src/game/utilities/enum/Enums.ts:115

Generated using TypeDoc