Giter Club home page Giter Club logo

roblox-random-picker's Introduction

Roblox-Random-Picker

An easy way to pick random items.

Basic Usage:

local RandomPicker = require(path)

local MyPicker = RandomPicker.new()

MyPicker:Add(item: any, rarity: number)
MyPicker:Remove(item: any)

local RandomItem = MyPicker:Pick(seed: number | nil)
MyPicker:Destroy()

print(RandomItem)

Chest Example:

-- Picking a random item from a chest

local RandomPicker = require(path)

local Chest = RandomPicker.new()

Chest:Add('Sword', 20)
Chest:Add('Axe', 30)
Chest:Add('Shield', 40)
Chest:Add('Potion', 10)

local ChosenItem = Chest:Pick()
print(ChosenItem .. ' was chosen!')

Murder Example:

-- Picking a random player to be the murder

local Players = game:GetService('Players')

local RandomPicker = require(path)

local function ChooseMurder()
	local MurderPicker = RandomPicker.new()

	for _, player in ipairs(Players:GetPlayers()) do
		local chance = player:GetAttribute('ChanceToBeMurder')
		MurderPicker:Add(player, chance)
	end

	return MurderPicker:SinglePick()
end

local Murder = ChooseMurder()
print(Murder.Name .. ' is the murder!')

Methods

local Picker = RandomPicker.new()

Picker:Add(item: any, rarity: number) -- adds an item with a rarity
Picker:Remove(item: any) -- removes a previous added item
Picker:Pick(seed: number | nil) -- picks a random item
Picker:SinglePick(seed: number | nil) -- calls 'Picker::Pick' and then, 'Picker::Destroy'
Picker:Destroy() -- destroys the picker

roblox-random-picker's People

Contributors

gaffal avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.