Automation Game Wiki Photoscenes

Photoscenes

From Automation Game Wiki

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.

Workflow

  1. create a mod
  2. create and design a level
  3. (Optional) Create a photoscene Widget for player-customization
  4. create and fill out a Photoscene Level Preview file.
    1. create Thumbnail(s)
  5. Share your mod

Overview

A photoscene mod contains a set of files that define how the photoscene works, and what it looks like. It consists of the following:

  1. a level/scene
  2. a photoscene level preview file
  3. at least one thumbnail picture
  4. (optionally) a widget blueprint

Create A New Blank Mod

  • Create a new Mod from the Blank Template
    UE4ModCreation 01.gif

  • fill out the wizard and press Create Mod
    UE4ModCreation 02.gif

Create a New Blank Level

Create a new blank level in your mod plugin folder. Name it whatever you'd like.

Open the level by double-clicking it.

Design your level

do whatever you want to make your level be what you want.

This is not anything particular to Automation, but UE4 in General. Watch some of Epic's tutorials on this: https://www.youtube.com/watch?v=cl_eoVfNDKU&list=PLZlv_N0_O1gak1_FoAJVrEGiLIploeF3F

Level Creation Guidelines

UE4ModCreation 24.gif
  • 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 A Car Locator.
    • These are the bookmarks for sub-level positions.
    • Place them wherever you want the car to be, and in the Details panel, give them a name.
    • This name will show up in the levels menu in the photoscene as one of the sub-level positions.
    • You can have as many as you want.
    • if none are present, the car will spawn at 0,0,0
  • Currently, Stationary Lights are broken for Automation. use either static or movable lighting in your scenes.

Adding Customization Options To Your Photoscene

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

You can set up your photoscene to allow the player to change the colour of the lighting, the time of day, whether street lights are turned on, etc... the world is your oyster!

Creating a Photoscene Widget

From the Content Browser, add a Widget Blueprint to your mod folder.

Wiki Photoscene CreateWidgetBP.jpg

Open the Widget, and from the File menu, select Reparent Blueprint.

Wiki Photoscene ReparentWidgetBP01.jpg

In the menu that appears, find and select Photo Scene Widget Base.

Wiki Photoscene ReparentWidgetBP02.png

From the Hierarchy window, delete the Canvas Panel.

Wiki Photoscene DeleteCanvas.png

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

Quick Tips:

  • Add all your buttons and options under a parent Vertical Box
    • your widget will appear under the Level Settings menu in the Photoscene, and as such do not have much horizontal space to work with.
      Wiki Photoscene Tips01.gif
  • 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:
    • Slider_Photo_Manager
    • UW_DropDown_Photoscene
    • Photoscene_Checkbox_UW
    • UW_TextBox_Photoscene

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.

Widget Functionality

The Photo Scene Widget Base parent type has a few function calls that you should be aware of, and use where necessary.

From the 'Graph' view, hover over the Functions menu, and select Override.

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

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

  • Check If Ray Tracing Updated:
    • Is called whenever any ray-tracing settings are updated.
    • This should mostly be ignored, as it is an internal function, but can be overridden if you find yourself running into discrepancies between ray-tracing and non-ray-tracing in your level.
    • Most discrepancies in ray-tracing are related to shadows and reflections, and as such, there is another function that should be used before this one. However, if you find yourself still struggling to get a scene looking good for both ray-traced and non-ray-traced graphics, then override this.
  • Get Current Parameter Values:
    • Is called by the Photoscene whenever it needs to ask this widget what the current UI values are.
    • The 'Return' node of this function is an array of Photo_Scene_Parameter_Struct values.
    • This should be used to send the values of your UI to the Photoscene Preset's 'return' node.
  • Level Finished Loading:
    • Is called whenever the Photoscene level has finished loading.
    • This is a safe way to initialize any values you want to set for the level or UI. when the photoscene is loaded from the level selection menu or a preset.
  • Load Parameter Values:
    • Is called when the Photoscene is loading your level from a preset.
    • Paths in an array of Photo_Scene_Parameter_Struct values.
    • 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:
    • 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 Check If Ray Tracing Updated function.

About the Photo_Scene_Parameter_Struct

The Photo_Scene_Parameter_Structis the combination name/value pair setting that is used for all photoscene/preset save game values. It is used in the Get Current Parameter Values function and the Load Parameter Values function.

It consists of three primary settings:

  • Parameter Name:
    • Is the name/identifier for this setting. It is not displayed in-game, but is instead used in the save game file to store the identifier for this current variable. These need to be unique for all variables in this photoscene widget.
  • Data Type
    • Is the type of value being stored in this parameter.
    • Ties in with the #Value.
    • Each photoscene widget parameter can only contain one type of data, so chose wisely.
  • #Value
    • For the current parameter name and data type, this value is used. Match it to the Data Typesetting.

