bloxd.io.d.ts 2.0.1 → 2.2.0

package/dist/api-type-def/clientOption/clientOptions/canChange.d.ts

@@ -1,75 +1,75 @@
-import { PlayerId } from "../../../type/index";
-/**
- * Whether the player can change blocks
- * @type {boolean}
- * @default true
- */
-type ValueType = boolean;
-interface SetClientOption {
-    /**
-     * set status player who can changing block
-     *
-     * option docment:
-     * Whether the player can change blocks
-     *
-     * @overload
-     *
-     * @param {PlayerId} playerId
-     * @param {"canchange"} option
-     * @param {true} value
-     */
-    setClientOption(playerId: PlayerId, option: "canChange", value: true): void;
-    /**
-     * set status player who can not changing block
-     *
-     * option docment:
-     * Whether the player can change blocks
-     *
-     * @overload
-     *
-     * @param {PlayerId} playerId
-     * @param {"canchange"} option
-     * @param {false} value
-     * @returns {void}
-     */
-    setClientOption(playerId: PlayerId, option: "canChange", value: false): void;
-}
-interface GetClientOption {
-    /**
-     * get player can change block
-     *
-     * option docment:
-     * Whether the player can change blocks
-     *
-     * @overload
-     *
-     * @param {PlayerId} playerId
-     * @param {"canChange"} option
-     * @returns {boolean}
-     */
-    getClientOption(playerId: PlayerId, option: "canChange"): boolean;
-}
-interface SetClientOptionToDefault {
-    /**
-     * set canChange option to default
-     * canChange default is `true`
-     *
-     * option docment:
-     * Whether the player can change blocks
-     *
-     * @overload
-     *
-     * @param {PlayerId} playerId
-     * @param {"canChange"} option
-     * @returns {void}
-     */
-    setClientOptionToDefault(playerId: PlayerId, option: "canChange"): void;
-}
-type ExportTypes = {
-    SetClientOption: SetClientOption;
-    SetClientOptionToDefault: SetClientOptionToDefault;
-    GetClientOption: GetClientOption;
-    name: "canChange";
-    ValueType: ValueType;
-};
-export default ExportTypes;
+import { PlayerId } from "../../../type/index";
+/**
+ * Whether the player can change blocks
+ * @type {boolean}
+ * @default true
+ */
+type ValueType = boolean;
+interface SetClientOption {
+    /**
+     * set status player who can changing block
+     *
+     * option docment:
+     * Whether the player can change blocks
+     *
+     * @overload
+     *
+     * @param {PlayerId} playerId
+     * @param {"canchange"} option
+     * @param {true} value
+     */
+    setClientOption(playerId: PlayerId, option: "canChange", value: true): void;
+    /**
+     * set status player who can not changing block
+     *
+     * option docment:
+     * Whether the player can change blocks
+     *
+     * @overload
+     *
+     * @param {PlayerId} playerId
+     * @param {"canchange"} option
+     * @param {false} value
+     * @returns {void}
+     */
+    setClientOption(playerId: PlayerId, option: "canChange", value: false): void;
+}
+interface GetClientOption {
+    /**
+     * get player can change block
+     *
+     * option docment:
+     * Whether the player can change blocks
+     *
+     * @overload
+     *
+     * @param {PlayerId} playerId
+     * @param {"canChange"} option
+     * @returns {boolean}
+     */
+    getClientOption(playerId: PlayerId, option: "canChange"): boolean;
+}
+interface SetClientOptionToDefault {
+    /**
+     * set canChange option to default
+     * canChange default is `true`
+     *
+     * option docment:
+     * Whether the player can change blocks
+     *
+     * @overload
+     *
+     * @param {PlayerId} playerId
+     * @param {"canChange"} option
+     * @returns {void}
+     */
+    setClientOptionToDefault(playerId: PlayerId, option: "canChange"): void;
+}
+type ExportTypes = {
+    SetClientOption: SetClientOption;
+    SetClientOptionToDefault: SetClientOptionToDefault;
+    GetClientOption: GetClientOption;
+    name: "canChange";
+    ValueType: ValueType;
+};
+export default ExportTypes;

package/dist/api-type-def/clientOption/clientOptions/crouchingSpeed.d.ts

