Photoscenes - Revision history

Hannah: /* About the Photo_Scene_Parameter_Struct */

2023-03-03T03:49:57Z

About the Photo_Scene_Parameter_Struct

@@ Line 117: / Line 117: @@
 === About the Photo_Scene_Parameter_Struct ===
-The <code>Photo_Scene_Parameter_Struct</code>is the combination name/value pair setting that is used for all photoscene/preset save game values. It is used in the <code>Get Current Parameter Values</code> function and the <code>Load Parameter Values</code> function.
+Please see the main page on [[About Photoscene Blueprints#About the Photo Scene Parameter Struct]]
 === Using the Get Current Parameter Values function ===

Hannah at 03:42, 3 March 2023

2023-03-03T03:42:20Z

← Older revision		Revision as of 20:42, 2 March 2023
Line 24:		Line 24:
	== Create A New Blank Mod ==		== Create A New Blank Mod ==

	* Create a new Mod from the Blank Template [[File:UE4ModCreation_01.gif\|frameless]]<br />		* Create a new Mod from the Blank Template:
	* fill out the wizard and press Create Mod [[File:UE4ModCreation_02.gif\|frameless]]		* [[File:UE4ModCreation_01.gif\|frameless]]<br />
			* fill out the wizard and press Create Mod:
			* [[File:UE4ModCreation_02.gif\|frameless]]

	== Create a New Blank Level ==		== Create a New Blank Level ==
Line 75:		Line 77:

	* Add all your buttons and options under a parent Vertical Box		* Add all your buttons and options under a parent Vertical Box
	** your widget will appear under the <code>Level Settings</code> menu in the Photoscene, and as such do not have much horizontal space to work with. [[File:Wiki_Photoscene_Tips01.gif\|frameless\|300x300px]]		** your widget will appear under the <code>Level Settings</code> menu in the Photoscene, and as such do not have much horizontal space to work with.
			** [[File:Wiki_Photoscene_Tips01.gif\|frameless\|300x300px]]
	* There are a few preset buttons and sliders you can use that will make your life easier. These can be searched for and used from the Palette menu, but feel free to design your own. More info on the functionality of these widgets can be found on the [[About Photoscene Blueprints]] page:		* There are a few preset buttons and sliders you can use that will make your life easier. These can be searched for and used from the Palette menu, but feel free to design your own. More info on the functionality of these widgets can be found on the [[About Photoscene Blueprints]] page:
	** Slider_Photo_Manager		** Slider_Photo_Manager

Hannah at 03:41, 3 March 2023

2023-03-03T03:41:47Z

Hannah: /* About the Photo_Scene_Parameter_Struct */

2023-03-03T03:41:10Z

About the Photo_Scene_Parameter_Struct

← Older revision		Revision as of 20:41, 2 March 2023
Line 24:		Line 24:
	== Create A New Blank Mod ==		== Create A New Blank Mod ==

	* Create a new Mod from the Blank Template[[File:~~UE4ModCreation 01~~.gif\|~~none\|frame~~]]<br />		* Create a new Mod from the Blank Template [[index.php?title=File:UE4ModCreation_01.gif\|frameless]]<br />
	* fill out the wizard and press Create Mod[[File:~~UE4ModCreation 02~~.gif\|~~none\|thumb~~]]		* fill out the wizard and press Create Mod [[index.php?title=File:UE4ModCreation_02.gif\|frameless]]

	== Create a New Blank Level ==		== Create a New Blank Level ==
Line 38:		Line 38:

	=== Level Creation Guidelines ===		=== Level Creation Guidelines ===
	[[File:~~UE4ModCreation 24~~.gif\|~~none\|thumb~~]]		[[index.php?title=File:UE4ModCreation_24.gif\|frameless]]
	* when you set the car to 'snap to ground', a ray is cast from 6m above the car, to 2m below the car. the car is 'placed' on the first surface it collides with. Make sure any roofing or props in this range dont have collision enabled, or the car will mistake them for the ground.		* when you set the car to 'snap to ground', a ray is cast from 6m above the car, to 2m below the car. the car is 'placed' on the first surface it collides with. Make sure any roofing or props in this range dont have collision enabled, or the car will mistake them for the ground.
	* Search the '''content browser''' for <code>A Car Locator</code>.		* Search the '''content browser''' for <code>A Car Locator</code>.
Line 55:		Line 55:
	=== Creating a Photoscene Widget ===		=== Creating a Photoscene Widget ===
	From the <code>Content Browser</code>, add a Widget Blueprint to your mod folder.		From the <code>Content Browser</code>, add a Widget Blueprint to your mod folder.
	[[File:~~Wiki Photoscene CreateWidgetBP~~.jpg\|~~none\|thumb~~\|342x342px]]
			[[index.php?title=File:Wiki_Photoscene_CreateWidgetBP.jpg\|frameless\|342x342px]]

	Open the Widget, and from the <code>File</code> menu, select <code>Reparent Blueprint</code>.		Open the Widget, and from the <code>File</code> menu, select <code>Reparent Blueprint</code>.
	[[File:~~Wiki Photoscene ReparentWidgetBP01~~.jpg\|~~none\|thumb~~\|342x342px]]
			[[index.php?title=File:Wiki_Photoscene_ReparentWidgetBP01.jpg\|frameless\|342x342px]]

	In the menu that appears, find and select <code>Photo Scene Widget Base</code>.		In the menu that appears, find and select <code>Photo Scene Widget Base</code>.
	[[File:~~Wiki Photoscene ReparentWidgetBP02~~.png\|~~none\|thumb~~\|290x290px]]
			[[index.php?title=File:Wiki_Photoscene_ReparentWidgetBP02.png\|frameless\|290x290px]]

	From the Hierarchy window, delete the <code>Canvas Panel</code>.		From the Hierarchy window, delete the <code>Canvas Panel</code>.
	[[File:~~Wiki Photoscene DeleteCanvas~~.png\|~~none\|thumb~~\|300x300px]]
			[[index.php?title=File:Wiki_Photoscene_DeleteCanvas.png\|frameless\|300x300px]]

	You are now free to design the buttons, sliders, and drop-down menus, etc... to your heart's content!		You are now free to design the buttons, sliders, and drop-down menus, etc... to your heart's content!

Line 67:		Line 75:

	* Add all your buttons and options under a parent Vertical Box		* Add all your buttons and options under a parent Vertical Box
	** your widget will appear under the <code>Level Settings</code> menu in the Photoscene, and as such do not have much horizontal space to work with.[[File:~~Wiki Photoscene Tips01~~.gif\|~~none\|thumb~~\|300x300px]]		** your widget will appear under the <code>Level Settings</code> menu in the Photoscene, and as such do not have much horizontal space to work with. [[index.php?title=File:Wiki_Photoscene_Tips01.gif\|frameless\|300x300px]]
	* There are a few preset buttons and sliders you can use that will make your life easier. These can be searched for and used from the Palette menu, but feel free to design your own. More info on the functionality of these widgets can be found on the [[About Photoscene Blueprints]] page:		* There are a few preset buttons and sliders you can use that will make your life easier. These can be searched for and used from the Palette menu, but feel free to design your own. More info on the functionality of these widgets can be found on the [[About Photoscene Blueprints]] page:
	** Slider_Photo_Manager		** Slider_Photo_Manager
Line 78:		Line 86:

	From the 'Graph' view, hover over the <code>Functions</code> menu, and select <code>Override</code>.		From the 'Graph' view, hover over the <code>Functions</code> menu, and select <code>Override</code>.
	[[File:~~Wiki Photoscene FunctionsOverride~~.png\|~~none\|thumb~~\|433x433px~~\|Note that most of the ones with 'User Widget' listed on the right are irrelevant. we only need to focus on the ones with 'Photo Scene Widget Base' as the parent~~]]
			[[index.php?title=File:Wiki_Photoscene_FunctionsOverride.png\|frameless\|433x433px]]

	Don't worry if these are overwhelming you, they will be explained more in-depth later.		Don't worry if these are overwhelming you, they will be explained more in-depth later.

Line 120:		Line 130:

	For each setting your photoscene widget can change, you should use one <code>Photo_Scene_Parameter_Struct</code>.		For each setting your photoscene widget can change, you should use one <code>Photo_Scene_Parameter_Struct</code>.
	[[File:~~Wiki Photoscene AboutThePhotoSceneParameterStruct01~~.png\|~~none\|thumb~~\|300x300px]]
			[[index.php?title=File:Wiki_Photoscene_AboutThePhotoSceneParameterStruct01.png\|frameless\|300x300px]]

	=== Using the Get Current Parameter Values function ===		=== Using the Get Current Parameter Values function ===
Line 128:		Line 139:

	You should use the <code>Make Array</code> node to input into the <code>return</code> node, with a number of <code>array elements</code> equal to the number of settings in your photoscene widget. Each <code>array element</code> should itself be wired to a <code>Make Photo_Scene_Parameter_Struct</code> node, with the <code>Parameter Name</code>, <code>Data Type</code>, and selected <code>data type</code> <code>Value</code> set.		You should use the <code>Make Array</code> node to input into the <code>return</code> node, with a number of <code>array elements</code> equal to the number of settings in your photoscene widget. Each <code>array element</code> should itself be wired to a <code>Make Photo_Scene_Parameter_Struct</code> node, with the <code>Parameter Name</code>, <code>Data Type</code>, and selected <code>data type</code> <code>Value</code> set.
	[[File:~~Wiki Photoscene UsingGetCurrentParameterValues01~~.png\|~~none\|thumb~~\|300x300px]]
			[[index.php?title=File:Wiki_Photoscene_UsingGetCurrentParameterValues01.png\|frameless\|300x300px]]

	=== Using the Level Finished Loading function ===		=== Using the Level Finished Loading function ===
Line 143:		Line 155:
	# if the <code>value</code> is found,		# if the <code>value</code> is found,
	# apply it to whatever logic you use that value for.		# apply it to whatever logic you use that value for.
			[[index.php?title=File:Wiki_Photoscene_loadparametervalues01.png\|frameless\|300x300px]]

	~~[[File:Wiki Photoscene loadparametervalues01.png\|none\|thumb\|300x300px]]~~
	Remember that the value you are <code>find</code>ing has to be the same as the value you set for each setting in <code>Get Current Parameter Values</code>.		Remember that the value you are <code>find</code>ing has to be the same as the value you set for each setting in <code>Get Current Parameter Values</code>.

Hannah: /* Quick Tips: */

2023-03-01T03:37:35Z

Quick Tips:

← Older revision		Revision as of 20:37, 28 February 2023
Line 68:		Line 68:
	* Add all your buttons and options under a parent Vertical Box		* Add all your buttons and options under a parent Vertical Box
	** your widget will appear under the <code>Level Settings</code> menu in the Photoscene, and as such do not have much horizontal space to work with.[[File:Wiki Photoscene Tips01.gif\|none\|thumb\|300x300px]]		** your widget will appear under the <code>Level Settings</code> menu in the Photoscene, and as such do not have much horizontal space to work with.[[File:Wiki Photoscene Tips01.gif\|none\|thumb\|300x300px]]
	* There are a few preset buttons and sliders you can use that will make your life easier. These can be searched for and used from the Palette menu, but feel free to design your own. More info on the functionality of these widgets can be found on the [[About Photoscene ~~Widgets~~]] page:		* There are a few preset buttons and sliders you can use that will make your life easier. These can be searched for and used from the Palette menu, but feel free to design your own. More info on the functionality of these widgets can be found on the [[About Photoscene Blueprints]] page:
	** Slider_Photo_Manager		** Slider_Photo_Manager
	** UW_DropDown_Photoscene		** UW_DropDown_Photoscene

Hannah: /* Using The Slider_Photo_Manager */

2023-03-01T03:31:01Z

Using The Slider_Photo_Manager

@@ Line 68: / Line 68: @@
 * Add all your buttons and options under a parent Vertical Box
 ** your widget will appear under the <code>Level Settings</code> menu in the Photoscene, and as such do not have much horizontal space to work with.[[File:Wiki Photoscene Tips01.gif|none|thumb|300x300px]]
-* There are a few preset buttons and sliders you can use that will make your life easier. These can be searched for and used from the Palette menu, but feel free to design your own:
+* There are a few preset buttons and sliders you can use that will make your life easier. These can be searched for and used from the Palette menu, but feel free to design your own. More info on the functionality of these widgets can be found on the [[About Photoscene Widgets]] page:
 ** Slider_Photo_Manager
 ** UW_DropDown_Photoscene
 ** Photoscene_Checkbox_UW
 ** UW_TextBox_Photoscene
 == Widget Functionality ==

Hannah at 00:01, 22 November 2021

2021-11-22T00:01:30Z

← Older revision		Revision as of 17:01, 21 November 2021
Line 1:		Line 1:
	Photoscene support was added 25th October 2017		Photoscene support was added 25th October 2017.

			Beginning with LCv4.2, Automation supports player-customizable options for individual photoscenes.

	There is an example photoscene mod included in the sdk. open it to see how it works. It is also available on the Steam Workshop as a mod.		There is an example photoscene mod included in the sdk. open it to see how it works. It is also available on the Steam Workshop as a mod.

Hannah: /* Level Creation Guidelines */

2021-11-21T23:54:51Z

Level Creation Guidelines

← Older revision		Revision as of 16:54, 21 November 2021
Line 37:		Line 37:
	=== Level Creation Guidelines ===		=== Level Creation Guidelines ===
	[[File:UE4ModCreation 24.gif\|none\|thumb]]		[[File:UE4ModCreation 24.gif\|none\|thumb]]
	* ~~The cars in-game check collision geometry~~ 6m above the car ~~and~~ 2m below ~~it for placing~~ on the ~~ground~~. Make sure any roofing or props in this range dont have collision enabled, or ~~you're going to have a bad time trying to move~~ the car in the ~~photoscene~~.		* when you set the car to 'snap to ground', a ray is cast from 6m above the car, to 2m below the car. the car is 'placed' on the first surface it collides with. Make sure any roofing or props in this range dont have collision enabled, or the car will mistake them for the ground.
	* Search the '''content browser''' for <code>A Car Locator</code>.		* Search the '''content browser''' for <code>A Car Locator</code>.
	**These are the bookmarks for sub-level positions.		**These are the bookmarks for sub-level positions.

Hannah: /* Using the Ray Tracing Settings Updated function */

2021-11-21T23:35:58Z

Using the Ray Tracing Settings Updated function

@@ Line 7: / Line 7: @@
 # create a mod
 # create and design a level
-# create and fill out a Photoscene Level Preview file.
+# (Optional) Create a photoscene Widget for player-customization
 ## create Thumbnail(s)
 # Share your mod
 == Create A New Blank Mod ==
-* Create a new Mod from the Blank Template[[File:UE4ModCreation 01.gif|none|thumb]]<br />
+* Create a new Mod from the Blank Template[[File:UE4ModCreation 01.gif|none|frame]]<br />
 * fill out the wizard and press Create Mod[[File:UE4ModCreation 02.gif|none|thumb]]
@@ Line 29: / Line 37: @@
 === Level Creation Guidelines ===
 [[File:UE4ModCreation 24.gif|none|thumb]]
-* The cars in-game check collisiongeometry 6m above the car and 2m below it for placing on the ground. Make sure any roofing or props in this range dont have collision enabled, or you're going to have a bad time trying to move the car in the photoscene.
+* The cars in-game check collision geometry 6m above the car and 2m below it for placing on the ground. Make sure any roofing or props in this range dont have collision enabled, or you're going to have a bad time trying to move the car in the photoscene.
 * Search the '''content browser''' for <code>A Car Locator</code>.
 **These are the bookmarks for sub-level positions.
@@ Line 224: / Line 232: @@
 === Using the Ray Tracing Settings Updated function ===
 == Share Your Mod. ==
 Go to the [[Modding]] page to see how to share your mod.

Hannah at 21:16, 21 November 2021

2021-11-21T21:16:54Z

@@ Line 171: / Line 171: @@
 ** Is called when the Photoscene is loading your level from a preset.
 ** Paths in an array of <code>Photo_Scene_Parameter_Struct</code> values.
-** This should be used to initialise your UI values, and apply their related settings to your level.
+** This should be used to initialize your UI values, and apply their related settings to your level.
 * On Initialized:
 ** Should be ignored, as it is an internal function.
-* Ray Tracing Settings Updated
+* Ray Tracing Settings Updated:
 ** Is a helper function designed to call whenever a ray-tracing setting related to reflections, refraction, or shadows, is adjusted.
 ** It Paths in a boolean that is True if any RT shadow, reflection, or translucency setting is enabled.
 ** If you need further functionality for switching things when ray-tracing is on, please refer to the <code>Check If Ray Tracing Updated</code> function.
 == Share Your Mod. ==
 Go to the [[Modding]] page to see how to share your mod.