@workadventure/iframe-api-typings 1.9.3 → 1.10.0

package/Api/Events/ActionsMenuActionClickedEvent.d.ts

@@ -0,0 +1,13 @@
+import { z } from "zod";
+export declare const isActionsMenuActionClickedEvent: z.ZodObject<{
+    id: z.ZodNumber;
+    actionName: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: number;
+    actionName: string;
+}, {
+    id: number;
+    actionName: string;
+}>;
+export declare type ActionsMenuActionClickedEvent = z.infer<typeof isActionsMenuActionClickedEvent>;
+export declare type ActionsMenuActionClickedEventCallback = (event: ActionsMenuActionClickedEvent) => void;

package/Api/Events/AddActionsMenuKeyToRemotePlayerEvent.d.ts

@@ -0,0 +1,13 @@
+import { z } from "zod";
+export declare const isAddActionsMenuKeyToRemotePlayerEvent: z.ZodObject<{
+    id: z.ZodNumber;
+    actionKey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: number;
+    actionKey: string;
+}, {
+    id: number;
+    actionKey: string;
+}>;
+export declare type AddActionsMenuKeyToRemotePlayerEvent = z.infer<typeof isAddActionsMenuKeyToRemotePlayerEvent>;
+export declare type AddActionsMenuKeyToRemotePlayerEventCallback = (event: AddActionsMenuKeyToRemotePlayerEvent) => void;

package/Api/Events/ButtonClickedEvent.d.ts

@@ -0,0 +1,15 @@
+import { z } from "zod";
+export declare const isButtonClickedEvent: z.ZodObject<{
+    popupId: z.ZodNumber;
+    buttonId: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    popupId: number;
+    buttonId: number;
+}, {
+    popupId: number;
+    buttonId: number;
+}>;
+/**
+ * A message sent from the game to the iFrame when a user enters or leaves a zone marked with the "zone" property.
+ */
+export declare type ButtonClickedEvent = z.infer<typeof isButtonClickedEvent>;

package/Api/Events/CameraFollowPlayerEvent.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const isCameraFollowPlayerEvent: z.ZodObject<{
+    smooth: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    smooth: boolean;
+}, {
+    smooth: boolean;
+}>;
+/**
+ * A message sent from the iFrame to the game to make the camera follow player.
+ */
+export declare type CameraFollowPlayerEvent = z.infer<typeof isCameraFollowPlayerEvent>;

package/Api/Events/CameraSetEvent.d.ts

@@ -0,0 +1,27 @@
+import { z } from "zod";
+export declare const isCameraSetEvent: z.ZodObject<{
+    x: z.ZodNumber;
+    y: z.ZodNumber;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+    lock: z.ZodBoolean;
+    smooth: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    width?: number | undefined;
+    height?: number | undefined;
+    x: number;
+    y: number;
+    lock: boolean;
+    smooth: boolean;
+}, {
+    width?: number | undefined;
+    height?: number | undefined;
+    x: number;
+    y: number;
+    lock: boolean;
+    smooth: boolean;
+}>;
+/**
+ * A message sent from the iFrame to the game to change the camera position.
+ */
+export declare type CameraSetEvent = z.infer<typeof isCameraSetEvent>;

package/Api/Events/ChangeAreaEvent.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const isChangeZoneEvent: z.ZodObject<{
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+}, {
+    name: string;
+}>;
+/**
+ * A message sent from the game to the iFrame when a user enters or leaves a zone.
+ */
+export declare type ChangeAreaEvent = z.infer<typeof isChangeZoneEvent>;

package/Api/Events/ChangeLayerEvent.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const isChangeLayerEvent: z.ZodObject<{
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+}, {
+    name: string;
+}>;
+/**
+ * A message sent from the game to the iFrame when a user enters or leaves a layer.
+ */
+export declare type ChangeLayerEvent = z.infer<typeof isChangeLayerEvent>;

package/Api/Events/ChatEvent.d.ts

@@ -0,0 +1,15 @@
+import { z } from "zod";
+export declare const isChatEvent: z.ZodObject<{
+    message: z.ZodString;
+    author: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    author: string;
+}, {
+    message: string;
+    author: string;
+}>;
+/**
+ * A message sent from the iFrame to the game to add a message in the chat.
+ */
+export declare type ChatEvent = z.infer<typeof isChatEvent>;

package/Api/Events/ClosePopupEvent.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const isClosePopupEvent: z.ZodObject<{
+    popupId: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    popupId: number;
+}, {
+    popupId: number;
+}>;
+/**
+ * A message sent from the iFrame to the game to add a message in the chat.
+ */
+export declare type ClosePopupEvent = z.infer<typeof isClosePopupEvent>;

package/Api/Events/ColorEvent.d.ts

@@ -0,0 +1,18 @@
+import { z } from "zod";
+export declare const isColorEvent: z.ZodObject<{
+    red: z.ZodNumber;
+    green: z.ZodNumber;
+    blue: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    red: number;
+    green: number;
+    blue: number;
+}, {
+    red: number;
+    green: number;
+    blue: number;
+}>;
+/**
+ * A message sent from the iFrame to the game to dynamically set the outline of the player.
+ */
+export declare type ColorEvent = z.infer<typeof isColorEvent>;

package/Api/Events/EmbeddedWebsiteEvent.d.ts

