bloxd.io.d.ts 2.0.1 → 2.2.0

package/dist/api-type-def/normal/killstreak/clearKillstreak.d.ts

@@ -1,11 +1,9 @@
-import { PlayerId } from "../../../type/index";
-interface ClearKillstreakInterface {
-    /**
-     * Clears the player's current killstreak
-     *
-     * @param {PlayerId} playerId
-     * @returns {void}
-     */
-    clearKillstreak(playerId: PlayerId): void;
-}
-export default ClearKillstreakInterface;
+import { PlayerId } from "../../../type/index";
+/**
+ * Clears the player's current killstreak
+ *
+ * @param {PlayerId} playerId
+ * @returns {void}
+ */
+declare const clearKillstreak: (playerId: PlayerId) => void;
+export { clearKillstreak };

package/dist/api-type-def/normal/killstreak/getCurrentKillstreak.d.ts

@@ -1,11 +1,9 @@
-import { PlayerId } from "../../../type/index";
-interface GetCurrentKillsreakInterface {
-    /**
-     * Gets the player's current killstreak
-     *
-     * @param {PlayerId} playerId
-     * @returns {number}
-     */
-    getCurrentKillstreak(playerId: PlayerId): number;
-}
-export default GetCurrentKillsreakInterface;
+import { PlayerId } from "../../../type/index";
+/**
+ * Gets the player's current killstreak
+ *
+ * @param {PlayerId} playerId
+ * @returns {number}
+ */
+declare const getCurrentKillstreak: (playerId: PlayerId) => number;
+export { getCurrentKillstreak };

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

@@ -1,3 +1,4 @@
-import GetCurrentKillsreakInterface from "./getCurrentKillstreak";
-import ClearKillstreakInterface from "./clearKillstreak";
-export type KillstreakApis = GetCurrentKillsreakInterface & ClearKillstreakInterface;
+export declare const KillstreakApis: {
+    readonly getCurrentKillstreak: (playerId: import("../../..").PlayerId) => number;
+    readonly clearKillstreak: (playerId: import("../../..").PlayerId) => void;
+};

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

@@ -1,16 +1,14 @@
-import { CustomTextStyling } from "../../../type/index";
-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;
+import { CustomTextStyling } from "../../../type/index";
+/**
+ * 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}
+ */
+declare const broadcastMessage: (message: string | CustomTextStyling, style?: {
+    fontWeight?: number | string;
+    color?: string;
+}) => void;
+export { broadcastMessage };

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

@@ -1,4 +1,23 @@
-import BroadcastMessageInterface from "./broadcastMessage";
-import SendMessageInterface from "./sendMessage";
-import SendFlyingMiddleMessage from "./sendFlyingMiddleMessage";
-export type MessageApis = BroadcastMessageInterface & SendMessageInterface & SendFlyingMiddleMessage;
+export declare const MessageApis: {
+    broadcastMessage: (message: string | import("../../..").CustomTextStyling, style?: {
+        fontWeight?: number | string;
+        color?: string;
+    }) => void;
+    sendMessage: {
+        (playerId: import("../../..").PlayerId, message: string, style: {
+            fontWeight?: number | string;
+            color?: string;
+        }): void;
+        (playerId: import("../../..").PlayerId, message: import("../../..").CustomTextStyling): void;
+    };
+    sendFlyingMiddleMessage: (playerId: import("../../..").PlayerId, message: string | import("../../..").CustomTextStyling, distanceFromAction?: number, lifetimeMs?: number) => void;
+    sendTopRightHelper: (playerId: import("../../..").PlayerId, icon: string, text: string, opts: {
+        duration?: number;
+        width?: number;
+        height?: number;
+        color?: import("../../..").StringColor;
+        iconSizeMult?: number;
+        textAndIconColor?: string;
+        fontSize?: string;
+    }) => void;
+};

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

@@ -1,15 +1,13 @@
-import { CustomTextStyling, PlayerId } from "../../../type/index";
-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;
+import { CustomTextStyling, PlayerId } from "../../../type/index";
+/**
+ * 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}
+ */
+declare const sendFlyingMiddleMessage: (playerId: PlayerId, message: string | CustomTextStyling, distanceFromAction?: number, lifetimeMs?: number) => void;
+export { sendFlyingMiddleMessage };

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