@@ -1,46 +1,46 @@
-import { PlayerId } from "../../../type/index";
-/**
- * Speed multiplier for the player when crouching.
- * Players are used to the default bloxd movement behaviour and speed,
- * and may be put off from your game if different muscle memory is required.
- * We suggest applying speed or slowness effects instead, using api.applyEffect.
- * @type {number}
- * @default 2
- */
-type ValueType = number;
-interface SetClientOption {
-    /**
-     *
-     * @param {PlayerId} playerId
-     * @param {"crouchingSpeed"} option
-     * @param {number} value
-     * @returns {void}
-     */
-    setClientOption(playerId: PlayerId, option: "crouchingSpeed", value: number): void;
-}
-interface GetClientOption {
-    /**
-     *
-     * @param {PlayerId} playerId
-     * @param {"crouchingSpeed"} option
-     * @returns {number}
-     */
-    getClientOption(playerId: PlayerId, option: "crouchingSpeed"): number;
-}
-interface SetClientOptionToDefault {
-    /**
-     *
-     * @param {PlayerId} playerId
-     * @param {"crouchingSpeed"} option
-     * @returns {void}
-     */
-    setClientOptionToDefault(playerId: PlayerId, option: "crouchingSpeed"): void;
-}
-type ExportTypes = {
-    SetClientOption: SetClientOption;
-    SetClientOptionToDefault: SetClientOptionToDefault;
-    GetClientOption: GetClientOption;
-    name: "crouchingSpeed";
-    ValueType: ValueType;
-};
-export default ExportTypes;
+import { PlayerId } from "../../../type/index";
+/**
+ * Speed multiplier for the player when crouching.
+ * Players are used to the default bloxd movement behaviour and speed,
+ * and may be put off from your game if different muscle memory is required.
+ * We suggest applying speed or slowness effects instead, using api.applyEffect.
+ * @type {number}
+ * @default 2
+ */
+type ValueType = number;
+interface SetClientOption {
+    /**
+     *
+     * @param {PlayerId} playerId
+     * @param {"crouchingSpeed"} option
+     * @param {number} value
+     * @returns {void}
+     */
+    setClientOption(playerId: PlayerId, option: "crouchingSpeed", value: number): void;
+}
+interface GetClientOption {
+    /**
+     *
+     * @param {PlayerId} playerId
+     * @param {"crouchingSpeed"} option
+     * @returns {number}
+     */
+    getClientOption(playerId: PlayerId, option: "crouchingSpeed"): number;
+}
+interface SetClientOptionToDefault {
+    /**
+     *
+     * @param {PlayerId} playerId
+     * @param {"crouchingSpeed"} option
+     * @returns {void}
+     */
+    setClientOptionToDefault(playerId: PlayerId, option: "crouchingSpeed"): void;
+}
+type ExportTypes = {
+    SetClientOption: SetClientOption;
+    SetClientOptionToDefault: SetClientOptionToDefault;
+    GetClientOption: GetClientOption;
+    name: "crouchingSpeed";
+    ValueType: ValueType;
+};
+export default ExportTypes;

package/dist/api-type-def/clientOption/clientOptions/index.d.ts

