Built using Scalable Vector Graphics Spin2Win Wheel is a responsive, flexible, customisable, resolution independent spin wheel game whose outcomes you control.
Spin results, prizes, win/lose, number of spins and more can be controlled using JSON data. You can also customize the look and feel of Spin2Win Wheel to bring it in line with your brand or color scheme, set the probability of winning, add your own custom prize data and it even has an anti-cheat mechanism to prevent players placing the wheel on a chosen segment.
Features Spin2Win Wheel - Spin It 2 Win It!
- Probability
- API for game progress, tracking and results
- Spin destinations can be set to ensure a specific outcome
- Anti-cheat mechanism
- Supports infinite random spins
- Smooth intuitive spin/throw physics
- Customizable colors with unique or alternating pattern
- Customizable size, position and style of the graphics
- Responsive and scalable
- Edit the behavior and look using JSON or PHP
- Customizable number of wheel segments
- Use text or images (or both!) as the prize on each segment
- Supports animated GIFs as segment prize
- Touch and mouse input
- Supports desktop and mobile
- Resolution independent SVG graphics means it Spin2Win Wheel looks beautiful on high density displays
- Supports tick sound on/off while spinning
- Supports shadows to add depth
- Info popups can be styled via CSS
- Supports emojis
API
Events
Spin2WinWheel.onResult() - Returns Object. This can be set on the instance or passed in the init object. Returns the following:
- target - Spin2WinWheel - instance of the wheel
- spinCount - Integer - the current spin count for that result
- msg - String - the result text (this is resultText in the JSON)
- type - String - will return 'result'
- win - Boolean - will return true or false (based on the resultText in the JSON)
- gameId - String - the gameId (this is set in the JSON)
- userData - Object - an optional object that can contain your own specific data for each segment (this is set in the JSON)
Spin2WinWheel.onError() - Returns Object. This can be set on the instance or passed in the init object. Returns the following:
- target - Spin2WinWheel - instance of the wheel
- spinCount - Integer - the current spin count for that error. Remember this is zero-based.
- msg - String - the error text (this is invalidSpinText in the JSON)
- type - String - will return 'error'
- win - String - will return 'null'
- gameId - String - the gameId (this is set in the JSON)
Spin2WinWheel.onGameEnd() - Returns Object containing the target (instance of Spin2WinWheel), gameId and an array of result objects (object will be either result or error objects as above). This can be set on the instance or passed in the init object. Returns the following:
- target - Spin2WinWheel - instance of the wheel
- results - Object - an array of result objects.
- gameId - String - the gameId (this is set in the JSON)
Static Functions
Spin2WinWheel.reset() - Static function - resets the wheel.
Calls
Spin2WinWheel.init(vars:Object) - Function - initialises the wheel instance. See example under Usage. Accepts the following:
- onResult - pass in your own Result function. Called after every spin.
- onGameEnd - pass in your own Game End function. Called at the end of the game (unless there is no limit on number of spins).
- onError - pass in your own Error function.
- spinTrigger - pass in your own HTML button or trigger element to trigger the spin. The variable clickToSpin must be true in the JSON.
Spin2WinWheel.restart() - Function - call this to reset the wheel based on the current JSON data
Spin2WinWheel.getGameProgress() - Returns array of result objects - call this to view the results of the current game during play.
Update Spin2Win Wheel - Spin It 2 Win It! January 2018
Added new static function Spin2WinWheel.reset() that resets the wheel.
Added new property "spinDirection" in the JSON. Accepts "cw" (clockwise) and "ccw" (counter-clockwise).