@@ -1,25 +1,26 @@
-import { PlayerId, CustomTextStyling } from "../../../type/index";
-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;
+import { PlayerId, CustomTextStyling } from "../../../type/index";
+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;
+}
+declare const sendMessage: SendMessageInterface["sendMessage"];
+export { sendMessage };

package/dist/api-type-def/normal/message/sendTopRightHelper.d.ts

@@ -0,0 +1,31 @@
+import { PlayerId, StringColor } from "../../../type/index";
+/**
+ * @deprecated - prefer using other UI elements
+ * (this UI element hasn't been properly thought through in combination with other elements like killfeed, uirequests, etc)
+ *
+ * Send a player an icon in the top right corner
+ *
+ * @param {PlayerId} playerId
+ * @param {string} icon - Can be any icon from font-awesome.
+ * @param {string} text - The text to send.
+ * @param { {
+ *     duration?: number
+ *     width?: number
+ *     height?: number
+ *     color?: string
+ *     iconSizeMult?: number
+ *     textAndIconColor?: string
+ *     fontSize?: string
+ * } } opts - Can include keys duration, width, height, color, iconSizeMult.
+ * @returns {void}
+ */
+declare const sendTopRightHelper: (playerId: PlayerId, icon: string, text: string, opts: {
+    duration?: number;
+    width?: number;
+    height?: number;
+    color?: StringColor;
+    iconSizeMult?: number;
+    textAndIconColor?: string;
+    fontSize?: string;
+}) => void;
+export { sendTopRightHelper };

package/dist/api-type-def/normal/playParticleEffect.d.ts

@@ -0,0 +1,11 @@
+import { PlayerId, TempParticleSystemOpts } from "../../type/index";
+/**
+ * Play particle effect on all clients, or only on some clients if clientPredictedBy is specified
+ *
+ * @param {TempParticleSystemOpts | ParticlePresetOpts} opts
+ * @param {PlayerId} [clientPredictedBy] - Play only on clients where client with playerId clientPredictedBy
+ * is not invisible, transparent, or themselves
+ * @returns {void}
+ */
+declare const playParticleEffect: (opts: TempParticleSystemOpts, clientPredictedBy?: PlayerId) => void;
+export { playParticleEffect };

package/dist/api-type-def/normal/player/getNumPlayers.d.ts

@@ -1,10 +1,8 @@
-interface GetNumPlayersInterface {
-    /**
-     * Get the number of players in the room
-     *
-     * @description this return number is 1 - 40 int cuz one room max player number is 40
-     * @returns {number}
-     */
-    getNumPlayers(): number;
-}
-export default GetNumPlayersInterface;
+/**
+ * Get the number of players in the room
+ *
+ * @description this return number is 1 - 40 int cuz one room max player number is 40
+ * @returns {number}
+ */
+declare const getNumPlayers: () => number;
+export { getNumPlayers };

package/dist/api-type-def/normal/player/getPlayerDbId.d.ts

@@ -0,0 +1,9 @@
+import { PlayerDbId, PlayerId } from "../../../type/index";
+/**
+ * Given a player, get their permanent identifier that doesn't change when leaving and re-entering
+ *
+ * @param {PlayerId} playerId
+ * @returns {PlayerDbId}
+ */
+declare const getPlayerDbId: (playerId: PlayerId) => PlayerDbId;
+export { getPlayerDbId };

package/dist/api-type-def/normal/player/getPlayerId.d.ts

@@ -0,0 +1,9 @@
+import { PlayerId } from "../../../type/index";
+/**
+ * Given the name of a player, get their id
+ *
+ * @param {string} playerName
+ * @returns {null | PlayerId}
+ */
+declare const getPlayerId: (playerName: string) => null | PlayerId;
+export { getPlayerId };

package/dist/api-type-def/normal/player/getPlayerIdFromDbId.d.ts

