now( ) → number

fresh( ) → void

on(event: string, fn: Listener) → void

Event bus events: "phaseChanged" {from,to} "reset" {} "swing" {combo,heavy} "hit" {target,kind,damage,heavy,pos,dir} "enemyKilled" {kind,pos,eddies,boss} "playerDamaged" {amount,health,fromPos} "playerHealed" {amount,health} "eddies" {amount,total} "sunglassesToggled" {on} "bossCue" {} "dodge" {} "footstep" {sprint}

clearListeners( ) → void

Drops every subscription (the scene entrypoint calls this on unload).

emit(event: string, payload: any?) → void

setPhase(phase: string) → void

Phases

isPlaying( ) → boolean

reset( ) → void

Reset the run (title -> playing, or retry after a loss). Every slice listens to "reset" and puts its own pieces back.

startRun( ) → void

Start (or restart) a run: reset everything, then switch to playing.

setPlayerPose(x: number, y: number, z: number, yaw: number?) → void

Player

setInvulnerable(seconds: number) → void

damagePlayer(amount: number, fromPos: any?) → boolean

Enemies call this to hurt the player. Returns true when the damage landed.

healPlayer(amount: number) → void

addEddies(amount: number) → void

setSunglasses(on: boolean) → void

registerTarget(target: any) → void

Hit targets. The enemies slice registers every live enemy; the player's baton queries them and calls M.hit. target = { id = string, kind = string, position = () -> {x,y,z}, radius = number, takeHit = (damage, dir {x,z}, heavy) -> () }

unregisterTarget(id: string) → void

targets( ) → void

Every live target, keyed by id. This is the live table: iterate it with `for _, t in R.targets() do` (no copy is made). A target may unregister while you iterate (a kill), which Luau allows; do not add targets mid-loop. Optional fields an enemy target carries: label, level(), hp(), maxHp().

hit(target: any, damage: number, dir: any, heavy: boolean, crit: boolean?) → void

Called by the player slice when a swing connects. `crit` marks a critical roll from R.rollDamage; `dir.power` scales knockback.

reportKill(kind: string, pos: any, info: any?) → void

Called by the enemies slice when an enemy's hp reaches 0. info (optional) = { level = number?, encounter = string?, ambient = boolean? } Encounter and ambient kills give xp and eddies but do not count toward the street's 8 thugs or the boss.

objectiveText( ) → string

xpToNext(level: number) → number

XP needed to go from `level` to `level + 1`.

defineEnemy(kind: string, spec: any) → void

Slices may add enemy kinds (other gangs) with the same fields as M.enemies.tomato (+ xp, label, juice, height).

defineItem(id: string, def: any) → void

item(id: string, def: any) → void

newSkills( ) → any

newProfile( ) → any

migrate(p: any) → any

Fill fields a saved profile from an older version lacks.

profile( ) → any

tierOf(def: any) → number

An item's tier 1..5 (Common..Legendary). Catalog items carry `rarity`; items a slice defines without one are tiered by price.

defineGear(gid: string, spec: any) → any

Gear instances (dropped or upgraded pieces) live in profile.gear and are defined into M.items under their own "gear_N" ids.

defineAllGear(p: any) → void

store( ) → any

save( ) → void

Write the profile now. Slices never need to call this: every change below schedules a save on its own.

dirty( ) → void

hasSave( ) → boolean

refreshStats( ) → void

Recompute derived stats (max health tracks body, level and gear).

applyProfile(p: any, isNew: boolean) → void

loadGame( ) → boolean

Load the saved profile (or start a new one when there is none). The scene entrypoint calls this on load.

newGame( ) → void

Wipe the profile and the save: a brand-new V.

notify(text: string, kind: string?, color: string?) → void

Notifications: any slice may post one; the HUD shows them as toasts. kind: "info" | "xp" | "level" | "item" | "quest" | "romance" | "eddies" | "warn" | "hack"

johnnySays(text: string, seconds: number?) → void

A line from Johnny Silverpeel, the engram in V's head (story slice draws it).

level( ) → number return profile

Progression

xp( ) → void

