Prop Mods - Revision history

Hannah: /* Creating a Prop Blueprint */

2023-03-08T01:37:51Z

Creating a Prop Blueprint

← Older revision		Revision as of 18:37, 7 March 2023
Line 37:		Line 37:
	A Prop Blueprint contains all of the visuals and functionality of your prop. It can be as simple or as complex as you like.		A Prop Blueprint contains all of the visuals and functionality of your prop. It can be as simple or as complex as you like.

	The Prop Blueprint is a child of Photoscene_Prop_Parent_Class.		The Prop Blueprint is a child of <code>Photoscene_Prop_Parent_Class</code>.

	To Create your Prop Blueprint:		To Create your Prop Blueprint:

Hannah: /* Creating a Prop Widget Blueprint */

2023-03-02T04:10:17Z

Creating a Prop Widget Blueprint

← Older revision		Revision as of 21:10, 1 March 2023
Line 78:		Line 78:
	Prop widgets are derived from the parent class <code>Photoscene_Prop_Parent_Widget</code>.		Prop widgets are derived from the parent class <code>Photoscene_Prop_Parent_Widget</code>.

			=== Using Prop Widget Functions ===
	Just like the Prop Blueprint, the prop widget has functions. Some of these functions are mandatory for full functionality:		Just like the Prop Blueprint, the prop widget has functions. Some of these functions are mandatory for full functionality:
	[[File:OverridePropWidgetFunctions.jpg\|thumb]]		[[File:OverridePropWidgetFunctions.jpg\|thumb]]
Line 105:		Line 106:
	** If you have any effect that you do not wish to be included in photos, use this event to turn them off, or vice versa.		** If you have any effect that you do not wish to be included in photos, use this event to turn them off, or vice versa.
	* RT Updated		* RT Updated
			** This function is called whenever the ray-tracing settings change. Because UE4's ray-tracing support is super janky, many things need to change based on what those ray-tracing settings are. This function allows you to change a prop's effects based on the ray-tracing settings.
	* Set Prop Reference		* Set Prop Reference
			** This function is called when the prop is first spawned. The prop spawning logic calls this function after creating the widget and the prop bp, and passes through a reference to the prop using the prop's parent class.
			** You can save a reference to your prop BP using this function, by casting to your specific prop class and saving that as a variable in the widget.

			=== Creating Your Prop Widget ===
			Please refer to the page [[About Photoscene Blueprints]].

	== Simple Prop Setup ==		== Simple Prop Setup ==

Hannah: /* Creating a Prop Widget Blueprint */

2023-03-01T04:36:06Z

Creating a Prop Widget Blueprint

← Older revision		Revision as of 21:36, 28 February 2023
Line 93:		Line 93:
	** This function is called whenever a preset that contains this prop is loaded.		** This function is called whenever a preset that contains this prop is loaded.
	** When the preset loads the prop, it calls this function to load whatever prop settings were saved at the time.		** When the preset loads the prop, it calls this function to load whatever prop settings were saved at the time.
	** If you want your prop to work with presets, you must use this function in conjunction with the Get Current Photoscene Prop Parameters function.		** If you want your prop to work with presets, you must use this function in conjunction with the <code>Get Current Photoscene Prop Parameters</code> function.
			** To get a setting out of the <code>Parameters</code> map, <code>Find</code> the name you gave the key-value pair in <code>Get Current Photoscene Prop Parameters</code>, and <code>If</code> it is found, call the corresponding functions to apply that setting.
	* Post-Screenshot		* Post-Screenshot
			** This event is called just after a photo is taken in the photoscene.
			** If you have anything set to turn on or off during a photo, this event happens right after the photo is taken.
	* Pre-Destruct		* Pre-Destruct
			** This event is called just before the prop is deleted.
			** If your prop affects things outside of the prop actor, such as putting a post process effect onto the camera, or changing some part of the scene, please use this event to disable/undo all those effects before the prop is destroyed.
	* Pre-Screenshot		* Pre-Screenshot
			** This event is called just before a photo is taken in the photoscene.
			** If you have any effect that you do not wish to be included in photos, use this event to turn them off, or vice versa.
	* RT Updated		* RT Updated
	* Set Prop Reference		* Set Prop Reference

Hannah: /* Creating a Prop Widget Blueprint */

2023-03-01T04:07:07Z

Creating a Prop Widget Blueprint

