Skip to content

Commit 9c2ac90

Browse files
xesdoogxesdoog
committed
Merge branch 'main' of https://github.com/xesdoog/SmallBase 
2 parents a30743d + 7e5bc1c commit 9c2ac90

17 files changed

Lines changed: 2239 additions & 0 deletions

‎docs/modules/Color.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Color
2+
3+
**Description:** Class: Color
4+
5+
## Methods
6+
7+
### `__tostring`
8+
9+
10+
### `new`
11+
12+
Constructor
13+
14+
Returns a new `Color` instance.
15+
16+
**Parameters:**
17+
- `...` any
18+
19+
**Returns:**
20+
- `Color`
21+
22+
### `RegisterNamedColor`
23+
24+
Allows you to register new named colors in the Color class itself
25+
26+
that you can call later using `Color.new("your_custom_color_name")`
27+
28+
Example usage:
29+
30+
Color:RegisterNamedColor("Magenta", "#FF00FF")
31+
32+
You can then use it like so:
33+
34+
local r, g, b, a = Color.new("Magenta"):AsRGBA()
35+
36+
**Parameters:**
37+
- `name` string
38+
- `...` any
39+
40+
### `AsRGBA`
41+
42+
Returns a color in **RGBA** format.
43+
44+
45+
**Returns:**
46+
- `number` , number, number, number
47+
48+
### `AsFloat`
49+
50+
Returns a color in float format.
51+
52+
53+
### `AsU32`
54+
55+
Returns a uint32 color in **ABGR** format.
56+
57+
58+
**Returns:**
59+
- `number`
60+

‎docs/modules/Decorator.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Decorator
2+
3+
**Description:** Class: Decorator
4+
**Global Singleton.**
5+
- Custom decorator to mark entities owned by this script.
6+
7+
## Methods
8+
9+
### `IsEntityRegistered`
10+
11+
**Parameters:**
12+
- `entity` integer
13+
- `key` string
14+
15+
### `ExistsOn`
16+
17+
**Parameters:**
18+
- `entity` integer
19+
- `key` string
20+
- `expectedValue` any
21+
22+
### `RegisterEntity`
23+
24+
**Parameters:**
25+
- `entity` integer
26+
- `key` string
27+
- `value` any
28+
29+
### `RemoveEntity`
30+
31+
**Parameters:**
32+
- `entity` integer
33+
- `key` string
34+
35+
### `Validate`
36+
37+
only bool decorators for now
38+
39+
**Parameters:**
40+
- `entity` integer
41+
42+
### `DebugDump`
43+
44+
**Parameters:**
45+
- `entity` integer
46+

‎docs/modules/Entity.md‎

Lines changed: 206 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,206 @@
1+
# Entity
2+
3+
**Description:** Class: Entity
4+
Class representing a GTA V entity.
5+
6+
## Methods
7+
8+
### `__eq`
9+
10+
11+
### `new`
12+
13+
**Parameters:**
14+
- `handle` number
15+
16+
**Returns:**
17+
- `Entity` |nil
18+
19+
### `Create`
20+
21+
**Parameters:**
22+
- `modelHash` number
23+
- `entityType` eEntityTypes
24+
- `pos?` vec3
25+
- `heading?` number
26+
- `isNetwork?` boolean
27+
- `isScriptHostPed?` boolean
28+
29+
### `Exists`
30+
31+
32+
**Returns:**
33+
- `boolean`
34+
35+
### `GetHandle`
36+
37+
38+
**Returns:**
39+
- `number`
40+
41+
### `GetModelHash`
42+
43+
44+
**Returns:**
45+
- `number`
46+
47+
### `GetPos`
48+
49+
**Parameters:**
50+
- `bIsAlive?` boolean
51+
52+
**Returns:**
53+
- `vec3`
54+
55+
### `GetRot`
56+
57+
**Parameters:**
58+
- `rotationOrder?` integer
59+
60+
**Returns:**
61+
- `vec3`
62+
63+
### `GetForwardVector`
64+
65+
66+
**Returns:**
67+
- `vec3`
68+
69+
### `GetForwardX`
70+
71+
72+
**Returns:**
73+
- `number`
74+
75+
### `GetForwardY`
76+
77+
78+
**Returns:**
79+
- `number`
80+
81+
### `GetForwardZ`
82+
83+
84+
**Returns:**
85+
- `number`
86+
87+
### `GetMaxHealth`
88+
89+
90+
**Returns:**
91+
- `integer`
92+
93+
### `GetHealth`
94+
95+
96+
**Returns:**
97+
- `integer`
98+
99+
### `GetHeading`
100+
101+
**Parameters:**
102+
- `offset?` number
103+
104+
**Returns:**
105+
- `number`
106+
107+
### `GetSpeed`
108+
109+
110+
**Returns:**
111+
- `number`
112+
113+
### `GetVelocity`
114+
115+
116+
**Returns:**
117+
- `vec3`
118+
119+
### `GetHeightAboveGround`
120+
121+
122+
**Returns:**
123+
- `number`
124+
125+
### `GetOffsetInWorldCoords`
126+
127+
**Parameters:**
128+
- `offset_x` number
129+
- `offset_y` number
130+
- `offset_z` number
131+
132+
**Returns:**
133+
- `vec3`
134+
135+
### `GetOffsetGivenWorldCoords`
136+
137+
**Parameters:**
138+
- `offset_x` number
139+
- `offset_y` number
140+
- `offset_z` number
141+
142+
**Returns:**
143+
- `vec3`
144+
145+
### `GetBoneIndexByName`
146+
147+
**Parameters:**
148+
- `boneName` string
149+
150+
### `GetBonePosition`
151+
152+
**Parameters:**
153+
- `bone` string|number
154+
155+
### `GetBoneRotation`
156+
157+
**Parameters:**
158+
- `bone` string|number
159+
160+
### `GetWorldPositionOfBone`
161+
162+
**Parameters:**
163+
- `bone` string|number
164+
165+
### `SetCoords`
166+
167+
**Parameters:**
168+
- `coords` vec3
169+
- `xAxis?` boolean
170+
- `yAxis?` boolean
171+
- `zAxis?` boolean
172+
- `clearArea?` boolean
173+
174+
### `SetCoordsNoOffset`
175+
176+
**Parameters:**
177+
- `coords` vec3
178+
- `xAxis?` boolean
179+
- `yAxis?` boolean
180+
- `zAxis?` boolean
181+
182+
### `GetSpawnPosInFront`
183+
184+
Will be improved later.
185+
186+
187+
### `EnableCollision`
188+
189+
**Parameters:**
190+
- `keep_physics?` boolean
191+
192+
### `DisableCollision`
193+
194+
**Parameters:**
195+
- `keep_physics?` boolean
196+
197+
### `ToggleInvincibility`
198+
199+
**Parameters:**
200+
- `toggle` boolean
201+
202+
### `DrawBoundingBox`
203+
204+
**Parameters:**
205+
- `color` Color
206+

0 commit comments

Comments
 (0)