@plugify-plugins/s2sdk-types 1.3.0 → 1.3.1

package/index.d.ts

@@ -636,6 +636,187 @@ declare module ":s2sdk" {
         DoNotEcho = 2
     }
 
+    /**
+    * @description Enum representing the possible reasons a vote creation or processing has failed.
+    */
+    export enum VoteCreateFailed {
+
+        /**
+         * @description Generic vote failure. 
+         * */
+        Generic = 0,
+
+        /**
+         * @description Vote failed due to players transitioning. 
+         * */
+        TransitioningPlayers = 1,
+
+        /**
+         * @description Vote failed because vote rate limit was exceeded. 
+         * */
+        RateExceeded = 2,
+
+        /**
+         * @description Vote failed because Yes votes must exceed No votes. 
+         * */
+        YesMustExceedNo = 3,
+
+        /**
+         * @description Vote failed due to quorum not being met. 
+         * */
+        QuorumFailure = 4,
+
+        /**
+         * @description Vote failed because the issue is disabled. 
+         * */
+        IssueDisabled = 5,
+
+        /**
+         * @description Vote failed because the map was not found. 
+         * */
+        MapNotFound = 6,
+
+        /**
+         * @description Vote failed because map name is required. 
+         * */
+        MapNameRequired = 7,
+
+        /**
+         * @description Vote failed because a similar vote failed recently. 
+         * */
+        FailedRecently = 8,
+
+        /**
+         * @description Vote to kick failed recently. 
+         * */
+        FailedRecentKick = 9,
+
+        /**
+         * @description Vote to change map failed recently. 
+         * */
+        FailedRecentChangeMap = 10,
+
+        /**
+         * @description Vote to swap teams failed recently. 
+         * */
+        FailedRecentSwapTeams = 11,
+
+        /**
+         * @description Vote to scramble teams failed recently. 
+         * */
+        FailedRecentScrambleTeams = 12,
+
+        /**
+         * @description Vote to restart failed recently. 
+         * */
+        FailedRecentRestart = 13,
+
+        /**
+         * @description Team is not allowed to call vote. 
+         * */
+        TeamCantCall = 14,
+
+        /**
+         * @description Vote failed because game is waiting for players. 
+         * */
+        WaitingForPlayers = 15,
+
+        /**
+         * @description Target player was not found. 
+         * */
+        PlayerNotFound = 16,
+
+        /**
+         * @description Cannot kick an admin. 
+         * */
+        CannotKickAdmin = 17,
+
+        /**
+         * @description Scramble is currently in progress. 
+         * */
+        ScrambleInProgress = 18,
+
+        /**
+         * @description Swap is currently in progress. 
+         * */
+        SwapInProgress = 19,
+
+        /**
+         * @description Spectators are not allowed to vote. 
+         * */
+        Spectator = 20,
+
+        /**
+         * @description Voting is disabled. 
+         * */
+        Disabled = 21,
+
+        /**
+         * @description Next level is already set. 
+         * */
+        NextLevelSet = 22,
+
+        /**
+         * @description Rematch vote failed. 
+         * */
+        Rematch = 23,
+
+        /**
+         * @description Vote to surrender failed due to being too early. 
+         * */
+        TooEarlySurrender = 24,
+
+        /**
+         * @description Vote to continue failed. 
+         * */
+        Continue = 25,
+
+        /**
+         * @description Vote failed because match is already paused. 
+         * */
+        MatchPaused = 26,
+
+        /**
+         * @description Vote failed because match is not paused. 
+         * */
+        MatchNotPaused = 27,
+
+        /**
+         * @description Vote failed because game is not in warmup. 
+         * */
+        NotInWarmup = 28,
+
+        /**
+         * @description Vote failed because there are not 10 players. 
+         * */
+        Not10Players = 29,
+
+        /**
+         * @description Vote failed due to an active timeout. 
+         * */
+        TimeoutActive = 30,
+
+        /**
+         * @description Vote failed because timeout is inactive. 
+         * */
+        TimeoutInactive = 31,
+
+        /**
+         * @description Vote failed because timeout has been exhausted. 
+         * */
+        TimeoutExhausted = 32,
+
+        /**
+         * @description Vote failed because the round can't end now. 
+         * */
+        CantRoundEnd = 33,
+
+        /**
+         * @description Sentinel value. Not a real failure reason. 
+         * */
+        Max = 34
+    }
+
     /**
     * @description Enum representing the possible types of a vote actions.
     */