attribute(name: string) → number return profile

attributePoints( ) → number return profile

check(attr: string, n: number) → boolean

An attribute check for dialogue and doors: true when V has at least n.

awardXp(amount: number, reason: string?) → void

spendAttribute(name: string) → boolean

maxHealth(a: any, L: number) → void

damageMult(a: any, L: number) → void

critChance(a: any, _L: number) → void

critMult(a: any, _L: number) → void

armor(a: any, _L: number) → void

maxRam(a: any, _L: number) → void

ramRegen(a: any, _L: number) → void

quickhackMult(a: any, L: number) → void

breachTime(a: any, _L: number) → void

priceMult(a: any, _L: number) → void

dodgeCooldownMult(a: any, _L: number) → void

perkSum(p: any, name: string) → number

stat(name: string) → number

A derived stat: attribute curve + perks × rank + skill levels + equipped gear (cyberware boosted by the cyberwareMult perk).

rollDamage(base: number, weapon: string, heavy: boolean?) → void

One swing's damage for `weapon` ("katana" | "baton"): base + gear, times the damage multiplier and every perk that applies, with a crit roll. Returns damage, crit.

weaponElement(weapon: string) → string

The element of the equipped weapon in that slot ("burn" | "shock" | nil).

itemCount(id: string) → number return profile

Inventory and equipment

hasItem(id: string) → boolean return M

inventory(kind: string?) → void

{ {id, count, def} } sorted by kind then name; optional kind filter.

addItem(id: string, count: number?, quiet: boolean?) → boolean

removeItem(id: string, count: number?) → boolean

equipped(slot: string) → string

canEquip(id: string) → void

equip(id: string) → boolean

unequip(slot: string) → void

useItem(id: string) → boolean

Use a consumable. Returns true when it was used up.

bestHeal( ) → string

Best healing consumable V carries (for the quick-heal key), or nil.

defineVendor(id: string, def: any) → void

def = { name, cast = castId, stock = { itemId, ... } }

spendEddies(amount: number) → boolean

price(id: string, buying: boolean) → number

What V pays (buying) or is paid (selling) for one of `id`.

buy(id: string, vendorId: string?) → void

sell(id: string, vendorId: string?) → void

openShop(vendorId: string) → void

Ask the shops slice to open a vendor's shop.

flag(name: string) → any return profile

Flags, counters, affection and romance

setFlag(name: string, value: any) → void

counter(name: string) → number return profile

bumpCounter(name: string, by: number?) → number

affection(npc: string) → number return profile

addAffection(npc: string, delta: number, reason: string?) → void

giftValue(npc: string, itemId: string) → number

How much a gift moves `npc` (loves 15, likes 6, anything else 2).

giveGift(npc: string, itemId: string) → number

romance( ) → string

setRomance(npc: string?) → void

defineQuest(def: any) → void

qstate(id: string) → any

questStatus(id: string) → string

questStage(id: string) → string

questActive(id: string) → boolean return M

questDone(id: string) → boolean return M

trackedQuest( ) → string

questLog( ) → void

Every quest V has, as { id, def, status, stage } (active first, by order).

trackQuest(id: string?) → void

retrack( ) → void

startQuest(id: string, stage: string?) → boolean

setQuestStage(id: string, stage: string) → boolean

grant(rewards: any?, reason: string?) → void

Grant a reward table { xp, eddies, items = {[id]=n}, affection = {[npc]=n} }.

completeQuest(id: string) → boolean

failQuest(id: string) → boolean

questStageDef(id: string) → any

The current stage definition of a quest, or nil.

setCastPosition(npc: string, pos: any) → void

castPosition(npc: string) → any

questWaypoint(id: string?) → any

Where the tracked quest wants V to go: { x, z, label, color } or nil.

reportQuickhack(id: string, targetId: string?) → void

The hacking slice calls this when a quickhack lands on a target.

focus( ) → string

UI focus. While a full-screen interaction is open (dialogue, shop, journal, inventory, breach) the player can't move or fight and enemies hold off.

setFocus(name: string) → boolean

Claim focus for `name`; false when something else holds it.

