Choice List Options
Ossra
Ossra
Summary
The plugin allows the game developer to set positioning and layout options of the choice list window.
Options
- Window
- X Position
- Y Position
- X Anchor
- Y Anchor
- Number of Rows
- Number of Columns
- Item
- Text Alignment
- Width
- Spacing
- Trim
- Number of Excess Rows
- Number of Excess Columns
• Window Properties
The default properties of the choice list window. Properties that are set here can be temporarily overwritten using plugin commands.
• X Position
The x coordinate of the choice window on the screen. Negative values are accepted.
• Y Position
The y coordinate of the choice window on the screen. Negative values are accepted.
• X Anchor
The x anchor of the choice window.
• Y Anchor
The y anchor of the choice window.
• Rows
The number of rows the choice window will display.
• Columns
The number of columns the choice window will display.
• Item Properties
The default item properties of the choice list window. Properties that are set here can be temporarily overwritten using plugin commands.
• Text Align
The text alignment of each choice option (left, center, right).
• Width
The maximum width of each choice option. Value is in pixels.
• Spacing
The spacing between each choice option. Value is in pixels.
• Trim Properties
The default trim actions for the choice list window. Properties that are set here can be temporarily overwritten using plugin commands.
• Rows
Enable or disable trimming the number of rows to fit the number of list items.
• Columns
Enable or disable trimming the number of columns to fit the number of list items.
• Set
• Clear
Code:
ossra ChoiceList set section property value retain
ossra ChoiceList set section property,property value,value retain,retain
|--------------------------------------------------------------------------|
| Sets one or more properties of the choice list.
|--------------------------------------------------------------------------|
| < Name > < Type > < Note >
| section String See list below for options.
| property String See list below for options.
| value Any See list below for values.
| retain Boolean Temporarily sets the value as default.
|--------------------------------------------------------------------------|
|--------------------------------------------------------------------------|
| Section | Window
|--------------------------------------------------------------------------|
| < Name > < Type > < Note >
| x Number X coordinate of the choice window.
| y Number Y coordinate of the choice window.
| ax Number X anchor of the choice window.
| ay Number Y anchor of the choice window.
| rows Number Number of rows to be displayed.
| columns Number Number of columns to be displayed.
|--------------------------------------------------------------------------|
|--------------------------------------------------------------------------|
| Section | Item
|--------------------------------------------------------------------------|
| < Name > < Type > < Note >
| align String Text alignment of items. Value must be
| in quotations. (e.g. - "center")
| spacing Varies Spacing between items. If value is
| numerical, both horizontal and vertical
| spacing is linked. If value is an
| array (e.g. - [15,25]), then the
| horizontal value is the first entry and
| the vertical value is the second entry.
| width Number Maximum width of items.
|--------------------------------------------------------------------------|
|--------------------------------------------------------------------------|
| Section | Trim
|--------------------------------------------------------------------------|
| < Name > < Type > < Note >
| rows Boolean Trim rows to fit number of list items.
| columns Boolean Trim columns to fit number of list items.
|--------------------------------------------------------------------------|
// Example(s)
ossra ChoiceList set window x,y 50,50
ossra ChoiceList set window width 500
ossra ChoiceList set window x,y,rows,columns 50,50,2,2 true
ossra ChoiceList set trim rows,columns true
ossra ChoiceList set item width,spacing,align 120,[25,100],"center" true
• Clear
Code:
ossra ChoiceList clear section
ossra ChoiceList clear section property
ossra ChoiceList clear section property,property
|--------------------------------------------------------------------------|
| Clears the specified properties of the choice list.
|--------------------------------------------------------------------------|
// Example(s)
ossra ChoiceList clear window
ossra ChoiceList clear item
ossra ChoiceList clear window y,rows,columns
1.42
RPG Maker Version
1.6.2
Download
via GitHub
Terms of Use
Free for Commercial and Non-Commercial Usage
License
MIT License
Last edited: