https://github.com/bytebit-org/roblox-destroyedinstancelogging
Just a simple set of functions for making consistent destroyed instance logs
https://github.com/bytebit-org/roblox-destroyedinstancelogging
game-development lua luau npm-package roblox roblox-ts
Last synced: 9 months ago
JSON representation
Just a simple set of functions for making consistent destroyed instance logs
- Host: GitHub
- URL: https://github.com/bytebit-org/roblox-destroyedinstancelogging
- Owner: Bytebit-Org
- License: mit
- Created: 2022-03-21T18:23:33.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-04-05T05:19:03.000Z (over 3 years ago)
- Last Synced: 2025-01-18T19:59:52.961Z (10 months ago)
- Topics: game-development, lua, luau, npm-package, roblox, roblox-ts
- Language: TypeScript
- Homepage:
- Size: 200 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://roblox-ts.com/) project as follows:
```
npm i @rbxts/destroyed-instance-logging
```
### Wally
[Wally](https://github.com/UpliftGames/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](https://github.com/Bytebit-Org/roblox-DestroyedInstanceLogging/releases) 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.](https://www.roblox.com/library/9164245379/Destroyed-Instance-Logging-Package)
## Documentation
Documentation can be found [here](https://github.com/Bytebit-Org/roblox-DestroyedInstanceLogging/tree/master/docs), is included in the TypeScript files directly, and was generated using [TypeDoc](https://typedoc.org/).
## 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.
roblox-ts example
```ts
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
}
}
```
Luau example
```lua
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
}
```