@gta5urban/types-server 2.1.9

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 The RAGE Multiplayer Community and its contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,114 @@
+Remember to 🌟 this GitHub if you 💖 it.
+
+> This package contains types definitions for RAGE:MP server-side module.
+
+### 📥 Installation
+
+#### `SERVER-SIDE`
+
+:fire: Use `github:ragempcommunity/ragemp-types#types-server` to latest build
+
+```bash
+# With npm
+npm i --save-dev @ragempcommunity/types-server
+
+# With yarn
+yarn add -D @ragempcommunity/types-server
+
+# With pnpm
+pnpm add -D @ragempcommunity/types-server
+```
+
+## 🤓 Usage
+
+> To make these types detectable, you need to add the `types` property below to `tsconfig.json` on each side of your project.
+
+```jsonc
+// e.g server-side
+{
+	"compilerOptions": {
+		"types": ["{RELATIVE_PATH_TO_NODE_MODULES}/@ragempcommunity/types-server"]
+	}
+}
+```
+
+### Full type-safe and auto-complete
+
+![](https://i.imgur.com/o2JB3Jx.gif)
+
+---
+
+### To extend a Mp object, there are 2 ways:
+
+1. By extending the prototype of the object:
+
+```ts
+mp.Player.prototype.myMethod = function myMethod() {
+	// my method logic
+};
+
+// Usage
+mp.events.add('playerReady', (player) => {
+	player.myProperty = 1;
+
+	player.myMethod();
+});
+```
+
+```ts
+// @types/index.d.ts
+declare global {
+	interface PlayerMp {
+		myProperty: number;
+
+		myMethod(): void;
+	}
+}
+
+export {};
+```
+
+2. By extending the object itself:
+
+```ts
+mp.events.add('playerReady', (player) => {
+	player.myProperty = 1;
+
+	player.myMethod = function myMethod() {
+		// my method logic
+	};
+});
+```
+
+```ts
+// @types/index.d.ts
+declare global {
+	interface PlayerMp {
+		myProperty: number;
+
+		myMethod(): void;
+	}
+}
+
+export {};
+```
+
+See: [RAGEMP Typescript Boilerplate](https://github.com/ragempcommunity/ragemp-typescript)
+
+## 👨‍💻 Contributing
+
+To contribute to this repository, feel free to create a new fork of the repository and submit a pull request.
+
+1. Fork / Clone and select the `main` branch.
+2. Create a new branch in your fork.
+3. Make your changes.
+4. Commit your changes and push them.
+5. Submit a Pull Request [here](https://github.com/ragempcommunity/ragemp-types/pulls)!
+
+## 🎉 Thanks
+
+-   [CocaColaBear](https://github.com/CocaColaBear/) - Creator of [types-ragemp-s](https://github.com/CocaColaBear/types-ragemp-s) & [types-ragemp-c](https://github.com/CocaColaBear/types-ragemp-c)
+
+## 📋 License
+
+This project is licensed under the MIT License — see the [LICENSE](LICENSE) file for details.

package/enums.d.ts

@@ -0,0 +1,140 @@
+declare namespace RageEnums {
+	const enum ClothesComponent {
+		HEAD = 0,
+		MASK = 1,
+		HAIR = 2,
+		TORSO = 3,
+		LEGS = 4,
+		BAGS = 5,
+		SHOES = 6,
+		ACCESSORIES_1 = 7,
+		ACCESSORIES_2 = 8,
+		BODY_ARMORS = 9,
+		DECALS = 10,
+		AUXILIARY = 11
+	}
+
+	const enum ColshapeType {
+		CIRCLE = 'circle',
+		CUBOID = 'cuboid',
+		POLYGON = 'polygon',
+		RECTANGLE = 'rectangle',
+		SPHERE = 'sphere',
+		TUBE = 'tube'
+	}
+
+	const enum EntityType {
+		BLIP = 'blip',
+		CHECKPOINT = 'checkpoint',
+		COLSHAPE = 'colshape',
+		DUMMY = 'dummy',
+		MARKER = 'marker',
+		OBJECT = 'object',
+		PICKUP = 'pickup',
+		PLAYER = 'player',
+		VEHICLE = 'vehicle',
+		PED = 'ped',
+		TEXT_LABEL = 'textlabel'
+	}
+
+	const enum HeadOverlay {
+		BLEMISHES = 0,
+		FACIAL_HAIR = 1,
+		EYEBROWS = 2,
+		AGEING = 3,
+		MAKEUP = 4,
+		BLUSH = 5,
+		COMPLEXION = 6,
+		SUN_DAMAGE = 7,
+		LIPSTICK = 8,
+		FRECKLES = 9,
+		CHEST_HAIR = 10,
+		BODY_BLEMISHES = 11,
+		ADD_BODY_BLEMISHES = 12
+	}
+
+	const enum Marker {
+		UPSIDE_DOWN_CONE = 0,
+		VERTICAL_CYLINDER = 1,
+		THICK_CHEVRON_UP = 2,
+		THIN_CHEVRON_UP = 3,
+		CHECKERED_FLAG_RECT = 4,
+		CHECKERED_FLAG_CIRCLE = 5,
+		VERTICAL_CIRCLE = 6,
+		PLANE_MODEL = 7,
+		LOST_MC_DARK = 8,
+		LOST_MC_LIGHT = 9,
+		NUMBER_0 = 10,
+		NUMBER_1 = 11,
+		NUMBER_2 = 12,
+		NUMBER_3 = 13,
+		NUMBER_4 = 14,
+		NUMBER_5 = 15,
+		NUMBER_6 = 16,
+		NUMBER_7 = 17,
+		NUMBER_8 = 18,
+		NUMBER_9 = 19,
+		CHEVRON_UP_1 = 20,
+		CHEVRON_UP_2 = 21,
+		CHEVRON_UP_3 = 22,
+		HORIZONTAL_CIRCLE_FLAT = 23,
+		REPLAY_ICON = 24,
+		HORIZONTAL_CIRCLE_SKINNY = 25,
+		HORIZONTAL_CIRCLE_ARROW = 26,
+		HORIZONTAL_SPLIT_ARROW_CIRCLE = 27,
+		DEBUG_SPHERE = 28,
+		DOLLAR_SIGN = 29,
+		HORIZONTAL_BARS = 30,
+		WOLF_HEAD = 31
+	}
+
+	const enum PlayerProp {
+		HELMET = 0,
+		GLASSES = 1,
+		EAR_ACCESSORY = 2
+	}
+
+	const enum VehicleNumberPlateType {
+		BLUE_WHITE = 0,
+		YELLOW_BLACK = 1,
+		YELLOW_BLUE = 2,
+		BLUE_WHITE2 = 3,
+		BLUE_WHITE3 = 4,
+		YANKTON = 5
+	}
+
+	const enum VehicleSeat {
+		DRIVER,
+		PASSENGER_1,
+		PASSENGER_2,
+		PASSENGER_3,
+		PASSENGER_4,
+		PASSENGER_5,
+		PASSENGER_6,
+		PASSENGER_7,
+		PASSENGER_8,
+		PASSENGER_9,
+		PASSENGER_10,
+		PASSENGER_11,
+		PASSENGER_12,
+		PASSENGER_13,
+		PASSENGER_14,
+		PASSENGER_15,
+		PASSENGER_16
+	}
+
+	const enum Weather {
+		BLIZZARD = 'BLIZZARD',
+		CLEAR = 'CLEAR',
+		CLEARING = 'CLEARING',
+		CLOUDS = 'CLOUDS',
+		EXTRA_SUNNY = 'EXTRASUNNY',
+		FOGGY = 'FOGGY',
+		OVERCAST = 'OVERCAST',
+		RAIN = 'RAIN',
+		SMOG = 'SMOG',
+		SNOW_LIGHT = 'SNOWLIGHT',
+		THUNDER = 'THUNDER',
+		XMAS = 'XMAS'
+	}
+}