VOTEINFO: Difference between revisions
DrinkyBird (talk | contribs) (Add Template:Devfeature and to Category: Zandronum-specific lumps) Tag: Source edit |
DrinkyBird (talk | contribs) (Add Template:DevfeatureWarning as well) Tag: Source edit |
||
Line 1: | Line 1: | ||
{{SpecialLumpWarning}} | {{SpecialLumpWarning}} | ||
{{DevfeatureWarning|version=3.2|type=a [[:Category:Special lumps|special lump]]}} | |||
{{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]]. | {{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]]. | ||
Latest revision as of 14:03, 24 January 2024
This article documents a Zandronum-specific special lump which may not be supported by ZDoom and its other child ports. |
This article documents a special lump which is only available in development builds of Zandronum 3.2 and newer. |
(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.