← Older revision		Revision as of 21:07, 28 February 2023
Line 88:		Line 88:
	** The Value of the map is a <code>Photoscene_Parameter_Struct</code>, which you can read about on the [[About Photoscene Blueprints]] page.		** The Value of the map is a <code>Photoscene_Parameter_Struct</code>, which you can read about on the [[About Photoscene Blueprints]] page.
	* Init		* Init
			** This function is called when the prop widget is first spawned.
			** Do all your initial setup in here.
	* Load Photoscene Prop Parameters		* Load Photoscene Prop Parameters
			** This function is called whenever a preset that contains this prop is loaded.
			** When the preset loads the prop, it calls this function to load whatever prop settings were saved at the time.
			** If you want your prop to work with presets, you must use this function in conjunction with the Get Current Photoscene Prop Parameters function.
	* Post-Screenshot		* Post-Screenshot
	* Pre-Destruct		* Pre-Destruct

Hannah: /* Creating a Prop Widget Blueprint */

2023-03-01T03:28:05Z

Creating a Prop Widget Blueprint

← Older revision		Revision as of 20:28, 28 February 2023
Line 77:		Line 77:

	Prop widgets are derived from the parent class <code>Photoscene_Prop_Parent_Widget</code>.		Prop widgets are derived from the parent class <code>Photoscene_Prop_Parent_Widget</code>.

			Just like the Prop Blueprint, the prop widget has functions. Some of these functions are mandatory for full functionality:
			[[File:OverridePropWidgetFunctions.jpg\|thumb]]

			* Get Current Photoscene Prop Parameters
			** This function gets called when the user saves a photoscene preset. Because presets save props, they must by extension save a prop's settings. This function lets the prop tell the photoscene preset what its settings are.
			** It consists of a map, which is an array made of a key-value pair. Drag out from the function's Return pin, and place down a <code>Make Map</code> node to save a setting.
			** Each setting is saved as a key-value pair. To save multiple settings, add pins to the <code>Make Map</code> node.
			** The key is a name for the setting, it can be anything you like, so long as it is unique within the prop. A prop cannot contain keys with the same name.
			** The Value of the map is a <code>Photoscene_Parameter_Struct</code>, which you can read about on the [[About Photoscene Blueprints]] page.
			* Init
			* Load Photoscene Prop Parameters
			* Post-Screenshot
			* Pre-Destruct
			* Pre-Screenshot
			* RT Updated
			* Set Prop Reference

	== Simple Prop Setup ==		== Simple Prop Setup ==

Thomas: /* Using Particle Parameters */

2022-05-17T22:23:47Z

Using Particle Parameters

← Older revision		Revision as of 15:23, 17 May 2022
Line 149:		Line 149:

	We recommend keeping user parameters between 0-1, and then using them as an Alpha to lerp between preset min/max values.		We recommend keeping user parameters between 0-1, and then using them as an Alpha to lerp between preset min/max values.
	[[File:SimpleProp NiagaraLerpExample.png~~\|left~~\|thumb\|631x631px]]		[[File:SimpleProp NiagaraLerpExample.png\|thumb\|631x631px\|none]]

Thomas: fixed text wrapping image formatting issues

2022-05-17T22:21:08Z

fixed text wrapping image formatting issues

@@ Line 90: / Line 90: @@
 Inside the Photoscene Prop Preview file, there is a new Prop Struct. The Prop Struct is where you add the data you need for the prop to build itself in-game.
-[[File:SimplePropExample PropStruct.png|left|thumb|641x641px]]
+[[File:SimplePropExample PropStruct.png|thumb|641x641px|none]]
 == Using the Prop Struct ==
@@ Line 127: / Line 109: @@
 Ensure that the parameters you wish to expose include “editable_” in their names.
-[[File:SimpleProp MatParam.png|left|thumb|296x296px]]
+[[File:SimpleProp MatParam.png|thumb|296x296px|none]]
 Apply it to the mesh, if you are using one.
-[[File:SimpleProp Mat to Mesh.png|left|thumb|596x596px]]
+[[File:SimpleProp Mat to Mesh.png|thumb|596x596px|none]]
 If making a Decal or Post Process, then put this Material Instance in the Prop Struct Material slot.
 Open the Material Instance and ensure the parameters have the check box ticked next to their names.
-[[File:EditParamTick.png|left|thumb|512x512px]]
+[[File:EditParamTick.png|thumb|512x512px|none]]
 Material Vector Parameters will show up in-game as a colour picker with 0-1 range.
@@ Line 178: / Line 132: @@
 In the Prop Preview, below the Particle System variable, there is an array of Parameters you can add.
-[[File:Simple Prop ParticleExampleParams.png|left|thumb|616x616px]]
+[[File:Simple Prop ParticleExampleParams.png|thumb|616x616px|none]]
+Ensure that the name and data type match the parameter you want to link to in the emitter itself.
+[[File:Simple Prop ExpandedParticleParam.png|thumb|617x617px|none]]Currently, the following parameter types are supported: float. Bool, vector, and colour.
 In Cascade, when setting a parameter to be exposed for editing at runtime, ensure the Parameter Name within the Emitter Module matches the name in the Prop preview.
 Min input should be 0 and max input should be 1. The output values can be whatever you like.
