concealKit.package
This package holds more than this page lists. See all of its files in its world.
README.md
api
concealKit's one public interface: local Hide = require("concealKit.api"). Games, scenes and other kits call it; nothing else in the package needs to be required directly.
- Building:
Hide.spot(pos, kind?, opts?),Hide.guard(pos, opts?),Hide.body(target, fields?),Hide.evidence(target, kind?, opts?),Hide.handcart(pos, opts?),Hide.water(pos, size?, opts?). - Playing:
Hide.knockOut(target, opts?),Hide.revive(target),Hide.pullOut(player),Hide.spotOf(player),Hide.isHidden(player),Hide.carrying(player),Hide.bodies(),Hide.allSpots(),Hide.ensurePlayer(). - Events:
Hide.on(name, fn)(hidden, left, caught, knockedOut, killed, pickedUp, dropped, thrown, stashed, disposed, loaded, cartPushed, cartReleased, noticed, found, alarm); returns a function that stops listening. - Data:
Hide.kinds,Hide.defineSpot,Hide.tuneSpot,Hide.findSpots,Hide.alarmLevels,Hide.alarmLevel,Hide.tuneAlarm,Hide.setEvidenceLevel,Hide.defineEvidence,Hide.extendBrain. - Names and modules:
Hide.VERSION, the component namesHide.SPOT,Hide.BODY,Hide.EVIDENCE,Hide.HANDCART,Hide.ZONE,Hide.PLAYER, andHide.spots,Hide.alarms,Hide.media,Hide.guardBrains.
Requiring it also loads the guard module, which registers the hide-aware aiKit presets, so require it from the scene's entrypoint.luau on every peer. The package README lists every call with its options.
Part of concealKit.