Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 

readme.md

Shuffle module for AttractMode front end

by Keil Miller Jr

mvscomplete retrorama2

DESCRIPTION:

Shuffle module is for the AttractMode front end. It will aid in the use of slots (objects) used as a navigable list.

This module is meant to be simple. It does not handle presentation of object, nor does it handle object animation as a moving list. If you are looking for an animated list, please look at the conveyor module included with AttractMode.

Paths

You may need to change file paths as necessary as each platform (windows, mac, linux) has a slightly different directory structure.

Install Files

Shuffle currently has no dependancies.

  1. Copy module files to $HOME/.attract/modules/shuffle/.

Usage

From within your layout, you will load the Shuffle module. Shuffle keeps presentation and logic separate. It is up to you to create your objects and apply properties to them. You will then create an instance of the class.

// Load the Shuffle module
fe.load_module("shuffle");

// Create your objects
local list = [];
	list.push(fe.add_text("Title", -1, -1, 1, 1));
	list.push(fe.add_text("Title", -1, -1, 1, 1));
	list.push(fe.add_text("Title", -1, -1, 1, 1));

// Create an instance of the Shuffle class
// Shuffle({arg=val})
// Options:
//  loop=bool - defaulting argument
// 	save=string - optional argument
// 	slots=array - required argument
// 	reset=bool - defaulting argument

local list = Shuffle({ reset=false, save="mytheme", slots=list });
Supported objects
  • artwork
  • image
  • text
  • preserveImage
  • preserveArt

Extending the class

public variables
  • VERSION
public methods
  • getSelected()
  • getSlots()
  • getVersion()
  • setSelected(slot)
private methods
  • _refresh()
  • _refreshAll(slot)
  • _refreshDeselected(slot)
  • _refreshSelected(slot)
  • _signals(signal_str)
  • _transitions(ttype, var, ttime)
  • _updateIndexOffsets()

This example will extend the Shuffle class and make a selected slot bold and deselected slots regular.

// Load the Shuffle module
fe.load_module("shuffle");

// Create your objects
local list = [];
	list.push(fe.add_text("Title", -1, -1, 1, 1));
	list.push(fe.add_text("Title", -1, -1, 1, 1));
	list.push(fe.add_text("Title", -1, -1, 1, 1));

class ShuffleList extends Shuffle {
	// Overwrite the _refreshAll function
	// Useful for conditional logic like game info
	function _refreshAll(slot) {}

	// Overwrite the _refreshSelected function
	function _refreshSelected(slot) {
		slot.style = Style.Bold;
	}

	// Overwrite the _refreshDeselected function
	function _refreshDeselected(slot) {
		slot.style = Style.Regular;
	}
}

// Create an instance of the ShuffleList class
local list = ShuffleList({slots=list});

Notes

I made this plugin available open source to help others create layouts. Either instruct users to download from this repo, or distribute all files in this repo including the license and readme.

More functionality is expected as it meets my needs. If you have an idea of something to add that might benefit a wide range of layout developers, please join the AttractMode forum and send me a message.

About

No description, website, or topics provided.

Resources

License

Packages

No packages published