api.module
README.md
api
The one interface to pickupsKit: local Pickups = require("pickupsKit.api").
- Pickups:
spawn,burst,setLook,collect,available,all,openChest. - Counters:
get,counts,allCounts,add,set,spend,reset,ledger. - Letters:
letters,spelled,giveLetter,clearLetters. - Power-ups:
givePowerup,powerup,powerupLeft,activePowerups,damageMultiplier. - Catalog:
looks(filter by style, kind, effect or size),look,styles,kinds,effects,powerups,counters,sizes,dependencies. - Identity and collectors:
keyOf,nameOf,localKey,localAvatar,owns,addCollector,removeCollector. - Setup and events:
setup,installDamageFilter, andonfor collect, counter, letter, powerup, powerupEnd, respawn, expire, burst and chest.
It also runs the components. The owner of each pickup decides claims and announces them with event ids that every peer de-duplicates, and only the ledger's owner writes counts. Functions starting with _ are the components' hooks. The package README lists every argument.