bloxd.io.d.ts 1.0.0

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

@@ -0,0 +1,79 @@
+import { PlayerId } from "../../../type";
+
+/**
+ * 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/api-type-def/clientOption/clientOptions/crouchingSpeed.d.ts

@@ -0,0 +1,55 @@
+import { PlayerId } from "../../../type";
+
+/**
+ * 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/api-type-def/clientOption/clientOptions/index.d.ts

@@ -0,0 +1,68 @@
+import { MargeObject } from "../../../type/utilType";
+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/api-type-def/clientOption/clientOptions/runningSpeed.d.ts

@@ -0,0 +1,60 @@
+import { PlayerId } from "../../../type";
+
+/**
+ * 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/api-type-def/clientOption/clientOptions/speedMultiplier.d.ts

@@ -0,0 +1,61 @@
+import { PlayerId } from "../../../type";
+
+/**
+ * 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/api-type-def/clientOption/clientOptions/walkingSpeed.d.ts

@@ -0,0 +1,60 @@
+import { PlayerId } from "../../../type";
+
+/**
+ * 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/api-type-def/clientOption/index.d.ts

@@ -0,0 +1,43 @@
+import { PlayerId, MargeObject } from "../../type";
+import {
+  ClientOptions,
+  SetClientOption,
+  GetClientOption,
+  SetClientOptionToDefault,
+} from "./clientOptions";
+export * from "./clientOptions";
+
+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
+>;

package/api-type-def/entitySetting/entitySettings/example.d.ts

@@ -0,0 +1,90 @@
+import { EntityId, PlayerId } from "../../../type";
+
+/**
+ *
+ */
+type ValueType = never;
+
+declare const name: "example";
+
+interface SetTargetedPlayerSettingForEveryone {
+  /**
+   *
+   * @param {PlayerId} targetedPlayerId
+   * @param {"example"} settingName
+   * @param {!!--never--!!} settingValue
+   * @param {boolean} includeNewJoiners
+   */
+  setTargetedPlayerSettingForEveryone(
+    targetedPlayerId: PlayerId,
+    settingName: typeof name,
+    settingValue: ValueType,
+    includeNewJoiners?: boolean,
+  ): void;
+}
+
+interface SetEveryoneSettingForPlayer {
+  /**
+   *
+   * @overload
+   *
+   * @param {PlayerId} playerId
+   * @param {"example"} settingName
+   * @param {!!--never--!!} settingValue
+   * @param {boolean} [includeNewJoiners]
+   * @returns {void}
+   */
+  setEveryoneSettingForPlayer(
+    playerId: PlayerId,
+    settingName: typeof name,
+    settingValue: ValueType,
+    includeNewJoiners?: boolean,
+  ): void;
+}
+
+interface SetOtherEntitySetting {
+  /**
+   *
+   * @overload
+   *
+   * @param {PlayerId}
+   * @param {"example"} settingName
+   * @param {!!--never--!!} settingValue
+   * @param {boolean} [includeNewJoiners]
+   * @returns {void}
+   */
+
+  setOtherEntitySetting(
+    relevantPlayerId: PlayerId,
+    targetedEntityId: EntityId,
+    settingName: typeof name,
+    settingValue: ValueType,
+  ): void;
+}
+
+interface GetOtherEntitySetting {
+  /**
+   *
+   * @overload
+   *
+   * @param {PlayerId} relevantPlayerId
+   * @param {EntityId} targetedEntityId
+   * @param {"example"} settingName
+   * @returns {!!--never--!!}
+   */
+  getOtherEntitySetting(
+    relevantPlayerId: PlayerId,
+    targetedEntityId: EntityId,
+    settingName: typeof name,
+  ): ValueType;
+}
+type ExportTypes = {
+  name: typeof name;
+  ValueType: ValueType;
+  SetTargetedPlayerSettingForEveryone: SetTargetedPlayerSettingForEveryone;
+  SetEveryoneSettingForPlayer: SetEveryoneSettingForPlayer;
+  SetOtherEntitySetting: SetOtherEntitySetting;
+  GetOtherEntitySetting: GetOtherEntitySetting;
+};
+
+export default ExportTypes;

package/api-type-def/entitySetting/entitySettings/index.d.ts

