bloxd.io.d.ts 1.0.2 → 1.2.0

package/api-type-def/normal/index.d.ts

@@ -1,8 +1,3 @@
-import GetPlayerIdsInterface from "./getPlayerIds";
-import PlayerIsInGameInterface from "./playerIsInGame";
-import PlayerIsLoggedInInterface from "./playerIsLoggedIn";
-import GetPlayerPartyWhenJoinedInterface from "./getPlayerPartyWhenJoined";
-import GetNumPlayersInterface from "./getNumPlayers";
 import GetUnitCoordinatesLifeformWithinInterface from "./getUnitCoordinatesLifeformWithin";
 import { ShopApis } from "./shops";
 import { ShieldApis } from "./shields";
@@ -10,19 +5,18 @@ import { PositionApis } from "./positions";
 import { StandingOnApis } from "./standingOns";
 import { HealthApis } from "./health";
 import { KillstreakApis } from "./killstreak";
+import { MessageApis } from "./message";
+import { PlayerApis } from "./player";
 import { MargeObject } from "../../type";
 
 type AllNormalApiIntersection = PositionApis &
-  GetPlayerIdsInterface &
-  PlayerIsInGameInterface &
-  PlayerIsLoggedInInterface &
-  GetPlayerPartyWhenJoinedInterface &
-  GetNumPlayersInterface &
+  PlayerApis &
   StandingOnApis &
   GetUnitCoordinatesLifeformWithinInterface &
   ShopApis &
   ShieldApis &
   HealthApis &
-  KillstreakApis;
+  KillstreakApis &
+  MessageApis;
 
 export type NormalApi = MargeObject<AllNormalApiIntersection>;

package/api-type-def/normal/message/broadcastMessage.d.ts

@@ -0,0 +1,18 @@
+import { CustomTextStyling } from "../../../type/message";
+
+interface BroadcastMessageInterface {
+  /**
+   * Send a message to everyone
+   *
+   * @param {string | CustomTextStyling} message - The text contained within the message. Can use `Custom Text Styling`.
+   * @param { { fontWeight?: number | string; color?: string } } [style] - An optional style argument. Can contain values for fontWeight and color of the message.
+   * style is ignored if message uses custom text styling (i.e. is not a string).
+   * @returns {void}
+   */
+  broadcastMessage(
+    message: string | CustomTextStyling,
+    style?: { fontWeight?: number | string; color?: string },
+  ): void;
+}
+
+export default BroadcastMessageInterface;

package/api-type-def/normal/message/index.d.ts

@@ -0,0 +1,6 @@
+import BroadcastMessageInterface from "./broadcastMessage";
+import SendMessageInterface from "./sendMessage";
+import SendFlyingMiddleMessage from "./sendFlyingMiddleMessage";
+export type MessageApis = BroadcastMessageInterface &
+  SendMessageInterface &
+  SendFlyingMiddleMessage;

package/api-type-def/normal/message/sendFlyingMiddleMessage.d.ts

@@ -0,0 +1,22 @@
+import { CustomTextStyling, PlayerId } from "../../../type";
+
+interface SendFlyingMiddleMessage {
+  /**
+   * Send a flying middle message to a specific player
+   *
+   * @param {PlayerId} playerId - Id of the player
+   * @param {string | CustomTextStyling} message - The text contained within the message. Can be either a string or use `Custom Text Styling`.
+   * @param {number} distanceFromAction - The distance from the action that has caused this message to be displayed,
+   * this value will be used to determine how the message flies across the screen.
+   * @param {number} [lifetimeMs] - How long the message will be visible in milliseconds. Defaults to 1000ms.
+   * @returns {void}
+   */
+  sendFlyingMiddleMessage(
+    playerId: PlayerId,
+    message: string | CustomTextStyling,
+    distanceFromAction?: number,
+    lifetimeMs?: number,
+  ): void;
+}
+
+export default SendFlyingMiddleMessage;

package/api-type-def/normal/message/sendMessage.d.ts