@@ -1,34 +1,34 @@
-import { MargeObject } from "../../../type/index";
-import canChange from "./canChange";
-import crouchingSpeed from "./crouchingSpeed";
-import walkingSpeed from "./walkingSpeed";
-import runningSpeed from "./runningSpeed";
-import speedMultiplier from "./speedMultiplier";
-type ClientOptionExportFormat = {
-    name: string;
-    ValueType: any;
-    SetClientOption: {
-        setClientOption: (playerId: never, option: never, value: never) => void;
-    };
-    SetClientOptionToDefault: {
-        setClientOptionToDefault: (playerId: never, option: never) => void;
-    };
-    GetClientOption: {
-        getClientOption: (playerId: never, option: never) => any;
-    };
-};
-type AllClientOptionUnion = canChange | crouchingSpeed | walkingSpeed | runningSpeed | speedMultiplier;
-type GenerateClientOptions<U extends ClientOptionExportFormat> = {
-    [K in U as K["name"]]: K["ValueType"];
-};
-export type ClientOptions = GenerateClientOptions<AllClientOptionUnion>;
-type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
-type GenerateClientOptionInterface<U extends ClientOptionExportFormat, K extends keyof any> = MargeObject<UnionToIntersection<U extends any ? (K extends keyof U ? U[K] : never) : never>>;
-export type SetClientOption = GenerateClientOptionInterface<AllClientOptionUnion, "SetClientOption">;
-export type GetClientOption = GenerateClientOptionInterface<AllClientOptionUnion, "GetClientOption">;
-export type SetClientOptionToDefault = GenerateClientOptionInterface<AllClientOptionUnion, "SetClientOptionToDefault">;
-export * from "./canChange";
-export * from "./speedMultiplier";
-export * from "./crouchingSpeed";
-export * from "./walkingSpeed";
-export * from "./runningSpeed";
+import { MargeObject } from "../../../type/index";
+import canChange from "./canChange";
+import crouchingSpeed from "./crouchingSpeed";
+import walkingSpeed from "./walkingSpeed";
+import runningSpeed from "./runningSpeed";
+import speedMultiplier from "./speedMultiplier";
+type ClientOptionExportFormat = {
+    name: string;
+    ValueType: any;
+    SetClientOption: {
+        setClientOption: (playerId: never, option: never, value: never) => void;
+    };
+    SetClientOptionToDefault: {
+        setClientOptionToDefault: (playerId: never, option: never) => void;
+    };
+    GetClientOption: {
+        getClientOption: (playerId: never, option: never) => any;
+    };
+};
+type AllClientOptionUnion = canChange | crouchingSpeed | walkingSpeed | runningSpeed | speedMultiplier;
+type GenerateClientOptions<U extends ClientOptionExportFormat> = {
+    [K in U as K["name"]]: K["ValueType"];
+};
+export type ClientOptions = GenerateClientOptions<AllClientOptionUnion>;
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+type GenerateClientOptionInterface<U extends ClientOptionExportFormat, K extends keyof any> = MargeObject<UnionToIntersection<U extends any ? (K extends keyof U ? U[K] : never) : never>>;
+export type SetClientOption = GenerateClientOptionInterface<AllClientOptionUnion, "SetClientOption">;
+export type GetClientOption = GenerateClientOptionInterface<AllClientOptionUnion, "GetClientOption">;
+export type SetClientOptionToDefault = GenerateClientOptionInterface<AllClientOptionUnion, "SetClientOptionToDefault">;
+export * from "./canChange";
+export * from "./speedMultiplier";
+export * from "./crouchingSpeed";
+export * from "./walkingSpeed";
+export * from "./runningSpeed";

package/dist/api-type-def/clientOption/clientOptions/runningSpeed.d.ts