@@ -0,0 +1,9 @@
+import { PlayerDbId, PlayerId } from "../../../type/index";
+/**
+ * Returns null if player not in lobby
+ *
+ * @param {PlayerDbId} dbId
+ * @returns {null | PlayerId}
+ */
+declare const getPlayerIdFromDbId: (dbId: PlayerDbId) => null | PlayerId;
+export { getPlayerIdFromDbId };

package/dist/api-type-def/normal/player/getPlayerIds.d.ts

@@ -1,10 +1,8 @@
-import { PlayerId } from "../../../type/index";
-interface GetPlayerIdsInterface {
-    /**
-     * Get all the player ids.
-     *
-     * @returns {PlayerId[]}
-     */
-    getPlayerIds(): PlayerId[];
-}
-export default GetPlayerIdsInterface;
+import { PlayerId } from "../../../type/index";
+/**
+ * Get all the player ids.
+ *
+ * @returns {PlayerId[]}
+ */
+declare const getPlayerIds: () => PlayerId[];
+export { getPlayerIds };

package/dist/api-type-def/normal/player/getPlayerPartyWhenJoined.d.ts

@@ -1,12 +1,10 @@
-import { Party, PlayerId } from "../../../type/index";
-interface GetPlayerPartyWhenJoinedInterface {
-    /**
-     * Returns the party that the player was in when they joined the game. The returned object contains the playerDbIds, as well
-     * as the playerIds if available, of the party leader and members.
-     *
-     * @param {PlayerId} playerId
-     * @returns {PNull<{ partyCode: string; playerDbIds: PlayerDbId[] }>}
-     */
-    getPlayerPartyWhenJoined(playerId: PlayerId): Party | null;
-}
-export default GetPlayerPartyWhenJoinedInterface;
+import { Party, PlayerId } from "../../../type/index";
+/**
+ * Returns the party that the player was in when they joined the game. The returned object contains the playerDbIds, as well
+ * as the playerIds if available, of the party leader and members.
+ *
+ * @param {PlayerId} playerId
+ * @returns {PNull<{ partyCode: string; playerDbIds: PlayerDbId[] }>}
+ */
+declare const getPlayerPartyWhenJoined: (playerId: PlayerId) => Party | null;
+export { getPlayerPartyWhenJoined };

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

@@ -1,6 +1,12 @@
-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;
+export declare const PlayerApis: {
+    getPlayerIds: () => import("../../..").PlayerId[];
+    getNumPlayers: () => number;
+    getPlayerPartyWhenJoined: (playerId: import("../../..").PlayerId) => import("../../..").Party | null;
+    playerIsInGame: (playerId: import("../../..").PlayerId) => boolean;
+    playerIsLoggedIn: (playerId: import("../../..").PlayerId) => boolean;
+    getPlayerId: (playerName: string) => null | import("../../..").PlayerId;
+    getPlayerDbId: (playerId: import("../../..").PlayerId) => import("../../..").PlayerDbId;
+    getPlayerIdFromDbId: (dbId: import("../../..").PlayerDbId) => null | import("../../..").PlayerId;
+    kickPlayer: (playerId: import("../../..").PlayerId, reason: string) => void;
+    isMobile: (playerId: import("../../..").PlayerId) => boolean;
+};

package/dist/api-type-def/normal/player/isMobile.d.ts

@@ -0,0 +1,9 @@
+import { PlayerId } from "../../../type/index";
+/**
+ * Whether the player is on a mobile device or a computer.
+ *
+ * @param {PlayerId} playerId
+ * @returns {boolean}
+ */
+declare const isMobile: (playerId: PlayerId) => boolean;
+export { isMobile };

package/dist/api-type-def/normal/player/kickPlayer.d.ts

@@ -0,0 +1,8 @@
+import { PlayerId } from "../../../type/index";
+/**
+ * @param {PlayerId} playerId
+ * @param {string} reason
+ * @returns {void}
+ */
+declare const kickPlayer: (playerId: PlayerId, reason: string) => void;
+export { kickPlayer };

package/dist/api-type-def/normal/player/playerIsInGame.d.ts