@@ -0,0 +1,28 @@
+import { PlayerId, CustomTextStyling } from "../../../type";
+
+interface SendMessageInterface {
+  /**
+   * Send a message to a specific player
+   *
+   * @param {PlayerId} playerId - Id of the player
+   * @param {string} message - The text contained within the message.
+   * @param { { fontWeight?: number | string; color?: string } } [style] - An optional style argument. Can contain values for fontWeight and color of the message.
+   * @returns {void}
+   */
+  sendMessage(
+    playerId: PlayerId,
+    message: string,
+    style: { fontWeight?: number | string; color?: string },
+  ): void;
+  /**
+   * Send a message to a specific player
+   *
+   * @param {PlayerId} playerId - Id of the player
+   * @param {CustomTextStyling} message - The text contained within the message.
+   *
+   * @returns {void}
+   */
+  sendMessage(playerId: PlayerId, message: CustomTextStyling): void;
+}
+
+export default SendMessageInterface;

package/api-type-def/normal/{getPlayerIds.d.ts → player/getPlayerIds.d.ts}

@@ -1,4 +1,4 @@
-import { PlayerId } from "../../type";
+import { PlayerId } from "../../..";
 
 interface GetPlayerIdsInterface {
   /**

package/api-type-def/normal/{getPlayerPartyWhenJoined.d.ts → player/getPlayerPartyWhenJoined.d.ts}

@@ -1,4 +1,4 @@
-import { Party, PlayerId } from "../../type";
+import { Party, PlayerId } from "../../..";
 
 interface GetPlayerPartyWhenJoinedInterface {
   /**

package/api-type-def/normal/player/index.d.ts

@@ -0,0 +1,10 @@
+import GetPlayerIdsInterface from "./getPlayerIds";
+import GetNumPlayersInterface from "./getNumPlayers";
+import GetPlayerPartyWhenJoinedInterface from "./getPlayerPartyWhenJoined";
+import PlayerIsInGameInterface from "./playerIsInGame";
+import PlayerIsLoggedInInterface from "./playerIsLoggedIn";
+export type PlayerApis = GetNumPlayersInterface &
+  GetPlayerIdsInterface &
+  GetPlayerPartyWhenJoinedInterface &
+  PlayerIsInGameInterface &
+  PlayerIsLoggedInInterface;

package/api-type-def/normal/{playerIsInGame.d.ts → player/playerIsInGame.d.ts}

@@ -1,4 +1,4 @@
-import { PlayerId } from "../../type";
+import { PlayerId } from "../../..";
 interface PlayerIsInGameInterface {
   /**
    * Whether a player is currently in the game

package/api-type-def/normal/{playerIsLoggedIn.d.ts → player/playerIsLoggedIn.d.ts}

@@ -1,4 +1,4 @@
-import { PlayerId } from "../../type";
+import { PlayerId } from "../../..";
 
 interface PlayerIsLoggedInInterface {
   /**

package/api-type-def/normal/shops/configureShopCategory.d.ts

@@ -0,0 +1,17 @@
+import { ShopCategoryConfig, ShopCategoryKey } from "../../../type";
+
+interface ConfigureShopCategory {
+  /**
+   * Set properties of a shop category.
+   *
+   * @param {ShopCategoryKey} categoryKey - The key of the category to configure
+   * @param {ShopCategoryConfig} config - Category configuration properties
+   * @returns {void}
+   */
+  configureShopCategory(
+    categoryKey: ShopCategoryKey,
+    config: ShopCategoryConfig,
+  ): void;
+}
+
+export default ConfigureShopCategory;

package/api-type-def/normal/shops/createShopItem.d.ts

@@ -0,0 +1,22 @@
+import { ShopCategoryKey, ShopItem, ShopItemKey } from "../../../type";
+
+interface CreateShopItemInterface {
+  /**
+   * Create a new shop item under the given category.
+   * Will create a new category if it does not exist.
+   * If the shop item already exists then it will be replaced.
+   * If any per-player overrides exist under the same categoryKey and itemKey then they will be deleted.
+   *
+   * @param {ShopCategoryKey} categoryKey - The key of the category to create the item in
+   * @param {ShopItemKey} itemKey - The unique key for the item
+   * @param {ShopItem} item - The shop item to create (will be mutated)
+   * @returns {void}
+   */
+  createShopItem(
+    categoryKey: ShopCategoryKey,
+    itemKey: ShopItemKey,
+    item: ShopItem,
+  ): void;
+}
+
+export default CreateShopItemInterface;

package/api-type-def/normal/shops/deleteShopItem.d.ts

