RoRR Modding Toolkit

Friendly abstractions of the game's internal functions for easier modding.
Documentation can be found here.

To use, include RoRRModdingToolkit-RoRR_Modding_Toolkit-1.0.13 as a dependency, and place the following line in your code:

mods.on_all_mods_loaded(function() for _, m in pairs(mods) do if type(m) == "table" and m.RoRR_Modding_Toolkit then Actor = m.Actor Buff = m.Buff Callback = m.Callback Equipment = m.Equipment Helper = m.Helper Instance = m.Instance Item = m.Item Net = m.Net Object = m.Object Player = m.Player Resources = m.Resources Survivor = m.Survivor Alarm = m.Alarm break end end end)

Current Functionality

• General-purpose helper functions
• Instance finding
• Callback setup
• Network syncing
• Custom content
  • Buffs
  • Items and Equipment
  • Objects
  • Survivors (still a WIP, but usable)

Installation Instructions

Follow the instructions listed here.

v1.0.0

• Initial release

v1.0.1

• Buff.remove : Can now remove a specified number of stacks.
• Buff.PROPERTY.stack_number_col : Now defaults to a size 1 array with the color 16777215 (pure white).
• Helper.log_hook
  • Fixed error when self/other was nil.
  • result now shows expanded arrays/structs.
• Added Actor module
  • Actor.fire_bullet
  • Actor.damage
  • Actor.heal
  • Actor.add_barrier
  • Actor.set_barrier
• Item.set_tier : Now positions the log at the end of the correct tier group when viewing in Logs and Unlockables.
• Added Item.spawn_drop

v1.0.2

• Added Actor.fire_explosion
• Added Buff onDraw callback
• Buff.get_stack_count : Now returns "0" if it returned "nil" previously.
• Item.spawn_drop : Now returns the dropped instance, and spawns on the exact y position.
• Added Object module
  • Object.find
  • Object.create
  • Object.spawn
  • Object.add_callback
• Instance.find, Instance.find_all : Now work with custom RMT Objects.
• Added Instance.number

v1.0.3

• Added hitbox system for custom objects
  • Object.set_hitbox
  • Object.is_colliding
  • Object.get_collisions
  • Object.get_collision_box

v1.0.4

• Added Instance.projectiles table
• Fixed Item onAttack callback throwing error sometimes.

v1.0.5

• Fixed Item onAttack callback error for real.
  • Item.get_stack_count will now return "0" if the actor is invalid or not a child of pActor.
• Object.is_colliding : Now works with a custom RMT Object instance as "other".
• Object.get_collisions : Now works with a custom RMT Object as "index".

v1.0.6

• Fixed apply_buff_internal error for custom buffs when an actor turned into another one (e.g., Lemurian rider being dismounted).
• Added Buff onChange callback

v1.0.7

• Added Item callbacks
  • onHeal
  • onShieldBreak
• Item onBasicUse callback now works with Sniper's Snipe properly.
• Added achievement functions for Item
  • Item.add_achievement
  • Item.progress_achievement
• Added Actor callback system
• Added Actor.find_skill_id
• Added Equipment module
  • Equipment.find
  • Equipment.create
  • Equipment.set_sprite
  • Equipment.set_cooldown
  • Equipment.set_loot_tags
  • Equipment.add_callback

v1.0.8

• Added achievement functions for Equipment
  • Equipment.add_achievement
  • Equipment.progress_achievement
• Custom Equipment item logs now appear after all the vanilla ones.

v1.0.9

• Added Helper.log_toolkit_stats
• Changed how onStep/onDraw callbacks work internally for several modules, heavily reducing lag.
  • EDIT: Once again I prematurely released a patch.

v1.0.10

• Optimized onStep/onDraw callback lag for real.
• Added 2 more projectiles to the Instance.projectiles table.
• Fixed literal memory leak with Buff.find when calling it a lot.
• RMT will now run its own __initialize before all other mods (not sure why this wasn't already the case).

v1.0.11

• Fixed callback tables not populating correctly in certain circumstances and crashing.

v1.0.12

• Item.spawn_drop now works correctly with vanilla items.

v1.0.13

• Added Item.toggle_loot
• Added Equipment.toggle_loot

v1.0.14

• Added Alarm module
  • Added Alarm.create, in an early state
• Fixed Survivor module

v1.0.15

• Fixed Actor.find_skill_id throwing an error at skill 186 when looping (which seems to be invalid).
• Fixed memory leaks in several places caused by iterating over GameMaker arrays with ipairs, as well as accessing them with lua syntax.
  • For anyone reading this, get array sizes with gm.array_length and access elements with gm.array_get instead.
• Added Class module, containing references to the global class arrays.

v1.0.16

• Fixed Actor.damage displaying "0" for damage number.
• Fixed potential memory leak in Net module.