@cybermp-community/client-types 2.3.6 → 2.4.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 (15) hide show
  1. package/LICENSE +14 -16
  2. package/{README.md.bak → README.md} +8 -3
  3. package/dist/bitfields.ts +179 -179
  4. package/dist/classes.d.ts +95907 -95898
  5. package/dist/enums.ts +13298 -13298
  6. package/dist/game.d.ts +391 -389
  7. package/dist/mp-classes.d.ts +4 -3
  8. package/dist/precomputed/cef.d.ts +4 -0
  9. package/dist/precomputed/{classes.d.ts → classes/extend.d.ts} +17 -27
  10. package/dist/precomputed/classes/index.d.ts +2 -0
  11. package/dist/precomputed/classes/screens.d.ts +37 -0
  12. package/dist/precomputed/events.d.ts +9 -7
  13. package/dist/precomputed/index.d.ts +1 -1
  14. package/dist/precomputed/mp.d.ts +1 -1
  15. package/package.json +14 -8
package/LICENSE CHANGED
@@ -1,21 +1,19 @@
1
- MIT License
1
+ Creative Commons Attribution-ShareAlike 4.0 International
2
2
 
3
3
  Copyright (c) 2026 CyberMP Community Developers
4
4
 
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
5
+ This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
6
+ International License. To view a copy of this license, visit
7
+ https://creativecommons.org/licenses/by-sa/4.0/ or send a letter to
8
+ Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
11
9
 
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
10
+ You are free to:
11
+ - Share: copy and redistribute the material in any medium or format
12
+ - Adapt: remix, transform, and build upon the material for any purpose,
13
+ even commercially
14
14
 
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
15
+ Under the following terms:
16
+ - Attribution: You must give appropriate credit, provide a link to the
17
+ license, and indicate if changes were made.
18
+ - ShareAlike: If you remix, transform, or build upon the material, you
19
+ must distribute your contributions under the same license as the original.
package/{README.md.bak → README.md} RENAMED
@@ -4,8 +4,13 @@ This repository contains the TypeScript type definitions for the **[CyberMP](htt
4
4
 
5
5
  These types cover the `mp` object, the game's internal classes, enums, and bitfields.
6
6
 
7
- ### ⌨️ Codeware Support
8
- This package includes built-in types for **[Codeware](https://github.com/psiberx/cp2077-codeware) v1.19.0**, allowing full type safety and IntelliSense for developer-facing Redscript classes and functions provided by Codeware.
7
+ ### 🖥️ Integrated Libraries (which supports CyberMP)
8
+ This package includes built-in types for the following essential modding libraries, providing full type safety and IntelliSense for their respective classes and functions:
9
+
10
+ - **Cyberpunk 2077 2.31**
11
+ - **[Codeware](https://github.com/psiberx/cp2077-codeware) v1.18.0**
12
+ - **[ArchiveXL](https://github.com/psiberx/cp2077-archive-xl) v1.26.0**
13
+ - **[TweakXL](https://github.com/psiberx/cp2077-tweak-xl) v1.11.0**
9
14
 
10
15
  ## 📦 Installation
11
16
 
@@ -33,4 +38,4 @@ This repository is developed by [CyberMP Community Developers](https://gitlab.co
33
38
 
34
39
  ## ⚖️ License
35
40
 
36
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
41
+ This project is licensed under the СС BY-SA 4.0 License - see the [LICENSE](LICENSE) file for details.
package/dist/bitfields.ts CHANGED
@@ -1,230 +1,230 @@
1
1
  // THIS CODE IS GENERATED, PLEASE DO NOT EDIT THIS
2
2
  export enum animMuteAnimEvents {
3
- "STANDARD" = 0,
4
- "FACE_ANIMS" = 1
3
+ STANDARD = 0,
4
+ FACE_ANIMS = 1
5
5
  }
6
6
  export enum CensorshipFlags {
7
- "Censor_Nudity" = 0,
8
- "Censor_OverSexualised" = 1,
9
- "Censor_Suggestive" = 2,
10
- "Censor_Homosexuality" = 3,
11
- "Censor_Gore" = 4,
12
- "Censor_Drugs" = 5,
13
- "Censor_Religion" = 6,
14
- "Censor_Chinese" = 7
7
+ Censor_Nudity = 0,
8
+ Censor_OverSexualised = 1,
9
+ Censor_Suggestive = 2,
10
+ Censor_Homosexuality = 3,
11
+ Censor_Gore = 4,
12
+ Censor_Drugs = 5,
13
+ Censor_Religion = 6,
14
+ Censor_Chinese = 7
15
15
  }
16
16
  export enum EMeshChunkFlags {
17
- "MCF_RenderInScene" = 0,
18
- "MCF_RenderInShadows" = 1,
19
- "MCF_IsTwoSided" = 2,
20
- "MCF_IsRayTracedEmissive" = 3,
21
- "MCF_IsPrefabProxy" = 6,
22
- "MCF_ConsoleLOD0" = 9,
23
- "MCF_SkipDynamicDecalGeneration" = 10
17
+ MCF_RenderInScene = 0,
18
+ MCF_RenderInShadows = 1,
19
+ MCF_IsTwoSided = 2,
20
+ MCF_IsRayTracedEmissive = 3,
21
+ MCF_IsPrefabProxy = 6,
22
+ MCF_ConsoleLOD0 = 9,
23
+ MCF_SkipDynamicDecalGeneration = 10
24
24
  }
25
25
  export enum EMeshChunkRenderMask {
26
- "MCR_Scene" = 0,
27
- "MCR_Cascade1" = 1,
28
- "MCR_Cascade2" = 2,
29
- "MCR_Cascade3" = 3,
30
- "MCR_Cascade4" = 4,
31
- "MCR_LocalShadows" = 5,
32
- "MCR_IsTwoSided" = 6,
33
- "MCR_DistantShadows" = 7,
34
- "MCR_IsRayTracedEmissive" = 8,
35
- "MCR_PrefabProxy" = 11,
36
- "MCR_Cascades" = 12
26
+ MCR_Scene = 0,
27
+ MCR_Cascade1 = 1,
28
+ MCR_Cascade2 = 2,
29
+ MCR_Cascade3 = 3,
30
+ MCR_Cascade4 = 4,
31
+ MCR_LocalShadows = 5,
32
+ MCR_IsTwoSided = 6,
33
+ MCR_DistantShadows = 7,
34
+ MCR_IsRayTracedEmissive = 8,
35
+ MCR_PrefabProxy = 11,
36
+ MCR_Cascades = 12
37
37
  }
38
38
  export enum entdismembermentGoreTypeE {
39
- "FLESH" = 2,
40
- "CYBER" = 3
39
+ FLESH = 2,
40
+ CYBER = 3
41
41
  }
42
42
  export enum entdismembermentPlacementE {
43
- "MAIN_MESH" = 4,
44
- "DISM_MESH" = 5,
45
- "RAGDOLL_CONTACT" = 8,
46
- "RAGDOLL_CONTACT_SLIDE" = 9,
47
- "RAGDOLL_SLEEP" = 10
43
+ MAIN_MESH = 4,
44
+ DISM_MESH = 5,
45
+ RAGDOLL_CONTACT = 8,
46
+ RAGDOLL_CONTACT_SLIDE = 9,
47
+ RAGDOLL_SLEEP = 10
48
48
  }
49
49
  export enum entdismembermentResourceSetMask {
50
- "BARE" = 0,
51
- "BARE1" = 1,
52
- "BARE2" = 2,
53
- "BARE3" = 3,
54
- "GARMENT" = 4,
55
- "GARMENT1" = 5,
56
- "GARMENT2" = 6,
57
- "GARMENT3" = 7,
58
- "CYBER" = 8,
59
- "CYBER1" = 9,
60
- "CYBER2" = 10,
61
- "CYBER3" = 11,
62
- "MIXED" = 12,
63
- "MIXED1" = 13,
64
- "MIXED2" = 14,
65
- "MIXED3" = 15
50
+ BARE = 0,
51
+ BARE1 = 1,
52
+ BARE2 = 2,
53
+ BARE3 = 3,
54
+ GARMENT = 4,
55
+ GARMENT1 = 5,
56
+ GARMENT2 = 6,
57
+ GARMENT3 = 7,
58
+ CYBER = 8,
59
+ CYBER1 = 9,
60
+ CYBER2 = 10,
61
+ CYBER3 = 11,
62
+ MIXED = 12,
63
+ MIXED1 = 13,
64
+ MIXED2 = 14,
65
+ MIXED3 = 15
66
66
  }
67
67
  export enum entdismembermentWoundTypeE {
68
- "CLEAN" = 0,
69
- "COARSE" = 1,
70
- "HOLE" = 6
68
+ CLEAN = 0,
69
+ COARSE = 1,
70
+ HOLE = 6
71
71
  }
72
72
  export enum ETextureChannel {
73
- "TextureChannel_R" = 0,
74
- "TextureChannel_G" = 1,
75
- "TextureChannel_B" = 2,
76
- "TextureChannel_A" = 3
73
+ TextureChannel_R = 0,
74
+ TextureChannel_G = 1,
75
+ TextureChannel_B = 2,
76
+ TextureChannel_A = 3
77
77
  }
78
78
  export enum gameEItemDynamicTags {
79
- "Quest" = 0,
80
- "UnequipBlocked" = 1,
81
- "DLCAdded" = 2,
82
- "TransmogBlocked" = 3
79
+ Quest = 0,
80
+ UnequipBlocked = 1,
81
+ DLCAdded = 2,
82
+ TransmogBlocked = 3
83
83
  }
84
84
  export enum gameLootSlotState {
85
- "Looted" = 0,
86
- "Unavailable" = 1
85
+ Looted = 0,
86
+ Unavailable = 1
87
87
  }
88
88
  export enum gametargetingSystemAimAssistFilter {
89
- "Melee" = 0,
90
- "Shooting" = 1,
91
- "Scanning" = 2,
92
- "QuickHack" = 3,
93
- "ShootingLimbCyber" = 4,
94
- "HeadTarget" = 5,
95
- "LegTarget" = 6,
96
- "MechanicalTarget" = 7,
97
- "DriverCombat" = 8,
98
- "BreachTarget" = 9
89
+ Melee = 0,
90
+ Shooting = 1,
91
+ Scanning = 2,
92
+ QuickHack = 3,
93
+ ShootingLimbCyber = 4,
94
+ HeadTarget = 5,
95
+ LegTarget = 6,
96
+ MechanicalTarget = 7,
97
+ DriverCombat = 8,
98
+ BreachTarget = 9
99
99
  }
100
100
  export enum gameuiContext {
101
- "Default" = 0,
102
- "QuickHack" = 1,
103
- "Scanning" = 2,
104
- "DeviceZoom" = 3,
105
- "BraindanceEditor" = 4,
106
- "BraindancePlayback" = 5,
107
- "VehicleMounted" = 6,
108
- "ModalPopup" = 7,
109
- "RadialWheel" = 8,
110
- "VehicleRace" = 9,
111
- "Berserk" = 10,
112
- "CinematicCamera" = 11,
113
- "Empty" = 12,
114
- "DelamainTaxi" = 13,
115
- "MAX" = 31
101
+ Default = 0,
102
+ QuickHack = 1,
103
+ Scanning = 2,
104
+ DeviceZoom = 3,
105
+ BraindanceEditor = 4,
106
+ BraindancePlayback = 5,
107
+ VehicleMounted = 6,
108
+ ModalPopup = 7,
109
+ RadialWheel = 8,
110
+ VehicleRace = 9,
111
+ Berserk = 10,
112
+ CinematicCamera = 11,
113
+ Empty = 12,
114
+ DelamainTaxi = 13,
115
+ MAX = 31
116
116
  }
117
117
  export enum gsmGameDefType {
118
- "BASE" = 0,
119
- "EP1" = 1,
120
- "OTHER" = 2
118
+ BASE = 0,
119
+ EP1 = 1,
120
+ OTHER = 2
121
121
  }
122
122
  export enum physicsDestructionType {
123
- "DT_PhysicalNode" = 0,
124
- "DT_PhysicalComponent" = 1,
125
- "DT_BakedNode" = 2,
126
- "DT_BakedComponent" = 3,
127
- "DT_IDN" = 4,
128
- "DT_FoliageDestruction" = 5,
129
- "DT_QuestComponent" = 6,
130
- "DT_QuestNode" = 7
123
+ DT_PhysicalNode = 0,
124
+ DT_PhysicalComponent = 1,
125
+ DT_BakedNode = 2,
126
+ DT_BakedComponent = 3,
127
+ DT_IDN = 4,
128
+ DT_FoliageDestruction = 5,
129
+ DT_QuestComponent = 6,
130
+ DT_QuestNode = 7
131
131
  }
132
132
  export enum physicsEClothCollisionMaskEnum {
133
- "SPHERE" = 0,
134
- "BOX" = 1,
135
- "CONVEX" = 2,
136
- "TRIMESH" = 3,
137
- "CAPSULE" = 4
133
+ SPHERE = 0,
134
+ BOX = 1,
135
+ CONVEX = 2,
136
+ TRIMESH = 3,
137
+ CAPSULE = 4
138
138
  }
139
139
  export enum physicsFractureFieldOptions {
140
- "FFO_OnlyPrefractured" = 0,
141
- "FFO_DisableReiteration" = 1
140
+ FFO_OnlyPrefractured = 0,
141
+ FFO_DisableReiteration = 1
142
142
  }
143
143
  export enum physicsFractureFieldType {
144
- "FF_Default" = 0,
145
- "FF_Locomotion" = 1,
146
- "FF_TriggerDestructionEvent" = 2,
147
- "FF_FractureFieldNode" = 3,
148
- "FF_FractureFieldGameEffect" = 4,
149
- "FF_FractureFieldComponent" = 5
144
+ FF_Default = 0,
145
+ FF_Locomotion = 1,
146
+ FF_TriggerDestructionEvent = 2,
147
+ FF_FractureFieldNode = 3,
148
+ FF_FractureFieldGameEffect = 4,
149
+ FF_FractureFieldComponent = 5
150
150
  }
151
151
  export enum physicsRagdollBodyPartE {
152
- "HEAD" = 0,
153
- "LARM_UPPER" = 1,
154
- "LARM_LOWER" = 2,
155
- "LARM_PALM" = 3,
156
- "RARM_UPPER" = 4,
157
- "RARM_LOWER" = 5,
158
- "RARM_PALM" = 6,
159
- "LLEG_UPPER" = 7,
160
- "LLEG_LOWER" = 8,
161
- "LLEG_FOOT" = 9,
162
- "RLEG_UPPER" = 10,
163
- "RLEG_LOWER" = 11,
164
- "RLEG_FOOT" = 12,
165
- "BODY" = 13
152
+ HEAD = 0,
153
+ LARM_UPPER = 1,
154
+ LARM_LOWER = 2,
155
+ LARM_PALM = 3,
156
+ RARM_UPPER = 4,
157
+ RARM_LOWER = 5,
158
+ RARM_PALM = 6,
159
+ LLEG_UPPER = 7,
160
+ LLEG_LOWER = 8,
161
+ LLEG_FOOT = 9,
162
+ RLEG_UPPER = 10,
163
+ RLEG_LOWER = 11,
164
+ RLEG_FOOT = 12,
165
+ BODY = 13
166
166
  }
167
167
  export enum RenderSceneLayerMask {
168
- "Default" = 0,
169
- "Cyberspace" = 1,
170
- "WorldMap" = 2
168
+ Default = 0,
169
+ Cyberspace = 1,
170
+ WorldMap = 2
171
171
  }
172
172
  export enum rendLightChannel {
173
- "LC_Channel1" = 0,
174
- "LC_Channel2" = 1,
175
- "LC_Channel3" = 2,
176
- "LC_Channel4" = 3,
177
- "LC_Channel5" = 4,
178
- "LC_Channel6" = 5,
179
- "LC_Channel7" = 6,
180
- "LC_Channel8" = 7,
181
- "LC_ChannelWorld" = 8,
182
- "LC_Character" = 9,
183
- "LC_Player" = 10,
184
- "LC_Automated" = 15
173
+ LC_Channel1 = 0,
174
+ LC_Channel2 = 1,
175
+ LC_Channel3 = 2,
176
+ LC_Channel4 = 3,
177
+ LC_Channel5 = 4,
178
+ LC_Channel6 = 5,
179
+ LC_Channel7 = 6,
180
+ LC_Channel8 = 7,
181
+ LC_ChannelWorld = 8,
182
+ LC_Character = 9,
183
+ LC_Player = 10,
184
+ LC_Automated = 15
185
185
  }
186
186
  export enum scnChoiceNodeNsChoiceNodeBitFlags {
187
- "IsFocusClue" = 0,
188
- "IsValidInteractionFailsafeDisabled" = 1
187
+ IsFocusClue = 0,
188
+ IsValidInteractionFailsafeDisabled = 1
189
189
  }
190
190
  export enum TriggerChannel {
191
- "TC_Default" = 0,
192
- "TC_Player" = 1,
193
- "TC_Camera" = 2,
194
- "TC_Human" = 3,
195
- "TC_SoundReverbArea" = 4,
196
- "TC_SoundAmbientArea" = 5,
197
- "TC_Quest" = 6,
198
- "TC_Projectiles" = 7,
199
- "TC_Vehicle" = 8,
200
- "TC_Environment" = 9,
201
- "TC_WaterNullArea" = 10,
202
- "TC_Custom0" = 16,
203
- "TC_Custom1" = 17,
204
- "TC_Custom2" = 18,
205
- "TC_Custom3" = 19,
206
- "TC_Custom4" = 20,
207
- "TC_Custom5" = 21,
208
- "TC_Custom6" = 22,
209
- "TC_Custom7" = 23,
210
- "TC_Custom8" = 24,
211
- "TC_Custom9" = 25,
212
- "TC_Custom10" = 26,
213
- "TC_Custom11" = 27,
214
- "TC_Custom12" = 28,
215
- "TC_Custom13" = 29,
216
- "TC_Custom14" = 30
191
+ TC_Default = 0,
192
+ TC_Player = 1,
193
+ TC_Camera = 2,
194
+ TC_Human = 3,
195
+ TC_SoundReverbArea = 4,
196
+ TC_SoundAmbientArea = 5,
197
+ TC_Quest = 6,
198
+ TC_Projectiles = 7,
199
+ TC_Vehicle = 8,
200
+ TC_Environment = 9,
201
+ TC_WaterNullArea = 10,
202
+ TC_Custom0 = 16,
203
+ TC_Custom1 = 17,
204
+ TC_Custom2 = 18,
205
+ TC_Custom3 = 19,
206
+ TC_Custom4 = 20,
207
+ TC_Custom5 = 21,
208
+ TC_Custom6 = 22,
209
+ TC_Custom7 = 23,
210
+ TC_Custom8 = 24,
211
+ TC_Custom9 = 25,
212
+ TC_Custom10 = 26,
213
+ TC_Custom11 = 27,
214
+ TC_Custom12 = 28,
215
+ TC_Custom13 = 29,
216
+ TC_Custom14 = 30
217
217
  }
218
218
  export enum workWorkspotItemPolicy {
219
- "ItemPolicy_SpawnItemOnIdleChange" = 0,
220
- "ItemPolicy_DespawnItemOnIdleChange" = 1,
221
- "ItemPolicy_DespawnItemOnReaction" = 2
219
+ ItemPolicy_SpawnItemOnIdleChange = 0,
220
+ ItemPolicy_DespawnItemOnIdleChange = 1,
221
+ ItemPolicy_DespawnItemOnReaction = 2
222
222
  }
223
223
  export enum worlduiContextVisibility {
224
- "SceneDefault" = 0,
225
- "SceneTier1" = 8,
226
- "SceneTier2" = 16,
227
- "SceneTier3" = 24,
228
- "SceneTier4" = 32,
229
- "SceneTier5" = 40
224
+ SceneDefault = 0,
225
+ SceneTier1 = 8,
226
+ SceneTier2 = 16,
227
+ SceneTier3 = 24,
228
+ SceneTier4 = 32,
229
+ SceneTier5 = 40
230
230
  }