bloxd.io.d.ts 2.0.1 → 2.2.0

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

@@ -1,63 +1,63 @@
-import { EntityId, PlayerId } from "../../../type/index";
-/**
- *
- */
-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;
+import { EntityId, PlayerId } from "../../../type/index";
+/**
+ *
+ */
+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/dist/api-type-def/entitySetting/entitySettings/index.d.ts

@@ -1,32 +1,32 @@
-import { EntityId, MargeObject, PlayerId } from "../../../type/index";
-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">;
-export {};
+import { EntityId, MargeObject, PlayerId } from "../../../type/index";
+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">;
+export {};

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

@@ -1,69 +1,69 @@
-import { EntityId, PlayerId } from "../../../type/index";
-/**
- * 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;
+import { EntityId, PlayerId } from "../../../type/index";
+/**
+ * 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;

package/dist/api-type-def/entitySetting/entitySettings/overlayColour.d.ts

@@ -1,65 +1,65 @@
-import { EntityId, PlayerId } from "../../../type/index";
-/**
- * Applies a colour tint to the entity when set, like the red tint when an entity gets hurt.
- * @type {string | null}
- * @default null
- */
-type ValueType = string | null;
-declare const name: "overlayColour";
-interface SetTargetedPlayerSettingForEveryone {
-    /**
-     *
-     * @param {PlayerId} targetedPlayerId
-     * @param {"overlayColour"} settingName
-     * @param {string | null} settingValue
-     * @param {boolean} includeNewJoiners
-     */
-    setTargetedPlayerSettingForEveryone(targetedPlayerId: PlayerId, settingName: typeof name, settingValue: ValueType, includeNewJoiners?: boolean): void;
-}
-interface SetEveryoneSettingForPlayer {
-    /**
-     *
-     * @overload
-     *
-     * @param {PlayerId} playerId
-     * @param {"overlayColour"} settingName
-     * @param {string | null} settingValue
-     * @param {boolean} [includeNewJoiners]
-     * @returns {void}
-     */
-    setEveryoneSettingForPlayer(playerId: PlayerId, settingName: typeof name, settingValue: ValueType, includeNewJoiners?: boolean): void;
-}
-interface SetOtherEntitySetting {
-    /**
-     *
-     * @overload
-     *
-     * @param {PlayerId}
-     * @param {"overlayColour"} settingName
-     * @param {string | null} 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 {"overlayColour"} settingName
-     * @returns {string | null}
-     */
-    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;
+import { EntityId, PlayerId } from "../../../type/index";
+/**
+ * Applies a colour tint to the entity when set, like the red tint when an entity gets hurt.
+ * @type {string | null}
+ * @default null
+ */
+type ValueType = string | null;
+declare const name: "overlayColour";
+interface SetTargetedPlayerSettingForEveryone {
+    /**
+     *
+     * @param {PlayerId} targetedPlayerId
+     * @param {"overlayColour"} settingName
+     * @param {string | null} settingValue
+     * @param {boolean} includeNewJoiners
+     */
+    setTargetedPlayerSettingForEveryone(targetedPlayerId: PlayerId, settingName: typeof name, settingValue: ValueType, includeNewJoiners?: boolean): void;
+}
+interface SetEveryoneSettingForPlayer {
+    /**
+     *
+     * @overload
+     *
+     * @param {PlayerId} playerId
+     * @param {"overlayColour"} settingName
+     * @param {string | null} settingValue
+     * @param {boolean} [includeNewJoiners]
+     * @returns {void}
+     */
+    setEveryoneSettingForPlayer(playerId: PlayerId, settingName: typeof name, settingValue: ValueType, includeNewJoiners?: boolean): void;
+}
+interface SetOtherEntitySetting {
+    /**
+     *
+     * @overload
+     *
+     * @param {PlayerId}
+     * @param {"overlayColour"} settingName
+     * @param {string | null} 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 {"overlayColour"} settingName
+     * @returns {string | null}
+     */
+    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/dist/api-type-def/entitySetting/entitySettings/zIndex.d.ts

@@ -1,64 +1,64 @@
-import { EntityId, PlayerId } from "../../../type/index";
-/**
- * Rendering order of the entity, higher zIndex renders on top of lower ones.
- * @type {0 | 1}
- */
-type ValueType = 0 | 1;
-declare const name: "zIndex";
-interface SetTargetedPlayerSettingForEveryone {
-    /**
-     *
-     * @param {PlayerId} targetedPlayerId
-     * @param {"zIndex"} settingName
-     * @param {0| 1} settingValue
-     * @param {boolean} includeNewJoiners
-     */
-    setTargetedPlayerSettingForEveryone(targetedPlayerId: PlayerId, settingName: typeof name, settingValue: ValueType, includeNewJoiners?: boolean): void;
-}
-interface SetEveryoneSettingForPlayer {
-    /**
-     *
-     * @overload
-     *
-     * @param {PlayerId} playerId
-     * @param {"zIndex"} settingName
-     * @param {0| 1} settingValue
-     * @param {boolean} [includeNewJoiners]
-     * @returns {void}
-     */
-    setEveryoneSettingForPlayer(playerId: PlayerId, settingName: typeof name, settingValue: ValueType, includeNewJoiners?: boolean): void;
-}
-interface SetOtherEntitySetting {
-    /**
-     *
-     * @overload
-     *
-     * @param {PlayerId}
-     * @param {"zIndex"} settingName
-     * @param {0| 1} 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 {"zIndex"} settingName
-     * @returns {0| 1}
-     */
-    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;
+import { EntityId, PlayerId } from "../../../type/index";
+/**
+ * Rendering order of the entity, higher zIndex renders on top of lower ones.
+ * @type {0 | 1}
+ */
+type ValueType = 0 | 1;
+declare const name: "zIndex";
+interface SetTargetedPlayerSettingForEveryone {
+    /**
+     *
+     * @param {PlayerId} targetedPlayerId
+     * @param {"zIndex"} settingName
+     * @param {0| 1} settingValue
+     * @param {boolean} includeNewJoiners
+     */
+    setTargetedPlayerSettingForEveryone(targetedPlayerId: PlayerId, settingName: typeof name, settingValue: ValueType, includeNewJoiners?: boolean): void;
+}
+interface SetEveryoneSettingForPlayer {
+    /**
+     *
+     * @overload
+     *
+     * @param {PlayerId} playerId
+     * @param {"zIndex"} settingName
+     * @param {0| 1} settingValue
+     * @param {boolean} [includeNewJoiners]
+     * @returns {void}
+     */
+    setEveryoneSettingForPlayer(playerId: PlayerId, settingName: typeof name, settingValue: ValueType, includeNewJoiners?: boolean): void;
+}
+interface SetOtherEntitySetting {
+    /**
+     *
+     * @overload
+     *
+     * @param {PlayerId}
+     * @param {"zIndex"} settingName
+     * @param {0| 1} 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 {"zIndex"} settingName
+     * @returns {0| 1}
+     */
+    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;