clearFocus(name: string?) → void

canControl( ) → boolean

True when the player may move, fight and interact.

startDialogue(script: any) → boolean

Dialogue (visual novel). The story slice renders it. script = { id, start = key, onEnd = fn?, nodes = { [key] = { speaker = castId | "narrator", mood = "neutral"|"happy"|"angry"|"sad"|"flirty"|"smug", text = string, next = key?, run = fn?, -- run fires when the node shows choices = { { text, next = key?, tag = "[COOL 5]"?, requires = fn()->bool?, run = fn? } }? } } } A node with neither `next` nor `choices` ends the conversation, and so does a choice with no `next`.

dialogueOpen( ) → boolean return S

endDialogue(script: any?) → void

The renderer calls this when the conversation closes.

addTalkProvider(npc: string, priority: number, fn: () → void

talkTo(npc: string) → boolean

registerInteractable(def: any) → void

unregisterInteractable(id: string) → void

nearestInteractable(pos: any?) → any

interact(id: string) → boolean

requestEncounter(def: any) → void

encounter(id: string) → any

encounters( ) → void

cancelEncounter(id: string) → void

encounterCleared(id: string) → void

The combat slice calls this when the last enemy of an encounter falls.

ram( ) → void

Hacking: RAM, breach protocol and quickhacks.

addRam(n: number) → void

spendRam(n: number) → boolean

requestBreach(def: any) → boolean

Ask the hacking slice to run a Breach Protocol. def = { id, label, difficulty = 1..3, onResult = fn(success: boolean)? }

breachResult(id: string, success: boolean) → void

The hacking slice calls this when the breach ends.

applyEffect(target: any, effect: string, params: any?) → boolean

Apply a status effect to a registered target, when it supports one. effect: "stun" {seconds} | "burn" {dps, seconds} | "shock" {damage} | "reveal" {seconds}

discover(placeId: string) → boolean

Places Mark a place discovered (first time: XP and "placeDiscovered").

perkRank(id: string) → number return profile

Perks: five attribute trees (game.rpg.perks). Tiers open at attribute 4 / 9 / 15 / 20; a level gives a perk point, skill milestones give more.

perkPoints( ) → number return profile

perkFlag(name: string) → boolean

True when V owns a perk carrying `flag` (Second Heart, Blade Dancer, ...).

canBuyPerk(id: string) → void

Can V buy the next rank of perk `id`? Returns ok, why-not.

buyPerk(id: string) → void

respecCost( ) → number return 50

Refund every perk point for eddies (attributes stay where they are).

respec( ) → void

skillLevel(id: string) → number

Skills: level by doing (game.rpg.perks skills). Each level adds a passive bonus to R.stat; levels 5 / 10 / 15 / 20 add a perk point.

skillXp(id: string) → void

xp into the current level, xp needed for the next.

addSkillXp(id: string, amount: number) → void

credLevel( ) → number return profile

Street cred: its own track. Vendor stock with `cred = n` needs level n.

cred( ) → void

level, xp into it, xp for the next

addCred(amount: number, reason: string?) → void

rarityOf(id: string) → number return tierOf

makeGear(baseId: string, r: number?) → string

Roll a new piece of `baseId` at tier r (default: the base's own tier). Defines the item and returns its id; R.addItem(id) gives it to V.

rollLoot(kind: string, level: number?) → void

What a dead enemy leaves besides eddies: item ids to drop (rolled gear is already defined). The boss always drops Epic or better.

canDisassemble(id: string) → void

disassemble(id: string) → void

Break an item down into crafting components (Engineer skill XP).

upgradeCost(id: string) → void

Cost to take `id` up one tier: component id, count, eddies (nil id when it can't go higher).

canUpgrade(id: string) → void

upgrade(id: string) → void

Upgrade one tier. A rolled piece upgrades in place; a shop item becomes a rolled piece of the next tier (staying equipped). Returns the item id.

quickhackCost(id: string) → number

RAM a quickhack costs after perks.

dodge(_payload: any) → void

A dodge feeds Shinobi and opens the Blade Dancer crit window.