@quenty/clipcharacters 3.3.0 → 3.4.0-canary.241.a4e8214.0

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 (4) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +6 -17
  3. package/package.json +5 -5
  4. package/src/Shared/ClipCharacters.lua +16 -10
package/CHANGELOG.md CHANGED
@@ -3,6 +3,22 @@
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.4.0-canary.241.a4e8214.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clipcharacters@3.3.1...@quenty/clipcharacters@3.4.0-canary.241.a4e8214.0) (2022-01-03)
7
+
8
+ **Note:** Version bump only for package @quenty/clipcharacters
9
+
10
+
11
+
12
+
13
+
14
+ ## [3.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clipcharacters@3.3.0...@quenty/clipcharacters@3.3.1) (2021-12-30)
15
+
16
+ **Note:** Version bump only for package @quenty/clipcharacters
17
+
18
+
19
+
20
+
21
+
6
22
  # [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/clipcharacters@3.2.0...@quenty/clipcharacters@3.3.0) (2021-12-18)
7
23
 
8
24
  **Note:** Version bump only for package @quenty/clipcharacters
package/README.md CHANGED
@@ -1,10 +1,10 @@
1
1
  ## ClipCharacters
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,20 +13,9 @@
13
13
 
14
14
  Clip characters locally on the client of other clients so they don't interfer with physics.
15
15
 
16
+ <div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/ClipCharacters">View docs →</a></div>
17
+
16
18
  ## Installation
17
19
  ```
18
20
  npm install @quenty/clipcharacters --save
19
- ```
20
-
21
- ## Usage
22
- Usage is designed to be simple.
23
-
24
- ### `ClipCharacters.initServer()`
25
- Initialize on server
26
-
27
- ### `ClipCharacters.new()`
28
- Initialize clipping on the client. Returns a new inst
29
-
30
- ### `ClipCharacters:Destroy()`
31
- Stop clipping on client
32
-
21
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quenty/clipcharacters",
3
- "version": "3.3.0",
3
+ "version": "3.4.0-canary.241.a4e8214.0",
4
4
  "description": "Clip characters locally on the client of other clients so they don't interfer with physics.",
5
5
  "keywords": [
6
6
  "Roblox",
@@ -25,12 +25,12 @@
25
25
  "Quenty"
26
26
  ],
27
27
  "dependencies": {
28
- "@quenty/loader": "^3.1.1",
29
- "@quenty/maid": "^2.0.1",
30
- "@quenty/remoting": "^3.3.0"
28
+ "@quenty/loader": "3.2.0-canary.241.a4e8214.0",
29
+ "@quenty/maid": "2.0.2",
30
+ "@quenty/remoting": "3.4.0-canary.241.a4e8214.0"
31
31
  },
32
32
  "publishConfig": {
33
33
  "access": "public"
34
34
  },
35
- "gitHead": "6eb398e9fb81191f0815885f807ab0cb3bb9bad1"
35
+ "gitHead": "a4e821471f35998d63f38a4f4a578e07b4e79035"
36
36
  }
package/src/Shared/ClipCharacters.lua CHANGED
@@ -1,5 +1,7 @@
1
- --- Clip characters locally on the client of other clients so they don't interfer with physics.
2
- -- @classmod ClipCharacters
1
+ --[=[
2
+ Clip characters locally on the client of other clients so they don't interfer with physics.
3
+ @class ClipCharacters
4
+ ]=]
3
5
 
4
6
  local require = require(script.Parent.loader).load(script)
5
7
 
@@ -16,9 +18,10 @@ ClipCharacters.ClassName = "ClipCharacters"
16
18
  ClipCharacters.__index = ClipCharacters
17
19
  ClipCharacters.COLLISION_GROUP_NAME = "ClipCharacters"
18
20
 
19
- --- Initialize on server
20
- -- @constructor
21
- -- @treturn nil
21
+ --[=[
22
+ Initialize on server
23
+ @server
24
+ ]=]
22
25
  function ClipCharacters.initServer()
23
26
  local groupId = PhysicsService:CreateCollisionGroup(ClipCharacters.COLLISION_GROUP_NAME)
24
27
  PhysicsService:CollisionGroupSetCollidable(ClipCharacters.COLLISION_GROUP_NAME, "Default", false)
@@ -29,9 +32,11 @@ function ClipCharacters.initServer()
29
32
  end
30
33
  end
31
34
 
32
- --- Initialize clipping on the client. Returns a new inst
33
- -- @constructor
34
- -- @treturn ClipCharacters
35
+ --[=[
36
+ Initialize clipping on the client. Returns a new inst
37
+ @client
38
+ @return ClipCharacters
39
+ ]=]
35
40
  function ClipCharacters.new()
36
41
  local self = setmetatable({}, ClipCharacters)
37
42
 
@@ -123,8 +128,9 @@ function ClipCharacters:_bindUpdatesYielding()
123
128
  end))
124
129
  end
125
130
 
126
- --- Stop clipping on client
127
- -- @treturn nil
131
+ --[=[
132
+ Stop clipping on client
133
+ ]=]
128
134
  function ClipCharacters:Destroy()
129
135
  self._maid:DoCleaning()
130
136
  self._maid = nil