|
| 1 | +# vec2 |
| 2 | + |
| 3 | +**Description:** |
| 4 | + |
| 5 | +A 2D vector utility class with arithmetic, geometric, and serialization helpers. |
| 6 | + |
| 7 | +## Methods |
| 8 | + |
| 9 | +### `new` |
| 10 | + |
| 11 | + |
| 12 | +Constructors & Utils |
| 13 | + |
| 14 | +Creates a new vec2 instance. |
| 15 | + |
| 16 | +**Parameters:** |
| 17 | +- `x` float |
| 18 | +- `y` float |
| 19 | + |
| 20 | + |
| 21 | +**Returns:** |
| 22 | +- `vec2` |
| 23 | + |
| 24 | +### `assert` |
| 25 | + |
| 26 | +Checks if the given argument is a valid vec2, raises on failure. |
| 27 | + |
| 28 | +**Parameters:** |
| 29 | +- `arg` any |
| 30 | + |
| 31 | + |
| 32 | +**Returns:** |
| 33 | +- `boolean` |
| 34 | + |
| 35 | +### `copy` |
| 36 | + |
| 37 | +Returns a copy of this vector. |
| 38 | + |
| 39 | +**Returns:** |
| 40 | +- `vec2` |
| 41 | + |
| 42 | +### `unpack` |
| 43 | + |
| 44 | +Unpacks the components of the vector. |
| 45 | + |
| 46 | +**Returns:** |
| 47 | +- `float` x, float y |
| 48 | + |
| 49 | +### `zero` |
| 50 | + |
| 51 | +Returns a zero vector (0, 0). |
| 52 | + |
| 53 | +**Returns:** |
| 54 | +- `vec2` |
| 55 | + |
| 56 | +### `is_zero` |
| 57 | + |
| 58 | +Returns true if all components are zero. |
| 59 | + |
| 60 | +**Returns:** |
| 61 | +- `boolean` |
| 62 | + |
| 63 | +### `__tostring` |
| 64 | + |
| 65 | +Returns the string representation of the vector |
| 66 | + |
| 67 | + |
| 68 | +### `__add` |
| 69 | + |
| 70 | + |
| 71 | +Arithmetic Metamethods |
| 72 | + |
| 73 | +Addition between vectors or vector + number. |
| 74 | + |
| 75 | +**Parameters:** |
| 76 | +- `b` number|vec2 |
| 77 | + |
| 78 | + |
| 79 | +**Returns:** |
| 80 | +- `vec2` |
| 81 | + |
| 82 | +### `__sub` |
| 83 | + |
| 84 | +Subtraction between vectors or vector - number. |
| 85 | + |
| 86 | +**Parameters:** |
| 87 | +- `b` number|vec2 |
| 88 | + |
| 89 | + |
| 90 | +**Returns:** |
| 91 | +- `vec2` |
| 92 | + |
| 93 | +### `__mul` |
| 94 | + |
| 95 | +Multiplication between vectors or vector * number. |
| 96 | + |
| 97 | +**Parameters:** |
| 98 | +- `b` number|vec2 |
| 99 | + |
| 100 | + |
| 101 | +**Returns:** |
| 102 | +- `vec2` |
| 103 | + |
| 104 | +### `__div` |
| 105 | + |
| 106 | +Division between vectors or vector / number. |
| 107 | + |
| 108 | +**Parameters:** |
| 109 | +- `b` number|vec2 |
| 110 | + |
| 111 | + |
| 112 | +**Returns:** |
| 113 | +- `vec2` |
| 114 | + |
| 115 | +### `__eq` |
| 116 | + |
| 117 | +Equality check between two vectors. |
| 118 | + |
| 119 | +**Parameters:** |
| 120 | +- `b` number|vec2 |
| 121 | + |
| 122 | + |
| 123 | +**Returns:** |
| 124 | +- `boolean` |
| 125 | + |
| 126 | +### `__lt` |
| 127 | + |
| 128 | +Less-than check between two vectors. |
| 129 | + |
| 130 | +**Parameters:** |
| 131 | +- `b` number|vec2 |
| 132 | + |
| 133 | + |
| 134 | +**Returns:** |
| 135 | +- `boolean` |
| 136 | + |
| 137 | +### `__le` |
| 138 | + |
| 139 | +Less-or-equal check between two vectors. |
| 140 | + |
| 141 | +**Parameters:** |
| 142 | +- `b` number|vec2 |
| 143 | + |
| 144 | + |
| 145 | +**Returns:** |
| 146 | +- `boolean` |
| 147 | + |
| 148 | +### `__unm` |
| 149 | + |
| 150 | +Unary negation (returns the inverse vector). |
| 151 | + |
| 152 | +**Returns:** |
| 153 | +- `vec2` |
| 154 | + |
| 155 | +### `length` |
| 156 | + |
| 157 | + |
| 158 | +Vector Operations |
| 159 | + |
| 160 | +Returns the magnitude (length) of the vector. |
| 161 | + |
| 162 | +**Returns:** |
| 163 | +- `number` |
| 164 | + |
| 165 | +### `distance` |
| 166 | + |
| 167 | +Returns the distance between this vector and another. |
| 168 | + |
| 169 | +**Parameters:** |
| 170 | +- `b` vec2 |
| 171 | + |
| 172 | + |
| 173 | +**Returns:** |
| 174 | +- `number` |
| 175 | + |
| 176 | +### `normalize` |
| 177 | + |
| 178 | +Returns a normalized version of the vector. |
| 179 | + |
| 180 | +**Returns:** |
| 181 | +- `vec2` |
| 182 | + |
| 183 | +### `cross_product` |
| 184 | + |
| 185 | +Cross product of this vector and another. |
| 186 | + |
| 187 | +**Returns:** |
| 188 | +- `number` |
| 189 | + |
| 190 | +### `dot_product` |
| 191 | + |
| 192 | +Dot product of this vector and another. |
| 193 | + |
| 194 | +**Returns:** |
| 195 | +- `number` |
| 196 | + |
| 197 | +### `lerp` |
| 198 | + |
| 199 | +Linearly interpolates between this vector and another. |
| 200 | + |
| 201 | +**Parameters:** |
| 202 | +- `b` vec2 |
| 203 | +- `dt` number Delta time |
| 204 | + |
| 205 | + |
| 206 | +**Returns:** |
| 207 | +- `vec2` |
| 208 | + |
| 209 | +### `inverse` |
| 210 | + |
| 211 | +Returns the inverse (negated) vector. |
| 212 | + |
| 213 | +**Returns:** |
| 214 | +- `vec2` |
| 215 | + |
| 216 | +### `perpendicular` |
| 217 | + |
| 218 | +Returns a vec2 perpendicular to this. |
| 219 | + |
| 220 | +**Returns:** |
| 221 | +- `vec2` |
| 222 | + |
| 223 | +### `angle` |
| 224 | + |
| 225 | +Returns the angle between the x and y components of the vector. |
| 226 | + |
| 227 | +**Returns:** |
| 228 | +- `number` |
| 229 | + |
| 230 | +### `rotate` |
| 231 | + |
| 232 | +Rotates the vector. |
| 233 | + |
| 234 | +**Parameters:** |
| 235 | +- `n` number |
| 236 | + |
| 237 | + |
| 238 | +**Returns:** |
| 239 | +- `vec2` |
| 240 | + |
| 241 | +### `trim` |
| 242 | + |
| 243 | +Trims the vector to a maximum length. |
| 244 | + |
| 245 | +**Parameters:** |
| 246 | +- `atLength` number |
| 247 | + |
| 248 | + |
| 249 | +**Returns:** |
| 250 | +- `vec2` |
| 251 | + |
| 252 | +### `to_polar` |
| 253 | + |
| 254 | + |
| 255 | +Conversions |
| 256 | + |
| 257 | +Returns the angle and radius of the vector. |
| 258 | + |
| 259 | +**Returns:** |
| 260 | +- `number` angle, number radius |
| 261 | + |
| 262 | +### `from_polar` |
| 263 | + |
| 264 | +Creates a new vec2 from angle and radius. |
| 265 | + |
| 266 | +**Parameters:** |
| 267 | +- `angle` number |
| 268 | +- `radius?` number |
| 269 | + |
| 270 | + |
| 271 | +**Returns:** |
| 272 | +- `vec2` |
| 273 | + |
| 274 | +### `serialize` |
| 275 | + |
| 276 | +Converts the vector into a plain table (for serialization). |
| 277 | + |
| 278 | +**Returns:** |
| 279 | +- `table` |
| 280 | + |
| 281 | +### `deserialize` |
| 282 | + |
| 283 | +Deserializes a table into a vec3 **(static method)**. |
| 284 | + |
| 285 | + |
0 commit comments