Parent : lists
Caption Panels displays lists of commands that a player can perform. For example:
buttonwidth integer
Specifies the default width of a button that is displayed at the bottom of the 3D client (eg Actions button).
buttongap integer
Specifies the default gap between each of the buttons at the bottom of the 3D client eg the space between the Actions button and Combat button.
fontsize integer
The default font size of the caption panels.
CAPTIONPANEL
A CAPTIONPANELS has unlimited CAPTIONPANEL elements.
name string
The name of the panel. When the mud references a panel this is what it matches to. For example the 3D mud tag {cinv,igold watch} will reference a captionpanel of 'name' inv.
caption string
The caption on the button and the caption itself. Can be overridden by the mud.
buttoncaption string
Allows a different caption on the button compared to the caption.
list string
Links to a rawlist if one is used. Allows a list of actions to be defined within the config file. If list is generated by mud (eg inventory) then this is blank.
buttontype string
Is the enumerated type 'button' and 'dropdown'. As described in caption panels there are two types of buttons. One type is the dropdown (eg inventory) and the other is set of buttons (eg actions).
clearonmove boolean
Remove the caption panel when the player moves rooms. For example might have a caption panel for a bulletin board but want this to disappear when the player moves to another room that doesnt have a bulletin board.
panelwidth integer
The width of the panel. Can be overidden by the mud.
hidebuttonifempty boolean
If a caption panel has no items then dont display the caption panel if this is true. For example a bulletin board has no messages then dont display the empty caption panel.
popuptype string
Is the enumerated type 'none', 'firsttime', 'everytime', 'everytimeone'. It specifies how a caption panel pops up when the mud specifies a caption panel. For example it is possible to pop up a caption panel every time the mud specifies the caption. For example when you walk into a shop you might want the list of food for sale to always pop up.
none
Player must click on the caption panel button at the bottom of the screen to display the caption panel
firsttime
Same as above except the very first time the mud specifies the caption panel. An example might be the suggested button that pops up its contents the first time the mud specifies suggested commands but from then on the player opens it himself.
everytime
Every time the mud specifies the caption panel it pops up. For example every time a player walks into the shop the list of food might be displayed.
everytimeone
Same as above except remove other buttons that use 'everytimeone'. Stops a long list of buttons appearing at the bottom of the screen. Used when a room can display many lists. For example a shop keeper with a newspaper and bulletin board. A player could right click the shop keeper, read the newspaper and read the bulletin board by right clicking. This would produce three buttons. If 'everytimeone' is use then only one of these buttons would be displayed at a time.
hint string
Hint on the button at the bottom of the screen when player moves mouse over button
icon string
The icon file that is displayed on the button at the bottom of the screen. Eg a bag for inventory.
flat boolean
Buttons displayed at the bottom of the screen are flat and have no border.
usepanelcommand boolean
If true then match the 'panelcommand' in object to the object in the panelcommand (specified by 3dtags 3) and then add the extra items to the drop down. For example if you have a piece of cheese in your inventory you might have panelcommand="food" in object for cheese. The rawlists for food would then be added to the drop down and include actions like 'eat'.
buttonwidth integer
Width of a button at the bottom of the screen. Can override 'buttonwidth' in CAPTIONPANELS.
The following attributes are related to hashes that allow a specific question to be asked based upon a match to the caption of a button in the caption panel. For example in a bank you might have 'hashmatch1' as 'withdraw ' and 'hashmatchreplace1' as the question 'Widthdraw how many coins from the bank?'. When the player clicks on the 'widthdraw' button in the caption panel the question is asked. You can have up to 3 matches specified by the attributes below. Refer to caption panel hashes for more information.
hashmatch1 string
Matches part of the button caption. If a match then when the asked to enter a value will ask the question in 'hashmatchreplace1'
hashmatch2 string
As above but a second match and matches 'hashmatchreplace2' as the question
hashmatch3 string
As above but a third match and matches 'hashmatchreplace3' as the question
hashmatchreplace1 string
Question asked if 'hashmatch1' matched
hashmatchreplace2 string
Question asked if 'hashmatch2' matched
hashmatchreplace3 string
Question asked if 'hashmatch3' matched