@@ -4520,11 +4701,14 @@ declare module ":s2sdk" {
      * @param caller Player slot of the vote caller. Use VOTE_CALLER_SERVER for 'Server'.
      * @param voteTitle Translation string to use as the vote message. (Only '#SFUI_vote' or '#Panorama_vote' strings)
      * @param detailStr Extra string used in some vote translation strings.
+     * @param votePassTitle Translation string to use as the vote message. (Only '#SFUI_vote' or '#Panorama_vote' strings)
+     * @param detailPassStr Extra string used in some vote translation strings when the vote passes.
+     * @param failReason Reason for the vote to fail, used in some translation strings.
      * @param filter Recipient filter with all the clients who are allowed to participate in the vote.
      * @param result Called when a menu action is completed.
      * @param handler Called when the vote has finished.
      */
-    export function PanoramaSendYesNoVote(duration: number, caller: number, voteTitle: string, detailStr: string, filter: number, result: typeof Callbacks.YesNoVoteResult, handler: typeof Callbacks.YesNoVoteHandler): boolean;
+    export function PanoramaSendYesNoVote(duration: number, caller: number, voteTitle: string, detailStr: string, votePassTitle: string, detailPassStr: string, failReason: VoteCreateFailed, filter: number, result: typeof Callbacks.YesNoVoteResult, handler: typeof Callbacks.YesNoVoteHandler): boolean;
 
     /**
      * @description Start a new Yes/No vote with all players included
@@ -4535,10 +4719,13 @@ declare module ":s2sdk" {
      * @param caller Player slot of the vote caller. Use VOTE_CALLER_SERVER for 'Server'.
      * @param voteTitle Translation string to use as the vote message. (Only '#SFUI_vote' or '#Panorama_vote' strings)
      * @param detailStr Extra string used in some vote translation strings.
+     * @param votePassTitle Translation string to use as the vote message. (Only '#SFUI_vote' or '#Panorama_vote' strings)
+     * @param detailPassStr Extra string used in some vote translation strings when the vote passes.
+     * @param failReason Reason for the vote to fail, used in some translation strings.
      * @param result Called when a menu action is completed.
      * @param handler Called when the vote has finished.
      */
-    export function PanoramaSendYesNoVoteToAll(duration: number, caller: number, voteTitle: string, detailStr: string, result: typeof Callbacks.YesNoVoteResult, handler: typeof Callbacks.YesNoVoteHandler): boolean;
+    export function PanoramaSendYesNoVoteToAll(duration: number, caller: number, voteTitle: string, detailStr: string, votePassTitle: string, detailPassStr: string, failReason: VoteCreateFailed, result: typeof Callbacks.YesNoVoteResult, handler: typeof Callbacks.YesNoVoteHandler): boolean;
 
     /**
      * @description Removes a player from the current vote.
@@ -5793,10 +5980,9 @@ declare module ":s2sdk" {
      * 
      * @param msgSerializable The serializable message.
      * @param message The network message.
-     * @param nRecipientCount The number of recipients.
      * @param recipientMask The recipient mask.
      */
-    export function UserMessageCreateFromSerializable(msgSerializable: number, message: number, nRecipientCount: number, recipientMask: number): number;
+    export function UserMessageCreateFromSerializable(msgSerializable: number, message: number, recipientMask: number): number;
 
     /**
      * @description Creates a UserMessage from a message name.
@@ -5908,15 +6094,6 @@ declare module ":s2sdk" {
      */
     export function UserMessageSetRecipientMask(userMessage: number, mask: number): void;
 
-    /**
-     * @description Checks if the UserMessage was manually allocated.
-     * 
-     * {@link https://untrustedmodders.github.io/plugify-generator/?file=https://github.com/untrustedmodders/plugify-source-2/blob/main/s2sdk.pplugin.in#item-UserMessageIsManuallyAllocated|Docs}
-     * 
-     * @param userMessage The UserMessage instance.
-     */
-    export function UserMessageIsManuallyAllocated(userMessage: number): boolean;
-
     /**
      * @description Gets a nested message from a field in the UserMessage.
      * 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@plugify-plugins/s2sdk-types",
-    "version": "1.3.0",
+    "version": "1.3.1",
     "description": "generated typescript types to write plugins on plugify",
     "types": "index.d.ts",
     "scripts": {},