@@ -1,51 +1,51 @@
-import { PlayerId } from "../../../type/index";
-/**
- * Running speed for the player.
- * STRONGLY recommend using `speedMultiplier` unless you have a specific use case for this, runningSpeed doesn't make UX sense on mobile.
- * (Walking speed is ignored for mobile players, mobile player speed is determined by joystick input and the max of runningSpeed & walkingSpeed).
- *
- * Players are used to the default bloxd movement behaviour and speed,
- * and may be put off from your game if different muscle memory is required.
- * We suggest applying speed or slowness effects instead, using api.applyEffect.
- *
- * The only use case for walkingSpeed/runningSpeed over speedMultiplier or speed effects is to disable running or to inverse walking/running (so you run by default and e.g. hold shift to go slower).
- * @type {number}
- * @default 7
- */
-type ValueType = number;
-interface SetClientOption {
-    /**
-     *
-     * @param {PlayerId} playerId
-     * @param {"runningSpeed"} option
-     * @param {number} value
-     * @returns {void}
-     */
-    setClientOption(playerId: PlayerId, option: "runningSpeed", value: number): void;
-}
-interface GetClientOption {
-    /**
-     *
-     * @param {PlayerId} playerId
-     * @param {"runningSpeed"} option
-     * @returns {number}
-     */
-    getClientOption(playerId: PlayerId, option: "runningSpeed"): number;
-}
-interface SetClientOptionToDefault {
-    /**
-     *
-     * @param {PlayerId} playerId
-     * @param {"runningSpeed"} option
-     * @returns {void}
-     */
-    setClientOptionToDefault(playerId: PlayerId, option: "runningSpeed"): void;
-}
-type ExportTypes = {
-    SetClientOption: SetClientOption;
-    SetClientOptionToDefault: SetClientOptionToDefault;
-    GetClientOption: GetClientOption;
-    name: "runningSpeed";
-    ValueType: ValueType;
-};
-export default ExportTypes;
+import { PlayerId } from "../../../type/index";
+/**
+ * Running speed for the player.
+ * STRONGLY recommend using `speedMultiplier` unless you have a specific use case for this, runningSpeed doesn't make UX sense on mobile.
+ * (Walking speed is ignored for mobile players, mobile player speed is determined by joystick input and the max of runningSpeed & walkingSpeed).
+ *
+ * Players are used to the default bloxd movement behaviour and speed,
+ * and may be put off from your game if different muscle memory is required.
+ * We suggest applying speed or slowness effects instead, using api.applyEffect.
+ *
+ * The only use case for walkingSpeed/runningSpeed over speedMultiplier or speed effects is to disable running or to inverse walking/running (so you run by default and e.g. hold shift to go slower).
+ * @type {number}
+ * @default 7
+ */
+type ValueType = number;
+interface SetClientOption {
+    /**
+     *
+     * @param {PlayerId} playerId
+     * @param {"runningSpeed"} option
+     * @param {number} value
+     * @returns {void}
+     */
+    setClientOption(playerId: PlayerId, option: "runningSpeed", value: number): void;
+}
+interface GetClientOption {
+    /**
+     *
+     * @param {PlayerId} playerId
+     * @param {"runningSpeed"} option
+     * @returns {number}
+     */
+    getClientOption(playerId: PlayerId, option: "runningSpeed"): number;
+}
+interface SetClientOptionToDefault {
+    /**
+     *
+     * @param {PlayerId} playerId
+     * @param {"runningSpeed"} option
+     * @returns {void}
+     */
+    setClientOptionToDefault(playerId: PlayerId, option: "runningSpeed"): void;
+}
+type ExportTypes = {
+    SetClientOption: SetClientOption;
+    SetClientOptionToDefault: SetClientOptionToDefault;
+    GetClientOption: GetClientOption;
+    name: "runningSpeed";
+    ValueType: ValueType;
+};
+export default ExportTypes;

package/dist/api-type-def/clientOption/clientOptions/speedMultiplier.d.ts

@@ -1,53 +1,53 @@
-import { PlayerId } from "../../../type/index";
-/**
- * Speed multiplier for the player.
- * Players are used to the default bloxd movement behaviour and speed,
- * and may be put off from your game if different muscle memory is required.
- * We suggest applying speed or slowness effects instead, using api.applyEffect.
- *
- * @type {number}
- * @default 1
- */
-type ValueType = number;
-interface SetClientOption {
-    /**
-     *
-     * @overload
-     *
-     * @param {PlayerId} playerId
-     * @param {"speedMultiplier"} option
-     * @param {number} value
-     * @returns {void}
-     */
-    setClientOption(playerId: PlayerId, option: "speedMultiplier", value: number): void;
-}
-interface GetClientOption {
-    /**
-     *
-     * @overload
-     *
-     * @param {PlayerId} playerId
-     * @param {"speedMultiplier"} option
-     * @returns {number}
-     */
-    getClientOption(playerId: PlayerId, option: "speedMultiplier"): number;
-}
-interface SetClientOptionToDefault {
-    /**
-     *
-     * @overload
-     *
-     * @param {PlayerId} playerId
-     * @param {"speedMultiplier"} option
-     * @returns {void}
-     */
-    setClientOptionToDefault(playerId: PlayerId, option: "speedMultiplier"): void;
-}
-type ExportTypes = {
-    SetClientOption: SetClientOption;
-    SetClientOptionToDefault: SetClientOptionToDefault;
-    GetClientOption: GetClientOption;
-    name: "speedMultiplier";
-    ValueType: ValueType;
-};
-export default ExportTypes;
+import { PlayerId } from "../../../type/index";
+/**
+ * Speed multiplier for the player.
+ * Players are used to the default bloxd movement behaviour and speed,
+ * and may be put off from your game if different muscle memory is required.
+ * We suggest applying speed or slowness effects instead, using api.applyEffect.
+ *
+ * @type {number}
+ * @default 1
+ */
+type ValueType = number;
+interface SetClientOption {
+    /**
+     *
+     * @overload
+     *
+     * @param {PlayerId} playerId
+     * @param {"speedMultiplier"} option
+     * @param {number} value
+     * @returns {void}
+     */
+    setClientOption(playerId: PlayerId, option: "speedMultiplier", value: number): void;
+}
+interface GetClientOption {
+    /**
+     *
+     * @overload
+     *
+     * @param {PlayerId} playerId
+     * @param {"speedMultiplier"} option
+     * @returns {number}
+     */
+    getClientOption(playerId: PlayerId, option: "speedMultiplier"): number;
+}
+interface SetClientOptionToDefault {
+    /**
+     *
+     * @overload
+     *
+     * @param {PlayerId} playerId
+     * @param {"speedMultiplier"} option
+     * @returns {void}
+     */
+    setClientOptionToDefault(playerId: PlayerId, option: "speedMultiplier"): void;
+}
+type ExportTypes = {
+    SetClientOption: SetClientOption;
+    SetClientOptionToDefault: SetClientOptionToDefault;
+    GetClientOption: GetClientOption;
+    name: "speedMultiplier";
+    ValueType: ValueType;
+};
+export default ExportTypes;

