About

[!IMPORTANT] Documentation was partially AI assisted. Though looked over, there may be small inaccuracies. Please open an issue if you spot any.

Installation

Install package via NPM:

npm i @kunosyn/shatterbox

Add path to tsconfig.json in compilerOptions.typeRoots

"typeRoots": ["node_modules/@kunosyn", ...]

Add path to @kunosyn to default.project.json in rbxts_include/node_modules.

"ReplicatedStorage": {
  "$className": "ReplicatedStorage",
  "rbxts_include": {
    "$path": "include",
    "node_modules": {
      "$className": "Folder",
      "@kunosyn": {
        "$path": "node_modules/@kunosyn"
      }
    }
  },
}

Done!

Usage Example

Here's some basic examples of using the shatterbox module:

Server Initialization

import Shatterbox from '@kunosyn/shatterbox'

const shatterbox = new Shatterbox()

shatterbox.Start()

// Registers one of the default effects.
shatterbox.RegisterOnVoxelDestruct('BumpyFloorBreakWalls', shatterbox.DefaultEffects.BumpyFloorBreakWalls)

Client Initialization

import Shatterbox from '@kunosyn/shatterbox'

const shatterbox = new Shatterbox()

shatterbox.Start()

Jujustu Shenanigans Styled Destruction (Server)

import Shatterbox from '@kunosyn/shatterbox'

const shatterbox = new Shatterbox()

shatterbox.Start()

// Registers one of the default effects.
shatterbox.RegisterOnVoxelDestruct('BumpyFloorBreakWalls', shatterbox.DefaultEffects.BumpyFloorBreakWalls)

// Create a Hitbox Instance
const hb = this.shatterbox.CreateHitbox()
hb.Size = Vector3.one.mul(10) // Sets the hitbox size
hb.OnVoxelDestruct = 'BumpyFloorBreakWalls' // Sets the Destruction Effect
hb.CleanupDelay = 10 // How long to wait until cleanup

// Replace with your networking solution of choice.
Events.M1.Connect((player, hitPosition, normal) => {
  const char = player.Character || player.CharacterAdded.Wait()[0]
  const hrp = char.WaitForChild('HumanoidRootPart') as BasePart

  hb.CFrame = new CFrame(hit) // Sets the position of the hitbox
  hb.UserData['CastOrigin'] = hrp.Position // Sets the cast origin.
  hb.Destroy() // Destructs the voxels in the hitbox.
})