@@ -0,0 +1,113 @@
+import { z } from "zod";
+export declare const isRectangle: z.ZodObject<{
+    x: z.ZodNumber;
+    y: z.ZodNumber;
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}, {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}>;
+export declare type Rectangle = z.infer<typeof isRectangle>;
+export declare const isEmbeddedWebsiteEvent: z.ZodObject<{
+    name: z.ZodString;
+    url: z.ZodOptional<z.ZodString>;
+    visible: z.ZodOptional<z.ZodBoolean>;
+    allowApi: z.ZodOptional<z.ZodBoolean>;
+    allow: z.ZodOptional<z.ZodString>;
+    x: z.ZodOptional<z.ZodNumber>;
+    y: z.ZodOptional<z.ZodNumber>;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+    origin: z.ZodOptional<z.ZodEnum<["player", "map"]>>;
+    scale: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    url?: string | undefined;
+    allowApi?: boolean | undefined;
+    x?: number | undefined;
+    y?: number | undefined;
+    width?: number | undefined;
+    height?: number | undefined;
+    visible?: boolean | undefined;
+    allow?: string | undefined;
+    origin?: "player" | "map" | undefined;
+    scale?: number | undefined;
+    name: string;
+}, {
+    url?: string | undefined;
+    allowApi?: boolean | undefined;
+    x?: number | undefined;
+    y?: number | undefined;
+    width?: number | undefined;
+    height?: number | undefined;
+    visible?: boolean | undefined;
+    allow?: string | undefined;
+    origin?: "player" | "map" | undefined;
+    scale?: number | undefined;
+    name: string;
+}>;
+/**
+ * A message sent from the iFrame to the game to modify an embedded website
+ */
+export declare type ModifyEmbeddedWebsiteEvent = z.infer<typeof isEmbeddedWebsiteEvent>;
+export declare const isCreateEmbeddedWebsiteEvent: z.ZodObject<{
+    name: z.ZodString;
+    url: z.ZodString;
+    position: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    }, {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    }>;
+    visible: z.ZodOptional<z.ZodBoolean>;
+    allowApi: z.ZodOptional<z.ZodBoolean>;
+    allow: z.ZodOptional<z.ZodString>;
+    origin: z.ZodOptional<z.ZodEnum<["player", "map"]>>;
+    scale: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    allowApi?: boolean | undefined;
+    visible?: boolean | undefined;
+    allow?: string | undefined;
+    origin?: "player" | "map" | undefined;
+    scale?: number | undefined;
+    name: string;
+    url: string;
+    position: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+}, {
+    allowApi?: boolean | undefined;
+    visible?: boolean | undefined;
+    allow?: string | undefined;
+    origin?: "player" | "map" | undefined;
+    scale?: number | undefined;
+    name: string;
+    url: string;
+    position: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+}>;
+export declare type CreateEmbeddedWebsiteEvent = z.infer<typeof isCreateEmbeddedWebsiteEvent>;

package/Api/Events/EnterLeaveEvent.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const isEnterLeaveEvent: z.ZodObject<{
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+}, {
+    name: string;
+}>;
+/**
+ * A message sent from the game to the iFrame when a user enters or leaves a zone marked with the "zone" property.
+ */
+export declare type EnterLeaveEvent = z.infer<typeof isEnterLeaveEvent>;

package/Api/Events/GameStateEvent.d.ts

@@ -0,0 +1,39 @@
+import { z } from "zod";
+export declare const isGameStateEvent: z.ZodObject<{
+    roomId: z.ZodString;
+    mapUrl: z.ZodString;
+    nickname: z.ZodString;
+    language: z.ZodOptional<z.ZodString>;
+    uuid: z.ZodOptional<z.ZodString>;
+    startLayerName: z.ZodOptional<z.ZodString>;
+    tags: z.ZodArray<z.ZodString, "many">;
+    variables: z.ZodUnknown;
+    playerVariables: z.ZodUnknown;
+    userRoomToken: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    language?: string | undefined;
+    uuid?: string | undefined;
+    startLayerName?: string | undefined;
+    variables?: unknown;
+    playerVariables?: unknown;
+    userRoomToken?: string | undefined;
+    roomId: string;
+    mapUrl: string;
+    nickname: string;
+    tags: string[];
+}, {
+    language?: string | undefined;
+    uuid?: string | undefined;
+    startLayerName?: string | undefined;
+    variables?: unknown;
+    playerVariables?: unknown;
+    userRoomToken?: string | undefined;
+    roomId: string;
+    mapUrl: string;
+    nickname: string;
+    tags: string[];
+}>;
+/**
+ * A message sent from the game to the iFrame when the gameState is received by the script
+ */
+export declare type GameStateEvent = z.infer<typeof isGameStateEvent>;

package/Api/Events/GoToPageEvent.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+export declare const isGoToPageEvent: z.ZodObject<{
+    url: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    url: string;
+}, {
+    url: string;
+}>;
+/**
+ * A message sent from the iFrame to the game to add a message in the chat.
+ */
+export declare type GoToPageEvent = z.infer<typeof isGoToPageEvent>;

package/Api/Events/HasPlayerMovedEvent.d.ts

@@ -0,0 +1,28 @@
+import { z } from "zod";
+export declare const isHasPlayerMovedEvent: z.ZodObject<{
+    direction: z.ZodEnum<["right", "left", "up", "down"]>;
+    moving: z.ZodBoolean;
+    x: z.ZodNumber;
+    y: z.ZodNumber;
+    oldX: z.ZodOptional<z.ZodNumber>;
+    oldY: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    oldX?: number | undefined;
+    oldY?: number | undefined;
+    direction: "right" | "left" | "up" | "down";
+    moving: boolean;
+    x: number;
+    y: number;
+}, {
+    oldX?: number | undefined;
+    oldY?: number | undefined;
+    direction: "right" | "left" | "up" | "down";
+    moving: boolean;
+    x: number;
+    y: number;
+}>;
+/**
+ * A message sent from the game to the iFrame to notify a movement from the current player.
+ */
+export declare type HasPlayerMovedEvent = z.infer<typeof isHasPlayerMovedEvent>;
+export declare type HasPlayerMovedEventCallback = (event: HasPlayerMovedEvent) => void;