@@ -0,0 +1,16 @@
+import { ShopCategoryKey, ShopItemKey } from "../../../type";
+
+interface DeleteShopItemInterface {
+  /**
+   * Delete an existing shop item.
+   * Throws an error if the item does not exist.
+   * Will also delete all per-player overrides for the shop item.
+   *
+   * @param {ShopCategoryKey} categoryKey - The key of the category containing the item
+   * @param {ShopItemKey} itemKey - The unique key for the item
+   * @returns {void}
+   */
+  deleteShopItem(categoryKey: ShopCategoryKey, itemKey: ShopItemKey): void;
+}
+
+export default DeleteShopItemInterface;

package/api-type-def/normal/shops/index.d.ts

@@ -1,3 +1,10 @@
 import ShowShopTutorialInterface from "./showShopTutorial";
-
-export type ShopApis = ShowShopTutorialInterface;
+import CreateShopItemInterface from "./createShopItem";
+import UpdateShopItemInterface from "./updateShopItem";
+import DeleteShopItemInterface from "./deleteShopItem";
+import ConfigureShopCategory from "./configureShopCategory";
+export type ShopApis = ShowShopTutorialInterface &
+  CreateShopItemInterface &
+  UpdateShopItemInterface &
+  DeleteShopItemInterface &
+  ConfigureShopCategory;

package/api-type-def/normal/shops/updateShopItem.d.ts

