VOTEINFO: Difference between revisions

From Zandronum Wiki
(Added new page VOTEINFO to replace VOTEDEF)
 
Tag: Source edit
Line 1: Line 1:
{{SpecialLumpWarning}}
{{SpecialLumpWarning}}
'''VOTEINFO''' is a special lump that allows mods to implement custom [[Zandronum]] votes, which can be called with the ''CallVote'' [[Console commands|Console command]].
{{Devfeature|3.2|alpha}} '''VOTEINFO''' is a special lump that allows mods to implement custom [[Zandronum]] votes, which can be called with the ''CallVote'' [[Console commands|Console command]].


To create a vote, the following syntax can be used.
To create a vote, the following syntax can be used.
Line 26: Line 26:


The value must correspond to a valid existing cvar.
The value must correspond to a valid existing cvar.
[[Category: Zandronum-specific lumps]]

Revision as of 13:15, 24 January 2024

This article documents a Zandronum-specific special lump which may not be supported by ZDoom and its other child ports.

(development version 3.2-alpha and above only) VOTEINFO is a special lump that allows mods to implement custom Zandronum votes, which can be called with the CallVote Console command.

To create a vote, the following syntax can be used.

VoteType <voteName>
{
   Arg = <argumentType>;
   Action = CallACS (<scriptName>);
   ForbidCVar = <cvarName>;
}

The only required parameter is Action.

Parameters

  • voteName

This is the unique name of the vote, and will be used with the CallVote Console command to call this custom vote.

  • argumentType

This optional parameter can be used to specify an argument to pass with votes.

The value must be either Int or Str. By not passing Arg the vote does not take an argument.

  • scriptName

This required parameter corresponds to the script that must be invoked when the vote passes.

  • cvarName

This optional parameter can be used to forbid the usage of the vote when the cvar is enabled.

The value must correspond to a valid existing cvar.