Jazz Jackrabbit 2 Online

Please read the following description before using this.

The basic story behind this mutator is that I wanted an onHurt hook, but that doesn’t exist in the API. There doesn’t seem to be a straightforward way to check for collisions in the current API either, but whipping that up was easier than a theoretical onHurt, so thus the birth of this mutator, good enough.

This mutator isn’t really meant to be used standalone. Rather, it’s meant to be used as a library. A simple example of this is in player_collision_example.mut. Only player_collision_detector.mut and player_collision_detector_interface.asc are needed if you plan to use it.

———

COLLIDE::getDetector(bool debug = false) returns the object where you can interact with the detector. The default argument for debug is false, but you can pass true to log messages whenever the function fails for any reason. If successful, the returned object contains the following methods:

• void setHook(COLLIDE::HOOK@ hook = onCollide, uint moduleID = jjScriptModuleID)
  Sets a function to be called whenever a player collides with another player. The function signature assumes you’ve (probably) already defined a global function called onCollide, so you don’t need to pass any arguments when calling it. If you’d prefer to provide a different function, then call setHook(myFunc) with myFunc being your function. The second parameter, which defaults to your distinct script module’s ID, is how the detector keeps track of multiple hooks from different scripts. It’s best to let the default argument handle it and avoid passing in a different ID; otherwise, you may introduce some interesting behavior.

• void unsetHook(uint moduleID = jjScriptModuleID)
  Removes the function that was provided from setHook by a script associated with the given moduleID. By default, this is the same script where you would call setHook.

It is important to note that the methods described above only apply to the local player. This does not matter if you use them in a hook that is called for all players (e.g., onLevelLoad, onLevelBegin), but if these are not your use cases then you must consider this. On the other hand, the methods listed below will affect all players:

• void startDetecting()
  Allows players to have onCollide be called whenever a collision occurs. To achieve this, startDetecting initially modifies each weapon’s behavior and playerHandling property. If you have any custom weapon scripts, you must be careful on when to call it (perhaps the simplest solution is to use TimerV).

• void stopDetecting()
  Stops onCollide from being called whenever a collision occurs. This also restores the previous behavior and playerHandling property of all weapons at the time startDetecting was called.

———

Any function can be passed as the first argument to setHook as long it has the signature void function(jjPLAYER@ victim, jjPLAYER@ collider, COLLIDE::Collide collision) The first two parameters are self-explanatory. The third parameter is the type of collision that gets passed in as an argument. Possible values are:

• COLLIDE::BULLET (Caused by a weapon with damage 1)
• COLLIDE::BULLETPU (Caused by a weapon with damage 2)
• COLLIDE::BUMP (Caused by a player bumping onto another player)
• COLLIDE::STOMPORRUSH (Caused by a player buttstomping or passing through another player while on sugar rush)
• COLLIDE::SPECIALMOVE (Caused by a player doing a special move through another player, like Spaz’s karate kick for example)

———

Change Log:

2/19/2025 10PM UTC
- Fixed bugs that caused some weapons to be in an infinite exploding state and Gun8 not firing for the local player.

2/19/2025 6AM UTC
- First release

The JJ2+ devs implementation of AngelScript for allowing me to come up with this abomination.