improve doc

replit · Nov 15, 2023 · fef5ad9 · fef5ad9
1 parent 543c373
commit fef5ad9
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/src/types.ts b/src/types.ts
@@ -4249,7 +4249,17 @@ export interface Collision {
 
 export interface AreaCompOpt {
 	/**
-	 * The shape of the area.
+	 * The shape of the area (currently only Rect and Polygon is supported).
+	 *
+	 * @example
+	 * ```js
+	 * add([
+	 *     sprite("butterfly"),
+	 *     pos(100, 200),
+	 *     // a triangle shape!
+	 *     area({ shape: new Polygon([vec2(0), vec2(100), vec2(-100, 100)]) }),
+	 * ])
+	 * ```
 	 */
 	shape?: Shape,
 	/**