rbxts-vex 1.0.0 → 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 savruun
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,75 @@
+<!-- <div align="center">
+  <p>
+    <img src= />
+  </p>
+</div> -->
+
+<div align="center">
+  <a href=https://www.npmjs.com/package/rbxts-vex>
+    <img src=https://img.shields.io/npm/v/rbxts-vex />
+  </a>
+  <a href=https://www.npmjs.com/package/rbxts-vex>
+    <img src=https://img.shields.io/npm/dt/rbxts-vex />
+  </a>
+</div>
+
+## About
+An efficient, performance-minded voxel destruction model.
+Created by EternalEthel/qrisquinn. Ported to Typescript for rbxts by savruun.
+
+> [!IMPORTANT]
+> This package is a port of [Vex 2.0](https://devforum.roblox.com/t/vex-20-remastered-for-your-voxel-destruction-needs/1619456) last updated in January of 2022 meaning this package is not updated anymore.
+
+
+### Installation
+Install package via [NPM](https://www.npmjs.com/package/rbxts-vex):
+
+```sh
+npm i rbxts-vex
+```
+
+### Usage Example
+Here's some basic examples of using the vex module:
+
+
+> Destructible walls.
+
+```ts
+import { Workspace } from '@rbxts/services';
+import Vex from 'rbxts-vex';
+
+const wall = Workspace.WaitForChild('Wall') as Part
+const projectile = Workspace.WaitForChild('Projectile') as Part
+
+const structure = new Vex(wall, {
+  voxelSize: 2,
+  lifetime: 15
+})
+
+projectile.Touched.Connect((hit) => {
+  if (hit === wall) {
+    structure.Destroy()
+    structure.ApplyForce(projectile.AssemblyLinearVelocity.mul(10), projectile.Position)
+  }
+})
+```
+
+> Timed demolition.
+
+```ts
+import { Workspace } from '@rbxts/services';
+import Vex from 'rbxts-vex';
+
+const building = Workspace.WaitForChild('Building') as Model;
+
+task.wait(3)
+
+const structure = new Vex(building, {
+    voxelSize: 2,
+    lifetime: 30,
+    weldAdjacent: false // Let the pieces fall independently.
+})
+
+structure.Destroy()
+structure.ApplyForce(new Vector3(0, 1200, 0), building.PrimaryPart.Position);
+```

package/package.json

@@ -2,7 +2,7 @@
   "name": "rbxts-vex",
   "main": "src/init.luau",
   "types": "src/index.d.ts",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "An efficient, performance-minded voxel destruction model. Created by EternalEthel/qrisquinn (same person).",
   "license": "MIT",
   "author": "kunosyn",

package/src/index.d.ts

@@ -1,4 +1,4 @@
-export interface VexOptions {
+interface VexOptions {
     /**
      * Bigger voxels = better performance.
      * @default 1
@@ -46,9 +46,9 @@ export interface VexOptions {
     weldAdjacent?: boolean;
 }
 
-export interface VoxelStructure {
+interface VoxelStructure {
     /**
-     * Destroys the VoxelStructure and its physical Model/BasePart.
+     * Destroys the original model and applies voxelization. Use this before applying forces.
      */
     Destroy(): void;
 
@@ -71,13 +71,13 @@ export interface VoxelStructure {
     GetVoxelCount(): number;
 }
 
-export interface VoxelPoolStats {
+interface VoxelPoolStats {
     readonly active: number;
     readonly pooled: number;
     readonly total: number;
 }
 
-declare const Vex: {
+interface Vex{
     /**
      * 
      * @param source The BasePart or Model to voxelize.
@@ -97,4 +97,5 @@ declare const Vex: {
     clearPool(): void;
 }
 
-export default Vex;
+declare const Vex: Vex;
+export = Vex;