About Photoscene Blueprints - Revision history

Hannah at 03:45, 3 March 2023

2023-03-03T03:45:24Z

@@ Line 1: / Line 1: @@
 == Using the Photoscene Widgets ==
-[[File:ThePhotosceneSlider.jpg|thumb]]
+There are many pre-made widgets that you can use which will help you make photoscene widgets easier. They are as follows:[[File:ThePhotosceneSlider.jpg|thumb]]
 === Using The Photoscene_Slider_UW ===

Hannah: /* Using The UW_DropDown_Photoscene */

2023-03-03T03:37:58Z

Using The UW_DropDown_Photoscene

@@ Line 50: / Line 50: @@
 [[File:PhotosceneSliderSetValue.jpg|frameless]]
 === Using The UW_DropDown_Photoscene ===
@@ Line 58: / Line 59: @@
 Remember that arrays start at 0. For example: a drop-down with four values, say, <code>one on, one off, both on, both off</code>, will have selected integers of <code>0,1,2,3</code>, respectively. If the player Selects <code>one off</code>, the <code>Value Changed</code> event will return a <code>string</code> value of <code>one off</code>, and an <code>index</code> of <code>1</code>.
 The <code>UW_DropDown_Photoscene</code> 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.
+**Default is <code>Title Text</code>.
 *Options:
 **The number and names of the options available in the drop-down.
@@ Line 70: / Line 72: @@
 **Should be identical to one of the <code>Options</code> list items.
 **Default is empty/no value.
 === Using The Photoscene_CheckBox_UW ===
@@ Line 76: / Line 94: @@
 It has a <code>Value Changed</code> event that is called whenever the player changes the setting. It returns a boolean which is <code>True</code> when the value is ticked/enabled/true, and returns <code>False</code> when the value is un-ticked/disabled/false.
 It has a few settings of note:
 *Title Text:
@@ Line 86: / Line 105: @@
 **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 ===
@@ Line 92: / Line 127: @@
 It has a <code>Text Updated</code> event that is called whenever the text changes from player input. It returns a <code>String</code> text which is the value of the text box.
 It has a few settings of note:
 *Text:
@@ Line 99: / Line 135: @@
 **The text to display next to the setting. Useful for telling the player what the setting does.
 **Default is empty/no text.
 === Using The Photoscene_ColourPickerAdvanced_UW ===
@@ Line 105: / Line 157: @@
 It has a <code>Colour Updated</code> event that is called whenever the player changes the colour setting. The Colour Updated event returns two values: A <code>Colour</code> value, which represents the colour that the player has currently selected, and a <code>Temporary Change</code> boolean, which should be left unused unless you wish to enable <code>Advanced View</code>, in which case this value represents whenever the value is temporarily set to default via the <code>Enable</code> tickbox.
 It has a few settings of note:
@@ Line 143: / Line 196: @@
 ** This is the value that affects how much the title text is shrunk by, as used by <code>Num Indents</code>.
 ** The default value is 42.

Hannah at 03:02, 3 March 2023

2023-03-03T03:02:02Z

@@ Line 1: / Line 1: @@
-====Using The Slider_Photo_Manager====
+== Using the Photoscene Widgets ==
 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.
@@ Line 6: / Line 9: @@
 The <code>Value Changed</code> event returns a <code>float</code> value.
 The <code>Slider_Photo_Manager</code> has a few settings of note:
 *Min Value:
@@ Line 31: / Line 35: @@
 **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 <code>UW_DropDown_Photoscene</code> is a drop-down menu, with a title text, and a variable number of list options.
@@ Line 50: / Line 70: @@
 **Should be identical to one of the <code>Options</code> list items.
 **Default is empty/no value.
-====Using The Photoscene_CheckBox_UW====
 The <code>Photoscene_CheckBox_UW</code> is a tickbox/checkbox/disabled+enabled buttons.
@@ Line 65: / Line 86: @@
 **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 <code>UW_TextBox_Photoscene</code> is a simple text box.
@@ Line 77: / Line 99: @@
 **The text to display next to the setting. Useful for telling the player what the setting does.
 **Default is empty/no text.

Hannah: Created page with "====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. T..."

2023-03-01T03:30:56Z

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..."

New page

====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.

The <code>Slider_Photo_Manager</code> 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 <code>Sig Figs</code> 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 <code>UW_DropDown_Photoscene</code> is a drop-down menu, with a title text, and a variable number of list options.

It has a <code>Value Changed</code> event that is called whenever the player changes the selected option. It returns a <code>String</code> value and an <code>Integer</code> Index value when called. The <code>String</code> value is the string text of the selected option, while the <code>Index</code> 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, <code>one on, one off, both on, both off</code>, will have selected integers of <code>0,1,2,3</code>, respectively. If the player Selects <code>one off</code>, the <code>Value Changed</code> event will return a <code>string</code> value of <code>one off</code>, and an <code>index</code> of <code>1</code>.

The <code>UW_DropDown_Photoscene</code> 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 <code>Options</code> list items.
**Default is empty/no value.
====Using The Photoscene_CheckBox_UW====
The <code>Photoscene_CheckBox_UW</code> is a tickbox/checkbox/disabled+enabled buttons.

It has a <code>Value Changed</code> event that is called whenever the player changes the setting. It returns a boolean which is <code>True</code> when the value is ticked/enabled/true, and returns <code>False</code> 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 <code>UW_TextBox_Photoscene</code> is a simple text box.

It has a <code>Text Updated</code> event that is called whenever the text changes from player input. It returns a <code>String</code> 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.