.. Automatically generated file - do not modify.

.. function:: Preference(name, value=None, range=None)
    
    This constructs the appropriate action or value from a preference.
    The preference name should be the name given in the standard
    menus, while the value should be either the name of a choice,
    "toggle" to cycle through choices, a specific value, or left off
    in the case of buttons.
    
    Actions that can be used with buttons and hotspots are:
    
    * Preference("display", "fullscreen") - displays in fullscreen mode.
    * Preference("display", "window") - displays in windowed mode at 1x normal size.
    * Preference("display", 2.0) - displays in windowed mode at 2.0x normal size.
    * Preference("display", "any window") - displays in windowed mode at the previous size.
    * Preference("display", "toggle") - toggle display mode.
    
    * Preference("transitions", "all") - show all transitions.
    * Preference("transitions", "none") - do not show transitions.
    * Preference("transitions", "toggle") - toggle transitions.
    
    * Preference("video sprites", "show") - show all video sprites.
    * Preference("video sprites", "hide") - fall back to images where possible.
    * Preference("video sprites", "toggle") - toggle image fallback behavior.
    
    * Preference("show empty window", "show") - Allow the "window show" and "window auto" statement to show an empty window outside of the say statement.
    * Preference("show empty window", "hide") - Prevent the above.
    * Preference("show empty window", "toggle") - Toggle the above.
    
    * Preference("text speed", 0) - make text appear instantaneously.
    * Preference("text speed", 142) - set text speed to 142 characters per second.
    
    * Preference("joystick") - Show the joystick preferences.
    
    * Preference("skip", "seen") - Only skip seen messages.
    * Preference("skip", "all") - Skip unseen messages.
    * Preference("skip", "toggle") - Toggle between skip seen and skip all.
    
    * Preference("begin skipping") - Starts skipping.
    
    * Preference("after choices", "skip") - Skip after choices.
    * Preference("after choices", "stop") - Stop skipping after choices.
    * Preference("after choices", "toggle") - Toggle skipping after choices.
    
    * Preference("auto-forward time", 0) - Set the auto-forward time to infinite.
    * Preference("auto-forward time", 10) - Set the auto-forward time (unit is seconds per 250 characters).
    
    * Preference("auto-forward", "enable") - Enable auto-forward mode.
    * Preference("auto-forward", "disable") - Disable auto-forward mode.
    * Preference("auto-forward", "toggle") - Toggle auto-forward mode.
    
    * Preference("auto-forward after click", "enable") - Remain in auto-forward mode after a click.
    * Preference("auto-forward after click", "disable") - Disable auto-forward mode after a click.
    * Preference("auto-forward after click", "toggle") - Toggle auto-forward after click.
    
    * Preference("automatic move", "enable") - Enable automatic mouse mode.
    * Preference("automatic move", "disable") - Disable automatic mouse mode.
    * Preference("automatic move", "toggle") - Toggle automatic mouse mode.
    
    * Preference("wait for voice", "enable")  - Wait for the currently playing voice to complete before auto-forwarding.
    * Preference("wait for voice", "disable") - Do not wait for the currently playing voice to complete before auto-forwarding.
    * Preference("wait for voice", "toggle")  - Toggle wait voice.
    
    * Preference("voice sustain", "enable")  - Sustain voice past the current interaction.
    * Preference("voice sustain", "disable") - Don't sustain voice past the current interaction.
    * Preference("voice sustain", "toggle")  - Toggle voice sustain.
    
    * Preference("music mute", "enable") - Mute the music mixer.
    * Preference("music mute", "disable") - Un-mute the music mixer.
    * Preference("music mute", "toggle") - Toggle music mute.
    
    * Preference("sound mute", "enable") - Mute the sound mixer.
    * Preference("sound mute", "disable") - Un-mute the sound mixer.
    * Preference("sound mute", "toggle") - Toggle sound mute.
    
    * Preference("voice mute", "enable") - Mute the voice mixer.
    * Preference("voice mute", "disable") - Un-mute the voice mixer.
    * Preference("voice mute", "toggle") - Toggle voice mute.
    
    * Preference("mixer <mixer> mute", "enable") - Mute the specified mixer.
    * Preference("mixer <mixer> mute", "disable") - Unmute the specified mixer.
    * Preference("mixer <mixer> mute", "toggle") - Toggle mute of specified mixer.
    
    * Preference("all mute", "enable") - Mute all mixers.
    * Preference("all mute", "disable") - Unmute all mixers.
    * Preference("all mute", "toggle") - Toggle mute of all mixers.
    
    * Preference("music volume", 0.5) - Set the music volume.
    * Preference("sound volume", 0.5) - Set the sound volume.
    * Preference("voice volume", 0.5) - Set the voice volume.
    * Preference("mixer <mixer> volume", 0.5) - Set the specified mixer volume.
    
    * Preference("emphasize audio", "enable") - Emphasize the audio channels found in :var:`config.emphasize_audio_channels`.
    * Preference("emphasize audio", "disable") - Do not emphasize audio channels.
    * Preference("emphasize audio", "toggle") - Toggle emphasize audio.
    
    * Preference("self voicing", "enable") - Enables self-voicing.
    * Preference("self voicing", "disable") - Disable self-voicing.
    * Preference("self voicing", "toggle") - Toggles self-voicing.
    
    * Preference("clipboard voicing", "enable") - Enables clipboard-voicing.
    * Preference("clipboard voicing", "disable") - Disable clipboard-voicing.
    * Preference("clipboard voicing", "toggle") - Toggles clipboard-voicing.
    
    * Preference("debug voicing", "enable") - Enables self.-voicing debug
    * Preference("debug voicing", "disable") - Disable self-voicing debug.
    * Preference("debug voicing", "toggle") - Toggles self-voicing debug.
    
    * Preference("rollback side", "left") - Touching the left side of the screen causes rollback.
    * Preference("rollback side", "right") - Touching the right side of the screen causes rollback.
    * Preference("rollback side", "disable") - Touching the screen will not cause rollback.
    
    Values that can be used with bars are:
    
    * Preference("text speed")
    * Preference("auto-forward time")
    * Preference("music volume")
    * Preference("sound volume")
    * Preference("voice volume")
    * Preference("mixer <mixer> volume")
    
    The `range` parameter can be given to give the range of certain bars.
    For "text speed", it defaults to 200 cps. For "auto-forward time", it
    defaults to 30.0 seconds per chunk of text. (These are maximums, not
    defaults.)

