@quenty/playerinputmode 4.3.0 → 4.3.1-canary.13f8c62.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.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,14 @@
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
+ ## [4.3.1-canary.13f8c62.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/playerinputmode@4.3.0...@quenty/playerinputmode@4.3.1-canary.13f8c62.0) (2023-12-22)
7
+
8
+ **Note:** Version bump only for package @quenty/playerinputmode
9
+
10
+
11
+
12
+
13
+
6
14
  # [4.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/playerinputmode@4.2.1...@quenty/playerinputmode@4.3.0) (2023-12-14)
7
15
 
8
16
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quenty/playerinputmode",
3
- "version": "4.3.0",
3
+ "version": "4.3.1-canary.13f8c62.0",
4
4
  "description": "Service that takes active input modes from the player and exposes it to every other player via the server.",
5
5
  "keywords": [
6
6
  "Roblox",
@@ -26,20 +26,20 @@
26
26
  "Quenty"
27
27
  ],
28
28
  "dependencies": {
29
- "@quenty/attributeutils": "^9.2.0",
30
- "@quenty/brio": "^9.2.0",
31
- "@quenty/inputmode": "^8.3.0",
32
- "@quenty/loader": "^7.1.0",
33
- "@quenty/maid": "^2.6.0",
34
- "@quenty/playerutils": "^3.3.0",
35
- "@quenty/promise": "^7.1.0",
36
- "@quenty/remoting": "^7.2.0",
37
- "@quenty/rx": "^8.2.0",
38
- "@quenty/servicebag": "^7.1.0",
39
- "@quenty/table": "^3.4.0"
29
+ "@quenty/attributeutils": "9.2.1-canary.13f8c62.0",
30
+ "@quenty/brio": "9.2.1-canary.13f8c62.0",
31
+ "@quenty/inputmode": "8.3.1-canary.13f8c62.0",
32
+ "@quenty/loader": "7.1.0",
33
+ "@quenty/maid": "2.6.0",
34
+ "@quenty/playerutils": "3.3.1-canary.13f8c62.0",
35
+ "@quenty/promise": "7.1.0",
36
+ "@quenty/remoting": "7.2.1-canary.13f8c62.0",
37
+ "@quenty/rx": "8.2.1-canary.13f8c62.0",
38
+ "@quenty/servicebag": "7.1.0",
39
+ "@quenty/table": "3.4.0"
40
40
  },
41
41
  "publishConfig": {
42
42
  "access": "public"
43
43
  },
44
- "gitHead": "2c2dbbc0cb2fbb46b4f3270c559c63890fe18b26"
44
+ "gitHead": "13f8c62d4d62675db0f7ebd42c32daf8e61bb904"
45
45
  }
@@ -1,4 +1,8 @@
1
1
  --[=[
2
+ Reports back the player input mode to the server which allows for displaying what
3
+ mode the uesr is using.
4
+
5
+ @client
2
6
  @class PlayerInputModeServiceClient
3
7
  ]=]
4
8
 
@@ -61,13 +65,27 @@ function PlayerInputModeServiceClient:Start()
61
65
  end)
62
66
  end
63
67
 
68
+ --[=[
69
+ Observes the player input mode type from the player
70
+
71
+ @param player Player
72
+ @return Observable<PlayerInputModeType>
73
+ ]=]
64
74
  function PlayerInputModeServiceClient:ObservePlayerInputType(player)
65
75
  assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
66
76
 
67
77
  return PlayerInputModeUtils.observePlayerInputModeType(player)
68
78
  end
69
79
 
80
+ --[=[
81
+ Gets the player input mode type from the player
82
+
83
+ @param player Player
84
+ @return PlayerInputModeType
85
+ ]=]
70
86
  function PlayerInputModeServiceClient:GetPlayerInputModeType(player)
87
+ assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
88
+
71
89
  return PlayerInputModeUtils.getPlayerInputModeType(player)
72
90
  end
73
91
 
@@ -1,4 +1,8 @@
1
1
  --[=[
2
+ Reports back the player input mode to the server which allows for displaying what
3
+ mode the uesr is using.
4
+
5
+ @server
2
6
  @class PlayerInputModeService
3
7
  ]=]
4
8
 
@@ -27,14 +31,37 @@ function PlayerInputModeService:Start()
27
31
  end))
28
32
  end
29
33
 
34
+ --[=[
35
+ Gets the player input mode type from the player
36
+
37
+ @param player Player
38
+ @return PlayerInputModeType
39
+ ]=]
30
40
  function PlayerInputModeService:GetPlayerInputModeType(player)
41
+ assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
42
+
31
43
  return PlayerInputModeUtils.getPlayerInputModeType(player)
32
44
  end
33
45
 
46
+ --[=[
47
+ Promises the player input mode type from the player
48
+
49
+ @param player Player
50
+ @param cancelToken CancelToken
51
+ @return Promise<PlayerInputModeType>
52
+ ]=]
34
53
  function PlayerInputModeService:PromisePlayerInputMode(player, cancelToken)
54
+ assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
55
+
35
56
  return PlayerInputModeUtils.promisePlayerInputMode(player, cancelToken)
36
57
  end
37
58
 
59
+ --[=[
60
+ Observes the player input mode type from the player
61
+
62
+ @param player Player
63
+ @return Observable<PlayerInputModeType>
64
+ ]=]
38
65
  function PlayerInputModeService:ObservePlayerInputType(player)
39
66
  assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
40
67