@@ -1,11 +1,9 @@
-import { PlayerId } from "../../../type/index";
-interface PlayerIsInGameInterface {
-    /**
-     * Whether a player is currently in the game
-     *
-     * @param {PlayerId} playerId
-     * @returns {boolean}
-     */
-    playerIsInGame(playerId: PlayerId): boolean;
-}
-export default PlayerIsInGameInterface;
+import { PlayerId } from "../../../type/index";
+/**
+ * Whether a player is currently in the game
+ *
+ * @param {PlayerId} playerId
+ * @returns {boolean}
+ */
+declare const playerIsInGame: (playerId: PlayerId) => boolean;
+export { playerIsInGame };

package/dist/api-type-def/normal/player/playerIsLoggedIn.d.ts

@@ -1,9 +1,7 @@
-import { PlayerId } from "../../../type/index";
-interface PlayerIsLoggedInInterface {
-    /**
-     * @param {PlayerId} playerId
-     * @returns {boolean}
-     */
-    playerIsLoggedIn(playerId: PlayerId): boolean;
-}
-export default PlayerIsLoggedInInterface;
+import { PlayerId } from "../../../type/index";
+/**
+ * @param {PlayerId} playerId
+ * @returns {boolean}
+ */
+declare const playerIsLoggedIn: (playerId: PlayerId) => boolean;
+export { playerIsLoggedIn };

package/dist/api-type-def/normal/positions/getPosition.d.ts

@@ -1,11 +1,9 @@
-import { Coordinate, EntityId } from "../../../type/index";
-interface GetPositionInterface {
-    /**
-     * Get position of a player / entity.
-     *
-     * @param {EntityId} entityId
-     * @returns {Coordinate}
-     */
-    getPosition(entityId: EntityId): Coordinate;
-}
-export default GetPositionInterface;
+import { Coordinate, EntityId } from "../../../type/index";
+/**
+ * Get position of a player / entity.
+ *
+ * @param {EntityId} entityId
+ * @returns {Coordinate}
+ */
+declare const getPosition: (entityId: EntityId) => Coordinate;
+export { getPosition };

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

@@ -1,3 +1,7 @@
-import GetPositionInterface from "./getPosition";
-import SetPositionInterface from "./setPosition";
-export type PositionApis = GetPositionInterface & SetPositionInterface;
+export declare const PositionApis: {
+    getPosition: (entityId: import("../../..").EntityId) => import("../../..").Coordinate;
+    setPosition: {
+        (entityId: import("../../..").EntityId, x: number, y: number, z: number): void;
+        (entityId: import("../../..").EntityId, position: Readonly<import("../../..").Coordinate>): void;
+    };
+};

package/dist/api-type-def/normal/positions/setPosition.d.ts

@@ -1,22 +1,23 @@
-import { Coordinate, EntityId } from "../../../type/index";
-interface SetPositionInterface {
-    /**
-     * Set position of a player / entity.
-     *
-     * @param {EntityId} entityId
-     * @param {number} x
-     * @param {number} y
-     * @param {number} z
-     * @returns {void}
-     */
-    setPosition(entityId: EntityId, x: number, y: number, z: number): void;
-    /**
-     * Set position of a player / entity.
-     *
-     * @param {EntityId} entityId
-     * @param {Coordinate} position
-     * @returns {void}
-     */
-    setPosition(entityId: EntityId, position: Readonly<Coordinate>): void;
-}
-export default SetPositionInterface;
+import { Coordinate, EntityId } from "../../../type/index";
+interface SetPositionInterface {
+    /**
+     * Set position of a player / entity.
+     *
+     * @param {EntityId} entityId
+     * @param {number} x
+     * @param {number} y
+     * @param {number} z
+     * @returns {void}
+     */
+    setPosition(entityId: EntityId, x: number, y: number, z: number): void;
+    /**
+     * Set position of a player / entity.
+     *
+     * @param {EntityId} entityId
+     * @param {Coordinate} position
+     * @returns {void}
+     */
+    setPosition(entityId: EntityId, position: Readonly<Coordinate>): void;
+}
+declare const setPosition: SetPositionInterface["setPosition"];
+export { setPosition };