@@ -0,0 +1,83 @@
+import { EntityId, MargeObject, PlayerId } from "../../../type";
+import Opacity from "./opacity";
+import ZIndex from "./zIndex";
+import OverlayColour from "./overlayColour";
+
+type EntitySettingExportFormat = {
+  name: string;
+  ValueType: any;
+  SetTargetedPlayerSettingForEveryone: {
+    setTargetedPlayerSettingForEveryone: (
+      targetedPlayerId: PlayerId,
+      settingName: never,
+      settingValue: never,
+      includeNewJoiners?: boolean,
+    ) => void;
+  };
+  SetEveryoneSettingForPlayer: {
+    setEveryoneSettingForPlayer: (
+      playerId: PlayerId,
+      settingName: never,
+      settingValue: never,
+      includeNewJoiners?: boolean,
+    ) => void;
+  };
+  SetOtherEntitySetting: {
+    setOtherEntitySetting: (
+      relevantPlayerId: PlayerId,
+      targetedEntityId: EntityId,
+      settingName: never,
+      settingValue: never,
+    ) => void;
+  };
+  GetOtherEntitySetting: {
+    getOtherEntitySetting: (
+      relevantPlayerId: PlayerId,
+      targetedEntityId: EntityId,
+      settingName: never,
+    ) => any;
+  };
+};
+
+type AllEntitySettingUnion = Opacity | ZIndex | OverlayColour;
+
+type GenerateClientOptions<U extends EntitySettingExportFormat> = {
+  [K in U as K["name"]]: K["ValueType"];
+};
+
+export type EntitySettings = GenerateClientOptions<AllEntitySettingUnion>;
+
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (
+  k: infer I,
+) => void
+  ? I
+  : never;
+type GenerateEntitySettingInterface<
+  U extends EntitySettingExportFormat,
+  K extends keyof any,
+> = MargeObject<
+  UnionToIntersection<
+    U extends any ? (K extends keyof U ? U[K] : never) : never
+  >
+>;
+
+export type SetTargetedPlayerSettingForEveryone =
+  GenerateEntitySettingInterface<
+    AllEntitySettingUnion,
+    "SetTargetedPlayerSettingForEveryone"
+  >;
+
+export type SetEveryoneSettingForPlayer = GenerateEntitySettingInterface<
+  AllEntitySettingUnion,
+  "SetEveryoneSettingForPlayer"
+>;
+
+export type SetOtherEntitySetting = GenerateEntitySettingInterface<
+  AllEntitySettingUnion,
+  "SetOtherEntitySetting"
+>;
+
+export type GetOtherEntitySetting = GenerateEntitySettingInterface<
+  AllEntitySettingUnion,
+  "GetOtherEntitySetting"
+>;

package/api-type-def/entitySetting/entitySettings/opacity.d.ts

@@ -0,0 +1,96 @@
+import { EntityId, PlayerId } from "../../../type";
+
+/**
+ * Opacity of the entity
+ * Fractional values will use dithering
+ * 0 opacity will hide the entity but not its name tag
+ * @type {number}
+ * @default 1
+ */
+type ValueType = number;
+
+interface SetTargetedPlayerSettingForEveryone {
+  /**
+   *
+   * @overload
+   *
+   * @param {PlayerId} targetedPlayerId
+   * @param {"opacity"} settingName
+   * @param {Opacity} settingValue
+   * @param {boolean} [includeNewJoiners]
+   * @returns {void}
+   */
+  setTargetedPlayerSettingForEveryone(
+    targetedPlayerId: PlayerId,
+    settingName: "opacity",
+    settingValue: ValueType,
+    includeNewJoiners?: boolean,
+  ): void;
+}
+
+interface SetEveryoneSettingForPlayer {
+  /**
+   *
+   * @overload
+   *
+   * @param {PlayerId} playerId
+   * @param {"opacity"} settingName
+   * @param {Opacity} settingValue
+   * @param {boolean} [includeNewJoiners]
+   * @returns {void}
+   */
+  setEveryoneSettingForPlayer(
+    playerId: PlayerId,
+    settingName: "opacity",
+    settingValue: ValueType,
+    includeNewJoiners?: boolean,
+  ): void;
+}
+
+interface SetOtherEntitySetting {
+  /**
+   *
+   * @overload
+   *
+   * @param {PlayerId}
+   * @param {"opacity"} settingName
+   * @param {Opacity} settingValue
+   * @param {boolean} [includeNewJoiners]
+   * @returns {void}
+   */
+
+  setOtherEntitySetting(
+    relevantPlayerId: PlayerId,
+    targetedEntityId: EntityId,
+    settingName: "opacity",
+    settingValue: ValueType,
+  ): void;
+}
+
+interface GetOtherEntitySetting {
+  /**
+   *
+   * @overload
+   *
+   * @param {PlayerId} relevantPlayerId
+   * @param {EntityId} targetedEntityId
+   * @param {"opacity"} settingName
+   * @returns {void}
+   */
+  getOtherEntitySetting(
+    relevantPlayerId: PlayerId,
+    targetedEntityId: EntityId,
+    settingName: "opacity",
+  ): ValueType;
+}
+
+type ExportTypes = {
+  name: "opacity";
+  ValueType: ValueType;
+  SetTargetedPlayerSettingForEveryone: SetTargetedPlayerSettingForEveryone;
+  SetEveryoneSettingForPlayer: SetEveryoneSettingForPlayer;
+  SetOtherEntitySetting: SetOtherEntitySetting;
+  GetOtherEntitySetting: GetOtherEntitySetting;
+};
+
+export default ExportTypes;