How to add an option to preferences?

[luminarious]

Un question, gentlemen. It has often been discussed as to wether sex scenes could somehow be avoided, for example if a 15-year-old wants to play a game with a story otherwise suitable for her/him. I do not know wether I will actually need it with my game, but nevertheless I'd like to know how to add an option "Adult scenes on/ off" to the preferences screen?

It would simply set a variable to true or false. And at the start of any possibly adult scene I would simply check for it. If adult_scenes is false, a milder alternative could be shown instead, or even just skipped. It's probably better if the preference was set to False by default, probably..

[PyTom]

It would simply set a variable to true or false. And at the start of any possibly adult scene I would simply check for it. If adult_scenes is false, a milder alternative could be shown instead, or even just skipped. It's probably better if the preference was set to False by default, probably..

Code: Select all

init python:

    # Set the default value.
    if persistent.hentai is None:
        persistent.hentai = False

    # Add the pref.
    config.preferences['prefs_left'].append(
        _Preference(
            "Hentai",
            "hentai",
            [ ("Enabled", True, "True"),
              ("Disabled", False, "True") ],
            base=persistent))

Then when it comes time for a hentai scene:

Code: Select all

if persistent.hentai:
    # Let's get it on.
else:
    # Holding hands is more than enough.

[luminarious]

Thank you very much. I'll add it to the cookbook as well..

[EvilDragon]

How to define the same thing with a toggle button? In fact, how is a toggle button done anyways?

[luminarious]

What do you mean by a toggle button?

[EvilDragon]

Meaning a single button that changes state when pressed.

This preference (as PyTom defined it) is a multi-button - meaning there are as many buttons as there are options for a preference (here, that's 2). A toggle button would be only a single button that changes it's text (or image, if it's an imagebutton) depending on the state of the preference: like in "Preference ON"/"Preference OFF".

[delta]

Ren'Py does not have this functionality. I wanted it, so I wrote my own (well, more like duplicated and slightly adjusted the existing preferences class). This won't work for your game as is, because it uses my own presentation shortcut functions and ties into other engine hacks of mine, but maybe you can adapt it. Also, I won't walk you through the steps to get it working, sorry.

Code: Select all

    class TogglePreference(object):
        """
        This is a class that's used to represent a 2-choice preference.
        For the original documentation, see the class _Preference in 00preferences.rpy
        """
        def __init__(self, name, field, boolmap=(False,True), base=_preferences):
            # boolmap maps properties that actually have more values internally to "False" and "True"

            self.name = name
            self.field = field
            self.values = []
            self.boolmap = boolmap
            self.base = base

            config.all_preferences[name] = self

        def render_preference(self, thisxpos=0, thisypos=0):
            cur = getattr(self.base, self.field)

            # this uses a hardcoded widget. Leave out the definition of checkboximage if you want to do it differently
            if cur == self.boolmap[0]:
                boolCur = False
                checkboximage = "ui/bt-cf-unchecked.png"
            elif cur == self.boolmap[1]:
                boolCur = True
                checkboximage = "ui/bt-cf-checked.png"
            else:
                boolCur = cur
                checkboximage = "ui/bt-cf-unchecked.png"

            def clicked(value=boolCur):
                if value == True:
                    writevalue = self.boolmap[0]
                elif value == False:
                    writevalue = self.boolmap[1]
                else:
                    writevalue = value # just making safe we don't mess up TOO much

                setattr(self.base, self.field, writevalue)
                return True

            # This is a custom display function that incorporates the checkboximage into a button. Use some ui code of your own here.
            widget_button(self.name, checkboximage, clicked, xsize=325, widgetyoffset=0)

And then, later, for example...

Code: Select all

# displayStrings is an object that contains all my UI text. You can replace it with string literals
        fullscreen_p = TogglePreference(displayStrings.config_fullscreen_label, 'fullscreen')
        transition_p = TogglePreference(displayStrings.config_transitions_label, 'transitions', (2,0)) # "1" would actually be the "some" state we don't use
        unreadskip_p = TogglePreference(displayStrings.config_skip_unseen_label, 'skip_unseen')
        choiceskip_p = TogglePreference(displayStrings.config_skip_after_choice_label, 'skip_after_choices')

and then, in the right spot on your preferences page...

Code: Select all

        fullscreen_p.render_preference()
        transition_p.render_preference()
        unreadskip_p.render_preference()
        choiceskip_p.render_preference()

[EvilDragon]

How come there is no toggle button functionality? Why is then the "check button" in Theme test (Developer mode) exhibiting the exact toggle action that I'm asking for?

[luminarious]

I had never actually used it, hence my ignorance..
Code for the check button is apparently:

Code: Select all

ui.textbutton("Check Button", size_group=sg, clicked=ui.returns("toggle"), role=role(toggle_var), style='check_button')

Appropriate Wiki page - http://www.renpy.org/wiki/ui.textbutton - doesn't, however, mention this kind of role..

[PyTom]

The check button mode is a work in progress. It exists in the style system, but hasn't been set up in preferences yet.

[EvilDragon]

I had never actually used it, hence my ignorance..
Code for the check button is apparently:

Code: Select all

ui.textbutton("Check Button", size_group=sg, clicked=ui.returns("toggle"), role=role(toggle_var), style='check_button')

Appropriate Wiki page - http://www.renpy.org/wiki/ui.textbutton - doesn't, however, mention this kind of role..

That's because toggle_var is later below tested to determine the right course of action after ui.interact().

[Gear]

It would simply set a variable to true or false. And at the start of any possibly adult scene I would simply check for it. If adult_scenes is false, a milder alternative could be shown instead, or even just skipped. It's probably better if the preference was set to False by default, probably..

Code: Select all

init python:

    # Set the default value.
    if persistent.hentai is None:
        persistent.hentai = False

    # Add the pref.
    config.preferences['prefs_left'].append(
        _Preference(
            "Hentai",
            "hentai",
            [ ("Enabled", True, "True"),
              ("Disabled", False, "True") ],
            base=persistent))

Then when it comes time for a hentai scene:

Code: Select all

if persistent.hentai:
    # Let's get it on.
else:
    # Holding hands is more than enough.

This might be a dumb question, but WHERE do you post the code (former, not latter). I keep getting errors it seems, no matter where I try and put it.

[Aleema]

^ That's because if you're using the newer Ren'Py, this is outdated. To add things to the preference screen, you manually add the button in screens.rpy.

[017Bluefield]

So, is there a way to make custom Preference()s with Ren'Py now that it's in version 7? Or has this gone by the wayside for now?

[martingerdes]

I can answer this one!

In screens.rpy, look for "screen preferences():"
That is the screen which builds up the options you can configure as a player.

In there you find the comment

## Additional vboxes of type "radio_pref" or "check_pref" can be
## added here, to add additional creator-defined preferences.

So directly below that, you can add something like:

Code: Select all

vbox:
  style_prefix "check"
  label _("Stuff to avoid")
  textbutton _("Sex") action ToggleField(persistent,"avoid_sex")

Then just initialize the choices in your own code:

Code: Select all

#Avoid stuff?
define persistent.avoid_sex = False

You should be able to adapt this as needed.

PS: To answer the question more literally: since the screen is defined normally instead of being auto generated from an array, you won't be able to just append a new entry to an array and have that show up in the preferences. Unless you first code that into the screen (looping over the array and generating textbuttons in a vbox).