@@ -0,0 +1,21 @@
+import { ShopCategoryKey, ShopItem, ShopItemKey } from "../../../type";
+
+interface UpdateShopItemInterface {
+  /**
+   * Update selected properties of an existing shop item.
+   * For example, { canBuy: true } to allow players to purchase the item.
+   * Throws an error if the item does not exist.
+   *
+   * @param {ShopCategoryKey} categoryKey - The key of the category containing the item
+   * @param {ShopItemKey} itemKey - The unique key for the item
+   * @param {Partial<ShopItem>} changes - Partial shop item properties to update
+   * @returns {void}
+   */
+  updateShopItem(
+    categoryKey: ShopCategoryKey,
+    itemKey: ShopItemKey,
+    changes: Partial<ShopItem>,
+  ): void;
+}
+
+export default UpdateShopItemInterface;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bloxd.io.d.ts",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "description": "yo",
   "types": "bloxd-api.d.ts",
   "exports": {

package/type/color/StringColor.d.ts

@@ -0,0 +1,179 @@
+/**
+ * this type is color.
+ * allow all css color type.
+ * @example
+ * `#ff0000` | `rgb(255,0,0)` | `red` | `Red` | `#f00` | `rgba(255,0,0,1)` | `hsl(0,100%,50%)` | `hsla(0,100%,50%,1)` is all red
+ */
+export type StringColor =
+  // Hex colors
+  | `#${string}`
+  // RGB and RGBA
+  | `rgb(${string})`
+  | `rgba(${string})`
+  // HSL and HSLA
+  | `hsl(${string})`
+  | `hsla(${string})`
+  // HWB
+  | `hwb(${string})`
+  // LAB and LCH
+  | `lab(${string})`
+  | `lch(${string})`
+  // OKLAB and OKLCH
+  | `oklab(${string})`
+  | `oklch(${string})`
+  // color() function
+  | `color(${string})`
+  // Special values
+  | "currentColor"
+  | "transparent"
+  // CSS named colors (full list)
+  | "aliceblue"
+  | "antiquewhite"
+  | "aqua"
+  | "aquamarine"
+  | "azure"
+  | "beige"
+  | "bisque"
+  | "black"
+  | "blanchedalmond"
+  | "blue"
+  | "blueviolet"
+  | "brown"
+  | "burlywood"
+  | "cadetblue"
+  | "chartreuse"
+  | "chocolate"
+  | "coral"
+  | "cornflowerblue"
+  | "cornsilk"
+  | "crimson"
+  | "cyan"
+  | "darkblue"
+  | "darkcyan"
+  | "darkgoldenrod"
+  | "darkgray"
+  | "darkgreen"
+  | "darkgrey"
+  | "darkkhaki"
+  | "darkmagenta"
+  | "darkolivegreen"
+  | "darkorange"
+  | "darkorchid"
+  | "darkred"
+  | "darksalmon"
+  | "darkseagreen"
+  | "darkslateblue"
+  | "darkslategray"
+  | "darkslategrey"
+  | "darkturquoise"
+  | "darkviolet"
+  | "deeppink"
+  | "deepskyblue"
+  | "dimgray"
+  | "dimgrey"
+  | "dodgerblue"
+  | "firebrick"
+  | "floralwhite"
+  | "forestgreen"
+  | "fuchsia"
+  | "gainsboro"
+  | "ghostwhite"
+  | "gold"
+  | "goldenrod"
+  | "gray"
+  | "green"
+  | "greenyellow"
+  | "grey"
+  | "honeydew"
+  | "hotpink"
+  | "indianred"
+  | "indigo"
+  | "ivory"
+  | "khaki"
+  | "lavender"
+  | "lavenderblush"
+  | "lawngreen"
+  | "lemonchiffon"
+  | "lightblue"
+  | "lightcoral"
+  | "lightcyan"
+  | "lightgoldenrodyellow"
+  | "lightgray"
+  | "lightgreen"
+  | "lightgrey"
+  | "lightpink"
+  | "lightsalmon"
+  | "lightseagreen"
+  | "lightskyblue"
+  | "lightslategray"
+  | "lightslategrey"
+  | "lightsteelblue"
+  | "lightyellow"
+  | "lime"
+  | "limegreen"
+  | "linen"
+  | "magenta"
+  | "maroon"
+  | "mediumaquamarine"
+  | "mediumblue"
+  | "mediumorchid"
+  | "mediumpurple"
+  | "mediumseagreen"
+  | "mediumslateblue"
+  | "mediumspringgreen"
+  | "mediumturquoise"
+  | "mediumvioletred"
+  | "midnightblue"
+  | "mintcream"
+  | "mistyrose"
+  | "moccasin"
+  | "navajowhite"
+  | "navy"
+  | "oldlace"
+  | "olive"
+  | "olivedrab"
+  | "orange"
+  | "orangered"
+  | "orchid"
+  | "palegoldenrod"
+  | "palegreen"
+  | "paleturquoise"
+  | "palevioletred"
+  | "papayawhip"
+  | "peachpuff"
+  | "peru"
+  | "pink"
+  | "plum"
+  | "powderblue"
+  | "purple"
+  | "rebeccapurple"
+  | "red"
+  | "rosybrown"
+  | "royalblue"
+  | "saddlebrown"
+  | "salmon"
+  | "sandybrown"
+  | "seagreen"
+  | "seashell"
+  | "sienna"
+  | "silver"
+  | "skyblue"
+  | "slateblue"
+  | "slategray"
+  | "slategrey"
+  | "snow"
+  | "springgreen"
+  | "steelblue"
+  | "tan"
+  | "teal"
+  | "thistle"
+  | "tomato"
+  | "turquoise"
+  | "violet"
+  | "wheat"
+  | "white"
+  | "whitesmoke"
+  | "yellow"
+  | "yellowgreen"
+  // fallback allowance for any other valid CSS color syntaxes not listed above
+  | string;

package/type/color/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./Array255Color";
 export * from "./Array255ColorWithA";
+export * from "./StringColor";

package/type/index.d.ts

@@ -16,3 +16,5 @@ export * from "./WhoDidDamage";
 export * from "./WhoKilled";
 export * from "./utilType";
 export * from "./ApplyMeleeHitOverrides";
+export * from "./message";
+export * from "./shop";

package/type/message/CustomTextStyling.d.ts

@@ -0,0 +1,9 @@
+import { EntityName, StyledIcon, StyledText, TranslatedText } from ".";
+
+export type CustomTextStyling = (
+  | string
+  | EntityName
+  | TranslatedText
+  | StyledIcon
+  | StyledText
+)[];

package/type/message/EntityName.d.ts

@@ -0,0 +1,9 @@
+import { StringColor } from "..";
+
+export type EntityName = {
+  entityName: string;
+  style?: {
+    color?: StringColor;
+    colour?: StringColor;
+  };
+};

package/type/message/StyledIcon.d.ts

@@ -0,0 +1,11 @@
+import { StringColor } from "..";
+
+export type StyledIcon = {
+  icon: string;
+  style?: {
+    color?: StringColor;
+    colour?: StringColor;
+    fontSize?: string;
+    opacity?: number;
+  };
+};

package/type/message/StyledText.d.ts

@@ -0,0 +1,7 @@
+import { EntityName, TextStyle, TranslatedText } from ".";
+
+export type StyledText = {
+  str: string | EntityName | TranslatedText;
+  style?: TextStyle;
+  clickableUrl?: string;
+};

package/type/message/TextStyle.d.ts

@@ -0,0 +1,9 @@
+import { StringColor } from "../color";
+
+export type TextStyle = {
+  color?: StringColor;
+  colour?: StringColor;
+  fontSize?: string;
+  fontWeight?: number | string;
+  opacity?: number;
+};

package/type/message/TranslatedText.d.ts

@@ -0,0 +1,6 @@
+import { EntityName } from ".";
+
+export type TranslatedText = {
+  translationKey: string;
+  params?: Record<string, string | number | boolean | EntityName>;
+};

package/type/message/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./CustomTextStyling";
+export * from "./EntityName";
+export * from "./TranslatedText";
+export * from "./StyledIcon";
+export * from "./TextStyle";
+export * from "./StyledText";

package/type/shop/ShopCategoryConfig.d.ts

@@ -0,0 +1,10 @@
+import { CustomTextStyling } from "..";
+
+export type ShopCategoryConfig = Partial<{
+  autoSelectCategory: boolean;
+  customTitle: string; // Supports translation keys and ordinary text
+  redDot: boolean;
+  forceRemoveRedDot: boolean;
+  sortPriority: number;
+  description: string | CustomTextStyling;
+}>;

package/type/shop/ShopCategoryKey.d.ts

@@ -0,0 +1 @@
+export type ShopCategoryKey = string;

package/type/shop/ShopItem.d.ts

@@ -0,0 +1,23 @@
+import { ShopItemBadgeType, ShopItemUserInput } from ".";
+import { CustomTextStyling, StringColor } from "..";
+
+export type ShopItem = {
+  image: string;
+  cost?: number;
+  currency?: string;
+  amount?: number; // Display amount shown on the shop tile image (0 and 1 are not displayed)
+  imageColour?: StringColor;
+  canBuy?: boolean;
+  isSelected?: boolean;
+  buyButtonText?: string | CustomTextStyling;
+  customTitle?: string | CustomTextStyling;
+  description?: string | CustomTextStyling;
+  onBoughtMessage?: string | CustomTextStyling;
+  redDot?: boolean;
+  forceRemoveRedDot?: boolean;
+  badge?: { text: string | CustomTextStyling; type: ShopItemBadgeType };
+  userInput?: ShopItemUserInput;
+  sell?: boolean; // Optional, defaults to false. If true, the sign of "cost" is flipped. So a "cost" of -25 would give the player 25 currency AND be displayed as "25" (instead of -25)
+  sortPriority?: number; // Descending, bigger number means closer to the top
+  hidden?: boolean;
+};

package/type/shop/ShopItemBadgeType.d.ts

@@ -0,0 +1 @@
+export type ShopItemBadgeType = "new" | "lucky";

package/type/shop/ShopItemKey.d.ts

@@ -0,0 +1 @@
+export type ShopItemKey = string;

package/type/shop/ShopItemUserInput.d.ts

@@ -0,0 +1,18 @@
+import { PlayerId } from "..";
+
+export type ShopItemUserInput =
+  | {
+      type: "text";
+      placeholderText?: string;
+      wordCharsOnly?: boolean;
+      initialValue?: string;
+    } // wordCharsOnly defaults to false. If true, only allows \w character (alphanumeric and _). initialValue always takes precedence as the text input value when set.
+  | { type: "number"; placeholderText?: string; initialValue?: string }
+  | {
+      type: "dropdown";
+      dropdownOptions: readonly (string | { option: string; cost: number })[];
+      shouldResetSelectionOnOptionsChange?: boolean; // Defaults to false. If true, the selection will reset to the first option when dropdownOptions changes.
+      initialValue?: string;
+    }
+  | { type: "player"; excludedPlayers?: PlayerId[] } // Defaults to excluding the current player
+  | { type: "color"; initialValue?: string };

package/type/shop/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./ShopCategoryKey";
+export * from "./ShopItem";
+export * from "./ShopItemKey";
+export * from "./ShopItemUserInput";
+export * from "./ShopItemBadgeType";
+export * from "./ShopCategoryConfig";