@blorkfield/overlay-core 0.8.7 → 0.8.9

package/dist/index.d.cts

@@ -148,7 +148,7 @@ interface DespawnEffectConfig {
  * Unified configuration for spawning scene objects.
  * Objects are configured via tags that define their behavior:
  * - 'falling': Object is dynamic and affected by gravity (without this tag, object is static)
- * - 'follow': Object follows mouse position when grounded
+ * - 'follow_window': Object follows mouse position when grounded within the canvas window
  * - 'grabable': Object can be dragged via mouse constraint
  */
 interface ObjectConfig {
@@ -625,8 +625,8 @@ declare class OverlayScene {
      * Spawn an object synchronously.
      * Object behavior is determined by tags:
      * - 'falling': Object is dynamic (affected by gravity)
-     * - 'follow': Object follows mouse when grounded
-     * - 'grabable': Object can be dragged
+     * - 'follow_window': Object follows mouse when grounded (walks toward mouse)
+     * - 'grabable': Object can be grabbed and moved with mouse
      * Without 'falling' tag, object is static.
      */
     spawnObject(config: ObjectConfig): string;
@@ -1103,4 +1103,28 @@ declare class BackgroundManager {
     static clearCache(): void;
 }
 
-export { type BackgroundConfig, type BackgroundImageConfig, type BackgroundImageSizing, BackgroundManager, type BackgroundTransparencyConfig, type BaseEffectConfig, type Bounds, type BurstEffectConfig, type ClickToFallConfig, type ContainerOptions, type DespawnEffectConfig, type DynamicObject, type EffectConfig, type EffectObjectConfig, type EffectType, type FloorConfig, type FontInfo, type FontManifest, type GlyphData, type LifecycleCallback, type LifecycleEvent, type LoadedFont, type LogLevel, type ObjectConfig, type ObjectState, OverlayScene, type OverlaySceneConfig, type PressureThresholdConfig, type RainEffectConfig, type ShadowConfig, type ShapeConfig, type ShapePreset, type StreamEffectConfig, type TTFTextObstacleConfig, type TextAlign, type TextBounds, type TextObstacleConfig, type TextObstacleResult, type UpdateCallback, type UpdateCallbackData, type WeightConfig, clearFontCache, getGlyphData, getKerning, getLogLevel, loadFont, logger, measureText, setLogLevel };
+/**
+ * Tag constants for object behavior.
+ * Use these instead of magic strings.
+ */
+/** Object is dynamic and affected by gravity */
+declare const TAG_FALLING: "falling";
+/** Object follows mouse position when grounded (walks toward mouse) */
+declare const TAG_FOLLOW_WINDOW: "follow_window";
+/** Object can be grabbed and moved with mouse */
+declare const TAG_GRABABLE: "grabable";
+/**
+ * All available tags as a const object for destructuring.
+ * @example
+ * const { FALLING, GRABABLE } = TAGS;
+ * scene.spawnObject({ tags: [FALLING, GRABABLE], ... });
+ */
+declare const TAGS: {
+    readonly FALLING: "falling";
+    readonly FOLLOW_WINDOW: "follow_window";
+    readonly GRABABLE: "grabable";
+};
+/** Type for valid tag values */
+type Tag = typeof TAGS[keyof typeof TAGS];
+
+export { type BackgroundConfig, type BackgroundImageConfig, type BackgroundImageSizing, BackgroundManager, type BackgroundTransparencyConfig, type BaseEffectConfig, type Bounds, type BurstEffectConfig, type ClickToFallConfig, type ContainerOptions, type DespawnEffectConfig, type DynamicObject, type EffectConfig, type EffectObjectConfig, type EffectType, type FloorConfig, type FontInfo, type FontManifest, type GlyphData, type LifecycleCallback, type LifecycleEvent, type LoadedFont, type LogLevel, type ObjectConfig, type ObjectState, OverlayScene, type OverlaySceneConfig, type PressureThresholdConfig, type RainEffectConfig, type ShadowConfig, type ShapeConfig, type ShapePreset, type StreamEffectConfig, TAGS, TAG_FALLING, TAG_FOLLOW_WINDOW, TAG_GRABABLE, type TTFTextObstacleConfig, type Tag, type TextAlign, type TextBounds, type TextObstacleConfig, type TextObstacleResult, type UpdateCallback, type UpdateCallbackData, type WeightConfig, clearFontCache, getGlyphData, getKerning, getLogLevel, loadFont, logger, measureText, setLogLevel };

package/dist/index.d.ts

@@ -148,7 +148,7 @@ interface DespawnEffectConfig {
  * Unified configuration for spawning scene objects.
  * Objects are configured via tags that define their behavior:
  * - 'falling': Object is dynamic and affected by gravity (without this tag, object is static)
- * - 'follow': Object follows mouse position when grounded
+ * - 'follow_window': Object follows mouse position when grounded within the canvas window
  * - 'grabable': Object can be dragged via mouse constraint
  */
 interface ObjectConfig {
@@ -625,8 +625,8 @@ declare class OverlayScene {
      * Spawn an object synchronously.
      * Object behavior is determined by tags:
      * - 'falling': Object is dynamic (affected by gravity)
-     * - 'follow': Object follows mouse when grounded
-     * - 'grabable': Object can be dragged
+     * - 'follow_window': Object follows mouse when grounded (walks toward mouse)
+     * - 'grabable': Object can be grabbed and moved with mouse
      * Without 'falling' tag, object is static.
      */
     spawnObject(config: ObjectConfig): string;
@@ -1103,4 +1103,28 @@ declare class BackgroundManager {
     static clearCache(): void;
 }
 
-export { type BackgroundConfig, type BackgroundImageConfig, type BackgroundImageSizing, BackgroundManager, type BackgroundTransparencyConfig, type BaseEffectConfig, type Bounds, type BurstEffectConfig, type ClickToFallConfig, type ContainerOptions, type DespawnEffectConfig, type DynamicObject, type EffectConfig, type EffectObjectConfig, type EffectType, type FloorConfig, type FontInfo, type FontManifest, type GlyphData, type LifecycleCallback, type LifecycleEvent, type LoadedFont, type LogLevel, type ObjectConfig, type ObjectState, OverlayScene, type OverlaySceneConfig, type PressureThresholdConfig, type RainEffectConfig, type ShadowConfig, type ShapeConfig, type ShapePreset, type StreamEffectConfig, type TTFTextObstacleConfig, type TextAlign, type TextBounds, type TextObstacleConfig, type TextObstacleResult, type UpdateCallback, type UpdateCallbackData, type WeightConfig, clearFontCache, getGlyphData, getKerning, getLogLevel, loadFont, logger, measureText, setLogLevel };
+/**
+ * Tag constants for object behavior.
+ * Use these instead of magic strings.
+ */
+/** Object is dynamic and affected by gravity */
+declare const TAG_FALLING: "falling";
+/** Object follows mouse position when grounded (walks toward mouse) */
+declare const TAG_FOLLOW_WINDOW: "follow_window";
+/** Object can be grabbed and moved with mouse */
+declare const TAG_GRABABLE: "grabable";
+/**
+ * All available tags as a const object for destructuring.
+ * @example
+ * const { FALLING, GRABABLE } = TAGS;
+ * scene.spawnObject({ tags: [FALLING, GRABABLE], ... });
+ */
+declare const TAGS: {
+    readonly FALLING: "falling";
+    readonly FOLLOW_WINDOW: "follow_window";
+    readonly GRABABLE: "grabable";
+};
+/** Type for valid tag values */
+type Tag = typeof TAGS[keyof typeof TAGS];
+
+export { type BackgroundConfig, type BackgroundImageConfig, type BackgroundImageSizing, BackgroundManager, type BackgroundTransparencyConfig, type BaseEffectConfig, type Bounds, type BurstEffectConfig, type ClickToFallConfig, type ContainerOptions, type DespawnEffectConfig, type DynamicObject, type EffectConfig, type EffectObjectConfig, type EffectType, type FloorConfig, type FontInfo, type FontManifest, type GlyphData, type LifecycleCallback, type LifecycleEvent, type LoadedFont, type LogLevel, type ObjectConfig, type ObjectState, OverlayScene, type OverlaySceneConfig, type PressureThresholdConfig, type RainEffectConfig, type ShadowConfig, type ShapeConfig, type ShapePreset, type StreamEffectConfig, TAGS, TAG_FALLING, TAG_FOLLOW_WINDOW, TAG_GRABABLE, type TTFTextObstacleConfig, type Tag, type TextAlign, type TextBounds, type TextObstacleConfig, type TextObstacleResult, type UpdateCallback, type UpdateCallbackData, type WeightConfig, clearFontCache, getGlyphData, getKerning, getLogLevel, loadFont, logger, measureText, setLogLevel };

package/dist/index.js

@@ -1502,7 +1502,7 @@ var OverlayScene = class {
         const isDragging = this.grabbedObjectId === entry.id;
         if (!isDragging) {
           for (const tag of entry.tags) {
-            const key = tag === "follow" ? "mouse" : tag.startsWith("follow-") ? tag.slice(7) : null;
+            const key = tag === "follow_window" ? "mouse" : tag.startsWith("follow-") ? tag.slice(7) : null;
             if (key) {
               const target = this.followTargets.get(key);
               if (target) {
@@ -2037,8 +2037,8 @@ var OverlayScene = class {
    * Spawn an object synchronously.
    * Object behavior is determined by tags:
    * - 'falling': Object is dynamic (affected by gravity)
-   * - 'follow': Object follows mouse when grounded
-   * - 'grabable': Object can be dragged
+   * - 'follow_window': Object follows mouse when grounded (walks toward mouse)
+   * - 'grabable': Object can be grabbed and moved with mouse
    * Without 'falling' tag, object is static.
    */
   spawnObject(config) {
@@ -3349,9 +3349,23 @@ var OverlayScene = class {
     this.updateCallbacks.forEach((cb) => cb(data));
   }
 };
+
+// src/tags.ts
+var TAG_FALLING = "falling";
+var TAG_FOLLOW_WINDOW = "follow_window";
+var TAG_GRABABLE = "grabable";
+var TAGS = {
+  FALLING: TAG_FALLING,
+  FOLLOW_WINDOW: TAG_FOLLOW_WINDOW,
+  GRABABLE: TAG_GRABABLE
+};
 export {
   BackgroundManager,
   OverlayScene,
+  TAGS,
+  TAG_FALLING,
+  TAG_FOLLOW_WINDOW,
+  TAG_GRABABLE,
   clearFontCache,
   getGlyphData,
   getKerning,