-[[File:Simple Prop Cascade Param.png|left|thumb|625x625px]]
+[[File:Simple Prop Cascade Param.png|thumb|625x625px|none]]
 In Niagara, you will need to add User Parameters that match the Name and DataType of the corresponding parameters in the Prop Preview, and plug them into the emitter modules as necessary.
-[[File:SimpleProp NiagaraParams.png|left|thumb|620x620px]]
+[[File:SimpleProp NiagaraParams.png|thumb|620x620px|none]]
 In Niagara, exposed variable names have the “User.” prefix, adding this to the Parameter Name within the Prop Preview is not necessary as its inclusion is handled for you.
-[[File:SimpleProp NiagaraPreviewParams.png|left|thumb|618x618px]]
+[[File:SimpleProp NiagaraPreviewParams.png|thumb|618x618px|none]]
 We recommend keeping user parameters between 0-1, and then using them as an Alpha to lerp between preset min/max values.
 [[File:SimpleProp NiagaraLerpExample.png|left|thumb|631x631px]]

Thomas: added Simple Props workflow documentation

2022-05-17T22:10:50Z

added Simple Props workflow documentation

Show changes

Hannah at 03:48, 23 November 2021

2021-11-23T03:48:20Z

← Older revision		Revision as of 20:48, 22 November 2021
Line 70:		Line 70:
	* Trace For Ground:		* Trace For Ground:
	** This is an internal function and should not be overridden.		** This is an internal function and should not be overridden.

			== Creating a Prop Widget Blueprint ==
			Like photoscenes, props support custom UI functionality.

			You can set up buttons, sliders, drop-down menus, and whatever else your heart desires, to do whatever you want to your prop, or to the world around it.

			Prop widgets are derived from the parent class <code>Photoscene_Prop_Parent_Widget</code>.

Hannah at 01:48, 23 November 2021

2021-11-23T01:48:31Z

← Older revision		Revision as of 18:48, 22 November 2021
Line 33:		Line 33:
	# Fill out the remaining settings inside the prop preview file, including a Prop Group (if this prop is part of an existing group).		# Fill out the remaining settings inside the prop preview file, including a Prop Group (if this prop is part of an existing group).
	# If this prop is not part of an existing prop group, also create a prop group preview file, prop group thumbnail, and assign the newly created prop group to your prop preview file.		# If this prop is not part of an existing prop group, also create a prop group preview file, prop group thumbnail, and assign the newly created prop group to your prop preview file.

			== Creating a Prop Blueprint ==
			A Prop Blueprint contains all of the visuals and functionality of your prop. It can be as simple or as complex as you like.

			The Prop Blueprint is a child of Photoscene_Prop_Parent_Class.

			To Create your Prop Blueprint:

			# right-click in the Content Browser, and create a <code>Blueprint</code>.
			# From the window that pops up, drop down the 'all classes' menu, search for, and select, <code>Photoscene_Prop_Parent_Class</code> as the parent class.

			A prop blueprint can contain whatever you like, whether it be just a simple static mesh, or something more complex like an animated object, or something with physics simulation.

			=== Prop Blueprint Functionality ===
			There are a few helper functions in the Prop Blueprint that you can override and use:
			[[File:Wiki Props PropBlueprintFunctions01.png\|none\|thumb\|336x336px\|Note that most of the ones with 'Actor' listed on the right are irrelevant. we only need to focus on the ones with 'Photoscene Prop Parent Class' as the parent.]]

			* Init:
			** This function is called when the prop is first spawned in the scene.
			** If you want to initialize or set up anything when the prop is created, do so here.
			* On Spawned:
			** This function calls Init.
			** This function is for internal use only.
			** Do not call this function yourself.
			* Post-Screenshot:
			** This event is called just after a photo is taken in the photoscene.
			** If you have anything set to turn on or off during a photo, this event happens right after the photo is taken.
			* Pre-Destruct:
			** This event is called just before the prop is deleted.
			** If your prop affects things outside of the prop actor, such as putting a post process effect onto the camera, or changing some part of the scene, please use this event to disable/undo all those effects before the prop is destroyed.
			* Pre-Screenshot:
			** This event is called just before a photo is taken in the photoscene.
			** If you have any effect that you do not wish to be included in photos, use this event to turn them off, or vice versa.
			* Snap To Ground:
			** This is an internal function and should not be overridden.
			* Trace For Ground:
			** This is an internal function and should not be overridden.