@quenty/baseobject 3.1.3-canary.c50dead.0 → 3.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +10 -2
  2. package/LICENSE.md +1 -1
  3. package/README.md +5 -3
  4. package/package.json +4 -4
  5. package/src/Shared/BaseObject.lua +13 -11
package/CHANGELOG.md CHANGED
@@ -3,12 +3,20 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
- ## [3.1.3-canary.c50dead.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/baseobject@3.1.2...@quenty/baseobject@3.1.3-canary.c50dead.0) (2021-11-20)
6
+ ## [3.2.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/baseobject@3.2.0...@quenty/baseobject@3.2.1) (2021-12-30)
7
+
8
+ **Note:** Version bump only for package @quenty/baseobject
9
+
10
+
11
+
12
+
13
+
14
+ # [3.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/baseobject@3.1.2...@quenty/baseobject@3.2.0) (2021-11-20)
7
15
 
8
16
 
9
17
  ### Bug Fixes
10
18
 
11
- * Support MacOS syncing ([c50dead](https://github.com/Quenty/NevermoreEngine/commit/c50deadbe5ebe479aded04e1619441a08ff0e9a8))
19
+ * Support MacOS syncing ([#225](https://github.com/Quenty/NevermoreEngine/issues/225)) ([03f9183](https://github.com/Quenty/NevermoreEngine/commit/03f918392c6a5bdd33f8a17c38de371d1e06c67a))
12
20
 
13
21
 
14
22
 
package/LICENSE.md CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2014 Quenty
3
+ Copyright (c) 2014-2021 Quenty
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -1,10 +1,10 @@
1
1
  ## BaseObject
2
2
  <div align="center">
3
- <a href="http://quenty.github.io/api/">
4
- <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
3
+ <a href="http://quenty.github.io/NevermoreEngine/">
4
+ <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
5
5
  </a>
6
6
  <a href="https://discord.gg/mhtGUS8">
7
- <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
7
+ <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
8
8
  </a>
9
9
  <a href="https://github.com/Quenty/NevermoreEngine/actions">
10
10
  <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
@@ -13,6 +13,8 @@
13
13
 
14
14
  BaseObject implementation with Maid attached. A BaseObject basically just adds the :Destroy() interface, and a private member `_maid`, along with an optional object it references.
15
15
 
16
+ <div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/BaseObject">View docs →</a></div>
17
+
16
18
  ## Installation
17
19
  ```
18
20
  npm install @quenty/baseobject --save
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quenty/baseobject",
3
- "version": "3.1.3-canary.c50dead.0",
3
+ "version": "3.2.1",
4
4
  "description": "BaseObject implementation with Maid attached for Roblox",
5
5
  "keywords": [
6
6
  "Roblox",
@@ -24,11 +24,11 @@
24
24
  "Quenty"
25
25
  ],
26
26
  "dependencies": {
27
- "@quenty/loader": "3.1.1",
28
- "@quenty/maid": "2.0.1"
27
+ "@quenty/loader": "^3.1.2",
28
+ "@quenty/maid": "^2.0.2"
29
29
  },
30
30
  "publishConfig": {
31
31
  "access": "public"
32
32
  },
33
- "gitHead": "c50deadbe5ebe479aded04e1619441a08ff0e9a8"
33
+ "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
34
34
  }
package/src/Shared/BaseObject.lua CHANGED
@@ -1,5 +1,7 @@
1
- --- A BaseObject basically just adds the :Destroy() interface, and a _maid, along with an optional object it references.
2
- -- @classmod BaseObject
1
+ --[=[
2
+ A BaseObject basically just adds the :Destroy() interface, and a _maid, along with an optional object it references.
3
+ @class BaseObject
4
+ ]=]
3
5
 
4
6
  local require = require(script.Parent.loader).load(script)
5
7
 
@@ -9,6 +11,12 @@ local BaseObject = {}
9
11
  BaseObject.ClassName = "BaseObject"
10
12
  BaseObject.__index = BaseObject
11
13
 
14
+ --[=[
15
+ Constructs a new BaseObject
16
+
17
+ @param obj? Instance
18
+ @return BaseObject
19
+ ]=]
12
20
  function BaseObject.new(obj)
13
21
  local self = setmetatable({}, BaseObject)
14
22
 
@@ -18,17 +26,11 @@ function BaseObject.new(obj)
18
26
  return self
19
27
  end
20
28
 
29
+ --[=[
30
+ Cleans up the BaseObject and sets the metatable to nil
31
+ ]=]
21
32
  function BaseObject:Destroy()
22
- -- local startTime = tick()
23
33
  self._maid:DoCleaning()
24
-
25
- -- This could emit events, which could cause bad startTime
26
- -- but we'll take this risk over getting the ClassName
27
- -- if tick() - startTime >= 0.01 then
28
- -- warn(("[BaseObject.Destroy] - Took %f ms to clean up %s")
29
- -- :format((tick() - startTime)*1000, tostring(self.ClassName)))
30
- -- end
31
-
32
34
  setmetatable(self, nil)
33
35
  end
34
36