@rbxts/destroyed-instance-logging v1.0.5

Destroyed Instance Logging

Destroyed Instance Logging is just a simple set of functions for making consistent destroyed instance logs.

Installation

roblox-ts

Simply install to your roblox-ts project as follows:

npm i @rbxts/destroyed-instance-logging

Wally

Wally users can install this package by adding the following line to their Wally.toml under [dependencies]:

DestroyedInstanceLogging = "bytebit/destroyed-instance-logging@1.0.5"

Then just run wally install.

From model file

Model files are uploaded to every release as .rbxmx files. You can download the file from the Releases page and load it into your project however you see fit.

From model asset

New versions of the asset are uploaded with every release. The asset can be added to your Roblox Inventory and then inserted into your Place via Toolbox by getting it here.

Documentation

Documentation can be found here, is included in the TypeScript files directly, and was generated using TypeDoc.

Example

Here's a simple example of a destroyable class with a couple public methods on it that we want to make sure logs consistently when a destroyed instance is misused.

import { assertNotDestroyed, warnAlreadyDestroyed } from "@rbxts/destroyed-instance-logging";

export class Destroyable {
  private isDestroyed = false;

  public destroy() {
    if (this.isDestroyed) {
      warnAlreadyDestroyed(this);
      return;
    }

    // destruction logic
    this.isDestroyed = true;
  }

  public foobar() {
    assertNotDestroyed(this.isDestroyed, this);

    // foobar logic
  }
}

local assertNotDestroyed = require(path.to.modules["destroyed-instance-logging"]).assertNotDestroyed
local warnAlreadyDestroyed = require(path.to.modules["destroyed-instance-logging"]).warnAlreadyDestroyed

local Destroyable = {}
Destroyable.__index = Destroyable

function new()
  local self = {}
  setmetatable(self, Destroyable)

  self.isDestroyed = false

  return self
end

function Destroyable:destroy()
  if self.isDestroyed then
    warnAlreadyDestroyed(self)
    return
  end

  -- destruction logic
  self.isDestroyed = true
end

function Destroyable:foobar()
  assertNotDestroyed(self.isDestroyed, self)

  -- foobar logic
end

return {
  new = new
}