package/dist/api-type-def/normal/shields/getShieldAmount.d.ts

@@ -1,13 +1,11 @@
-import { EntityId, ShieldAmount } from "../../../type/index";
-interface GetShieldAmountInterface {
-    /**
-     * Get the current shield of an entity.
-     *
-     * returns value is marking `ShiendAmount`.which is `number` alias
-     *
-     * @param {EntityId} entityId
-     * @returns {number}
-     */
-    getShieldAmount(entityId: EntityId): ShieldAmount;
-}
-export default GetShieldAmountInterface;
+import { EntityId, ShieldAmount } from "../../../type/index";
+/**
+ * Get the current shield of an entity.
+ *
+ * returns value is marking `ShiendAmount`.which is `number` alias
+ *
+ * @param {EntityId} entityId
+ * @returns {number}
+ */
+declare const getShieldAmount: (entityId: EntityId) => ShieldAmount;
+export { getShieldAmount };

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

@@ -1,4 +1,4 @@
-import GetShieldAmountInterface from "./getShieldAmount";
-import SetShieldAmountInterface from "./setShieldAmount";
-type ShieldApis = GetShieldAmountInterface & SetShieldAmountInterface;
-export { ShieldApis };
+export declare const ShieldApis: {
+    getShieldAmount: (entityId: import("../../..").EntityId) => import("../../..").ShieldAmount;
+    setShieldAmount: (lifeformId: import("../../..").LifeformId, newShieldAmount: import("../../..").ShieldAmount) => void;
+};

package/dist/api-type-def/normal/shields/setShieldAmount.d.ts

@@ -1,12 +1,10 @@
-import { LifeformId, ShieldAmount } from "../../../type/index";
-interface SetShieldAmountInterface {
-    /**
-     * Set the current shield of a lifeform.
-     *
-     * @param {LifeformId} lifeformId
-     * @param {number} newShieldAmount - on d.ts,this arg type is marking `ShieldAmount` which is `number` alias
-     * @returns {void}
-     */
-    setShieldAmount(lifeformId: LifeformId, newShieldAmount: ShieldAmount): void;
-}
-export default SetShieldAmountInterface;
+import { LifeformId, ShieldAmount } from "../../../type/index";
+/**
+ * Set the current shield of a lifeform.
+ *
+ * @param {LifeformId} lifeformId
+ * @param {number} newShieldAmount - on d.ts,this arg type is marking `ShieldAmount` which is `number` alias
+ * @returns {void}
+ */
+declare const setShieldAmount: (lifeformId: LifeformId, newShieldAmount: ShieldAmount) => void;
+export { setShieldAmount };

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

@@ -1,12 +1,10 @@
-import { ShopCategoryConfig, ShopCategoryKey } from "../../../type/index";
-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;
+import { ShopCategoryConfig, ShopCategoryKey } from "../../../type/index";
+/**
+ * Set properties of a shop category.
+ *
+ * @param {ShopCategoryKey} categoryKey - The key of the category to configure
+ * @param {ShopCategoryConfig} config - Category configuration properties
+ * @returns {void}
+ */
+declare const configureShopCategory: (categoryKey: ShopCategoryKey, config: ShopCategoryConfig) => void;
+export { configureShopCategory };

package/dist/api-type-def/normal/shops/configureShopCategoryForPlayer.d.ts

@@ -0,0 +1,11 @@
+import { PlayerId, ShopCategoryConfig, ShopCategoryKey } from "../../../type/index";
+/**
+ * Configure a shop category for a specific player.
+ *
+ * @param {PlayerId} playerId - The player to configure the category for
+ * @param {ShopCategoryKey} categoryKey - The key of the category to configure
+ * @param {ShopCategoryConfig} config - Category configuration properties
+ * @returns {void}
+ */
+declare const configureShopCategoryForPlayer: (playerId: PlayerId, categoryKey: ShopCategoryKey, config: ShopCategoryConfig) => void;
+export { configureShopCategoryForPlayer };