About Photoscene Blueprints

From Automation Game Wiki
Revision as of 19:30, 28 February 2023 by Hannah (talk | contribs) (Created page with "====Using The Slider_Photo_Manager==== The <code>Slider_Photo_Manager</code> is a slider with a title text, plus and minus buttons, and a text box for the current value which can be set and overridden by the player. It has a <code>Value Changed</code> event that is called whenever the player changes the value of the slider, and this event should be utilized for setting your Photoscene settings. The <code>Value Changed</code> event returns a <code>float</code> value. T...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Using The Slider_Photo_Manager

The Slider_Photo_Manager is a slider with a title text, plus and minus buttons, and a text box for the current value which can be set and overridden by the player.

It has a Value Changed event that is called whenever the player changes the value of the slider, and this event should be utilized for setting your Photoscene settings.

The Value Changed event returns a float value.

The Slider_Photo_Manager has a few settings of note:

  • Min Value:
    • Defines the minimum number that the slider can naturally reach.
    • Can be overridden using the text box by the player.
    • Default is 0.
  • Max Value:
    • Defines the maximum number that the slider can naturally reach.
    • Can be overridden using the text box by the player.
    • Default is 1.
  • Sig Figs:
    • Defines the number of significant figures that will be displayed in the text box.
    • Default is 3.
  • Step Count:
    • Defines the number of steps that are available in the slider.
    • Default is 100.
    • Useful when the slider range is massive, and you dont want the player to have to scrub through all values you may have available.
    • For instance: if your slider has a min range of 0, and a max of 500, it may take the player a long time to incriment the value with their scroll wheel or using the +/- buttons, so setting a step count of 10 will mean that the player only has to press '+' 10 times to get from 0 to 500.
  • Title Text:
    • The text to display next to the slider. Useful for telling the player what this slider does.
    • Default is empty/no text.
  • Display Whole Numbers Only:
    • Is a boolean, default is False.
    • When True, ignores the Sig Figs value only when the number of significant integers is less than the number of significant figures.
    • Will only display integer values, and ignores any fractional values the slider may have set.
    • For instance, if you have a slider with a min of 0, a max of 3, and 30 steps, it is possible for the player to get any single-digit fraction of each integer (0, 0.1, 0.2, 0.3......... 1, 1.1, 1.2, 1.3....... 2, 2.1, 2.2, 2.3..... etc), and while you may want this functionality, you may not want to display that fractional value. Enabling this setting will mean that while the player can set the slider to 4.6, say, the slider will display that the value is 4, despite the actual value being 4.6.

Using The UW_DropDown_Photoscene

The UW_DropDown_Photoscene is a drop-down menu, with a title text, and a variable number of list options.

It has a Value Changed event that is called whenever the player changes the selected option. It returns a String value and an Integer Index value when called. The String value is the string text of the selected option, while the Index integer is the position of the currently selected string value in the array/list.

Remember that arrays start at 0. For example: a drop-down with four values, say, one on, one off, both on, both off, will have selected integers of 0,1,2,3, respectively. If the player Selects one off, the Value Changed event will return a string value of one off, and an index of 1.

The UW_DropDown_Photoscene has a few settings of note:

  • Title Text:
    • The text to display next to the drop-down. Useful for telling the player what the drop-down does.
    • Default is empty/no text.
  • Options:
    • The number and names of the options available in the drop-down.
    • You can have as many or as few as you want.
    • Default is empty/no values.
  • Selected Option:
    • The string value of the default selected option for this drop-down.
    • Should be identical to one of the Options list items.
    • Default is empty/no value.

Using The Photoscene_CheckBox_UW

The Photoscene_CheckBox_UW is a tickbox/checkbox/disabled+enabled buttons.

It has a Value Changed event that is called whenever the player changes the setting. It returns a boolean which is True when the value is ticked/enabled/true, and returns False when the value is un-ticked/disabled/false.

It has a few settings of note:

  • Title Text:
    • The text to display next to the setting. Useful for telling the player what the setting does.
    • Default is empty/no text.
  • Default Value:
    • Is a boolean. Sets the default value of this setting.
    • Default is un-ticked/disabled/false.
  • Use Buttons:
    • Is a boolean. Switches the widget between the default disabled/enabled buttons, and a small check box with a disabled/enabled text. Useful for some things.
    • Default is un-ticked/disabled/false.

Using The UW_TextBox_Photoscene

The UW_TextBox_Photoscene is a simple text box.

It has a Text Updated event that is called whenever the text changes from player input. It returns a String text which is the value of the text box.

It has a few settings of note:

  • Text:
    • Is the default text to display in the text box.
    • Default is none/no text.
  • Title Text:
    • The text to display next to the setting. Useful for telling the player what the setting does.
    • Default is empty/no text.