package/dist/api-type-def/clientOption/clientOptions/walkingSpeed.d.ts

@@ -1,51 +1,51 @@
-import { PlayerId } from "../../../type/index";
-/**
- * Walking speed for the player.
- * STRONGLY recommend using `speedMultiplier` unless you have a specific use case for this, walkingSpeed doesn't make UX sense on mobile.
- * (Walking speed ignored for mobile players, mobile player speed is determined by joystick input and the max of runningSpeed & walkingSpeed).
- *
- * Players are used to the default bloxd movement behaviour and speed,
- * and may be put off from your game if different muscle memory is required.
- * We suggest applying speed or slowness effects instead, using api.applyEffect.
- *
- * The only use case for walkingSpeed/runningSpeed over speedMultiplier or speed effects is to disable running or to inverse walking/running (so you run by default and e.g. hold shift to go slower).
- * @type {number}
- * @default 4
- */
-type ValueType = number;
-interface SetClientOption {
-    /**
-     *
-     * @param {PlayerId} playerId
-     * @param {"walkingSpeed"} option
-     * @param {number} value
-     * @returns {void}
-     */
-    setClientOption(playerId: PlayerId, option: "walkingSpeed", value: number): void;
-}
-interface GetClientOption {
-    /**
-     *
-     * @param {PlayerId} playerId
-     * @param {"walkingSpeed"} option
-     * @returns {number}
-     */
-    getClientOption(playerId: PlayerId, option: "walkingSpeed"): number;
-}
-interface SetClientOptionToDefault {
-    /**
-     *
-     * @param {PlayerId} playerId
-     * @param {"walkingSpeed"} option
-     * @returns {void}
-     */
-    setClientOptionToDefault(playerId: PlayerId, option: "walkingSpeed"): void;
-}
-type ExportTypes = {
-    SetClientOption: SetClientOption;
-    SetClientOptionToDefault: SetClientOptionToDefault;
-    GetClientOption: GetClientOption;
-    name: "walkingSpeed";
-    ValueType: ValueType;
-};
-export default ExportTypes;
+import { PlayerId } from "../../../type/index";
+/**
+ * Walking speed for the player.
+ * STRONGLY recommend using `speedMultiplier` unless you have a specific use case for this, walkingSpeed doesn't make UX sense on mobile.
+ * (Walking speed ignored for mobile players, mobile player speed is determined by joystick input and the max of runningSpeed & walkingSpeed).
+ *
+ * Players are used to the default bloxd movement behaviour and speed,
+ * and may be put off from your game if different muscle memory is required.
+ * We suggest applying speed or slowness effects instead, using api.applyEffect.
+ *
+ * The only use case for walkingSpeed/runningSpeed over speedMultiplier or speed effects is to disable running or to inverse walking/running (so you run by default and e.g. hold shift to go slower).
+ * @type {number}
+ * @default 4
+ */
+type ValueType = number;
+interface SetClientOption {
+    /**
+     *
+     * @param {PlayerId} playerId
+     * @param {"walkingSpeed"} option
+     * @param {number} value
+     * @returns {void}
+     */
+    setClientOption(playerId: PlayerId, option: "walkingSpeed", value: number): void;
+}
+interface GetClientOption {
+    /**
+     *
+     * @param {PlayerId} playerId
+     * @param {"walkingSpeed"} option
+     * @returns {number}
+     */
+    getClientOption(playerId: PlayerId, option: "walkingSpeed"): number;
+}
+interface SetClientOptionToDefault {
+    /**
+     *
+     * @param {PlayerId} playerId
+     * @param {"walkingSpeed"} option
+     * @returns {void}
+     */
+    setClientOptionToDefault(playerId: PlayerId, option: "walkingSpeed"): void;
+}
+type ExportTypes = {
+    SetClientOption: SetClientOption;
+    SetClientOptionToDefault: SetClientOptionToDefault;
+    GetClientOption: GetClientOption;
+    name: "walkingSpeed";
+    ValueType: ValueType;
+};
+export default ExportTypes;