For instance, if you have a slider that affects the Brightness of your photoscene, you would have a Parameter Name of something identifiable, like SceneBrightness, a Data Type of Float, and a Float Val equal to your slider value. If you had a checkbox instead, you would use a data type of bool and a bool val equal to your checkbox value.

For each setting your photoscene widget can change, you should use one Photo_Scene_Parameter_Struct.

Wiki Photoscene AboutThePhotoSceneParameterStruct01.png

Using the Get Current Parameter Values function

This function is called whenever the photoscene preset tries to save this level and its associated settings.

The Get Current Parameter Values function expects an array of Photo_Scene_Parameter_Struct values.

You should use the Make Array node to input into the return node, with a number of array elements equal to the number of settings in your photoscene widget. Each array element should itself be wired to a Make Photo_Scene_Parameter_Struct node, with the Parameter Name, Data Type, and selected data type Value set.

Wiki Photoscene UsingGetCurrentParameterValues01.png

Using the Level Finished Loading function

This function is called whenever the photoscene level has finished loading. If you wish to set some parameters, find some actors, or otherwise initialize anything in your photoscene widget blueprint, do so here. This is a 'safe' version of On Initialized, as it is only called once the level itself and all its contents/actors have been loaded.

Using the Load Parameter Values function

Load Parameter Values is called whenever the photoscene is loading a preset which contains your photoscene level and its associated widget blueprint settings. Any preset that contains your level will contain a list of settings associated with your level (defined in Get Current Parameter Values), which will need to be applied.

It returns a map, which is a fancy version of an array , with key/value pairs for each array element. The Key for each element is the name you returned in Get current Parameter Values from

To apply each setting from the map to your level, The following method works well:

  1. Find the value associated with each of your Parameter Names, and;
  2. if the value is found,
  3. apply it to whatever logic you use that value for.
Wiki Photoscene loadparametervalues01.png

Remember that the value you are finding has to be the same as the value you set for each setting in Get Current Parameter Values.

Using the Ray Tracing Settings Updated function

This function is called every time a ray-tracing-related setting is updated. It returns True when any of the shadow, translucency, or reflections ray-tracing settings are enabled, or False when none of them are enabled.

This is useful when you have a material or mesh or other such thing which conflicts with a ray-traced scene. An example of such is the '10s Design Room photoscene, where the glass materials on the windows are swapped out for a ray-tracing optimised version when ray-tracing is enabled, and swapped back to the standard material when ray-tracing is disabled.

Creating a Photoscene Level Preview file

The Photoscene level preview file contains the overall information about your photoscene, as well as links to the optional widget blueprint, the thumbnail picture(s), and the actual level.

Create a PhotosceneLevelPreview file by right-clicking in the content browser, and from the camso group, select Photo Scene Level.

The PhotoSceneLevelPreview file contains the following settings:

  • Name:
    • This is the name of your photoscene. It will appear in-game as the name of the level in the level selection menu.
  • Default Locator Name:
    • This is the name of the a_car_locator actor that you wish to be the default location of the car when the scene is first loaded.
  • GUID:
    • This is an unique GUID that you should generate for this photoscene. It must be unique to any other GUID.
    • When first creating your photoscene, generate a new GUID for it by opening the photoscene level preview file and from the drop-down to the right of the GUID setting, select Generate.
  • Level Preview Images:
    • The photoscene level selection menu displays any number of thumbnail pictures for each photoscene, and will cycle between them slowly whenever the player hovers their mouse over the icon.
    • You can have as many or as few as you like. If you only have one, only one will be displayed. If you have more than one, they will cycle through each other as the player hovers over the icon.
    • Preview images will be flood filled to a 16:9 aspect ratio in the level selection menu.
      • Because of this, they should be no larger than 512 pixels wide, as any larger texture will take up texture memory on the players' GPU but not actually impact the visual quality of the icon.
      • Textures that are taller or wider than 16:9 will be clipped at the edges. The textures are flood-filled to the 16:9 thumbnail icon, and any texture space outside of that is ignored.
    • Preview images should not contain an alpha channel. If an alpha channel is supplied, then the texture will be invisible in-game, and your thumbnail will be completely red.
    • Optimal settings for your thumbnail textures:
      • maximum horizontal resolution of 512 pixels
      • DXT1 compression
      • sRGB True
      • Has alpha channel: False
  • Level:
    • This is a link/reference to your actual level.
  • Year:
    • This is the level's associated year.
    • It is displayed in the level selection menu next to the level's name.
    • It currently has no other purpose, but could be used in future Automation updates to lock off certain levels during the campaign.
  • Is Designer Level:
    • this is used for if your photoscene level also contains the required blueprints and actors to function as a car and engine designer, and you wish for players to be able to select your photoscene as their car and/or engine designer level.
    • Default is False
  • Opt Custom Level Widget:
    • If your photoscene contains player-adjustable settings, and you have correctly set up a photoscene widget blueprint, then this setting should be set to your photoscene widget blueprint.

Share Your Mod.

Go to the Modding page to see how to share your mod.