KToggleButtons

[kyonides]

KToggleButtons XP + VX + ACE

by Kyonides Arkanthes

Introduction

Are you  bored of using the same old text buttons?
Now you can replace them with some good looking Toggle Buttons!

"Old Screenshots"

Instructions

Define a New Style
XP & VX Ways
STYLES[:style_name] = { :name => "Basica", :cursor => "cursor1",
  :cursor_off => "cursor2", :on => "toggle1", :off => "toggle2", :button => "toggle3" }

ACE Way
STYLES[:basic] = { name: "Basica", cursor: "cursor1",
    cursor_off: "cursor2", on: "toggle1", off: "toggle2", button: "toggle3" }

Change Current Toggle Button Style - Use any of the keys you enter in the STYLES Hash.
$game_system.toggle_button_style = :basic

How to Define a Toggle Button Manager

Code:

@manager = KToggle::Manager.new(FontSize, LineHeight, "Name", LabelsArray)
@manager.setup_buttons(X, Y, LabelWidth, LabelHeight)
@manager.setup_cursor(true) # Create an Active Cursor

How to Set a State - Repeat as many times as deemed necessary!
@manager.set_state(1, some_variable)
@manager.set_state(2, some_variable)

How to Get a State - Here 1 stands for the first position in the Array.
@manager.state?(1)

Since the demos include a TestScene script, you can take a look at it to learn a bit more on how to create your custom scene script.

The Demos

Terms & Conditions

Free for non commercial games.
Contact me if you needed for commercial games.
Mention me in your game credits.

[kyonides]

Maintenance update

Not long ago I had to upload new versions of both demos to correct some visual glitches that I had found there. They weren't really important but you could find yourself being unable to read the nun's comments on the ACE version because I picked a terrible font color. Plus, I had to move up the buttons' texts a little bit in the XP version. I even updated the screenshot to reflect the changes.

As a bonus(?) I have also modified the start menu and uploaded a VX demo minutes ago.

Anyway, these new demos will be the only ones I will be supporting from now on. Feel free to redownload them at any time.

[kyonides]

Interesting Update

My script has now reached the 1.0.0 milestone!

The full version brings you the possibility to setup two different kinds of toggle buttons: the multiple choices set (by default) and the single choice set (by adding a single line of code).

It also allows you to easily setup what I called subheadings to identify your button sets.

[Kain Nobel]

I figured I'd drop in and contribute some graphics (and ideas) for this cool script! 

You can crop these images and save them as individual icons (XP) or copy/paste them individually into your local icon sheets (VX and beyond).

These icons are from my personal collection; just stick to the original terms and conditions of kyonide's script and all is good in the world.

Also, I like credit too if the icons are used. Otherwise, I'll pop out of the bowl of rice with a poisoned blow dart and nobody will be the wiser...  

Radio Buttons



Radio buttons represent your standard binary True / False settings. 

Check Buttons



Check Buttons can be used to represent standard True / False, as well as Nil and Maybe.

I don't know how well these ambiguous Maybe and Nil states are represented in kyonide's current script, but feel free to use them as you wish.

Also, I tried to design these to be high contrast so they can still be visible even on a menu surface of any matching color (results may vary.)

More Context (Use Cases of Maybe and Nil)

Nil : Nothing has been selected. (Sometimes represented as a False or a Maybe.)
True : The box has been checked as a "Yes" state.
False : The box has been checked as a "No" state. (Sometimes represented as a Nil.)
Maybe : The box has not been physically checked and represents an unchanged state. (Sometimes represented as a Nil.)

In most cases, only 2 (or 3) of these CheckButton values are used and are sufficient.

(It is extremely rare that all 4 of these values would be used, but I suppose there are edge cases where they may be useful to use them all. I'd discourage it in most instances though.)

For data where the current state cannot be known, the Maybe state is basically the "go with the current state" state.

Here is how I use Maybe and Nil values in the context of my Missions system.

"Photograph the The Mayor With His Mistress" is a Nil (by default) because that hasn't happened yet; this is a pending objective that can either be Completed (True) or Failed (False). Fail this objective and you've failed the entire mission.

"Avoid Civilian Casualties" is a Maybe (by default) while the mission is ongoing and nobody has been killed (yet.) Once you've killed someone, it is Failed (False). If you finished the mission without killing civilians, it is flipped to Completed (True) at the very last second. Killing civilians is indeed bad, but you can still Fail (False) that objective and continue your mission, so I use the Maybe instead of the Nil to let the player know they haven't killed any civilians.

Sometimes Nil, False and Maybe are interchangeable terms and functions, all depending on the context of where and how it is being used.

I think as software users we take for granted the humble checkboxes and radio buttons but they really can be quite expressive (and super easy to use.) Definitely a great tool for menu designers, thank you for publishing. Congrats on the 1.0.0 milesetone!

[kyonides]

Check Buttons



Check Buttons can be used to represent standard True / False, as well as Nil and Maybe.

I don't know how well these ambiguous Maybe and Nil states are represented in kyonide's current script, but feel free to use them as you wish.
...
Nil : Nothing has been selected. (Sometimes represented as a False or a Maybe.)
True : The box has been checked as a "Yes" state.
False : The box has been checked as a "No" state. (Sometimes represented as a Nil.)
Maybe : The box has not been physically checked and represents an unchanged state. (Sometimes represented as a Nil.)
...
Here is how I use Maybe and Nil values in the context of my Missions system.

Well, you could call the nil or maybe buttons tri-state buttons. I know they do exist for even Linux distros with KDE GUI sometimes have them. Yet, I didn't want to include them in my scripts for a simple reason: most people don't need them under normal circumstances.

Besides, my "radio buttons" are meant for use in menus, not missions and the like.

[Kain Nobel]

Less is more, I agree. With you always looking for ideas, I figured I'd give ya one and contribute some free icons that could be useful with this system.

Either way, these are great menu design elements. Take care and happy scripting!

[kyonides]

Maintenance Update!

All RGSS-based versions have been upgraded recently!

To be honest with you, this version doesn't include any eye-catching feature at all.

It just allows you to call a couple of new methods for the KToggle::Manager and the KToggle::Cursor classes.
One of them is the new @manager.reset_cursor call, and yes, you can also manually set a specific position for the cursor to start at while launching or at any other moment.

I felt like it was a must to change the @manager.set_state method by adding an additional parameter so it should be called now just like this:

Code:

@manager.set_state(1, your_variable_here)
@manager.set_state(2, your_variable_here)

As you could see above, it begins with position 1 for convenience sake.
This also lets you alter that value via a script call at any given time.