package/dist/api-type-def/clientOption/index.d.ts

@@ -1,16 +1,12 @@
-import { PlayerId, MargeObject } from "../../type/index";
-import { ClientOptions, SetClientOption, GetClientOption, SetClientOptionToDefault } from "./clientOptions/index";
-export * from "./clientOptions/index";
-interface RootSetClientOption {
-    setClientOption<TOption extends keyof ClientOptions>(playerId: PlayerId, option: TOption, value: ClientOptions[TOption]): void;
-}
-interface SetClientOptions {
-    setClientOptions(playerId: PlayerId, options: Partial<ClientOptions>): void;
-}
-interface RootGetClientOption {
-    getClientOption<TOption extends keyof ClientOptions>(playerId: PlayerId, option: TOption): ClientOptions[TOption];
-}
-interface RootSetClientOptionToDefault {
-    setClientOptionToDefault<TOption extends keyof ClientOptions>(playerId: PlayerId, option: TOption): void;
-}
-export type ClientOptionApi = MargeObject<SetClientOption & RootSetClientOption & GetClientOption & RootGetClientOption & SetClientOptions & SetClientOptionToDefault & RootSetClientOptionToDefault>;
+import { PlayerId } from "../../type/index";
+import { ClientOptions } from "./clientOptions/index";
+export * from "./clientOptions/index";
+export declare const ClientOptionApis: {
+    setClientOption: (<TOption extends keyof ClientOptions>(playerId: PlayerId, option: TOption, value: ClientOptions[TOption]) => void) & {
+        (playerId: PlayerId, option: "canChange", value: true): void;
+        (playerId: PlayerId, option: "canChange", value: false): void;
+    } & ((playerId: PlayerId, option: "crouchingSpeed", value: number) => void) & ((playerId: PlayerId, option: "walkingSpeed", value: number) => void) & ((playerId: PlayerId, option: "runningSpeed", value: number) => void) & ((playerId: PlayerId, option: "speedMultiplier", value: number) => void);
+    getClientOption: (<TOption extends keyof ClientOptions>(playerId: PlayerId, option: TOption) => ClientOptions[TOption]) & ((playerId: PlayerId, option: "canChange") => boolean) & ((playerId: PlayerId, option: "crouchingSpeed") => number) & ((playerId: PlayerId, option: "walkingSpeed") => number) & ((playerId: PlayerId, option: "runningSpeed") => number) & ((playerId: PlayerId, option: "speedMultiplier") => number);
+    setClientOptionToDefault: (<TOption extends keyof ClientOptions>(playerId: PlayerId, option: TOption) => void) & ((playerId: PlayerId, option: "canChange") => void) & ((playerId: PlayerId, option: "crouchingSpeed") => void) & ((playerId: PlayerId, option: "walkingSpeed") => void) & ((playerId: PlayerId, option: "runningSpeed") => void) & ((playerId: PlayerId, option: "speedMultiplier") => void);
+    setClientOptions: (playerId: PlayerId, options: Partial<ClientOptions>) => void;
+};