Custom Paint Mods - Revision history

Hannah: /* Opacity */

2025-02-19T00:16:13Z

Opacity

← Older revision		Revision as of 17:16, 18 February 2025
Line 61:		Line 61:
	All Custom Paint materials must be set to <code>Masked</code>, unless it is a transparent material.		All Custom Paint materials must be set to <code>Masked</code>, unless it is a transparent material.

	~~Two~~ nodes should be a part of the Opacity or Opacity Mask input. If your material does not have any transparent or masked info, these ~~two~~ nodes are still required.		Three nodes should be a part of the Opacity or Opacity Mask input. If your material does not have any transparent or masked info, these nodes are still required:

	~~[[File:SetMaterialToMasked.png\|frameless]]~~		<code>GetStampAlpha</code> > <code>MF_BlendFade</code> > <code>MF_CustomPaintTwoSidedSwitch</code>

	~~If your material does have opacity information, simply add these two nodes at the end with a multiply~~:		[[File:SetMaterialToMasked 02.jpg\|frameless]]

	[[File:~~SetMaterialToMasked1~~.~~png~~\|frameless]]		If your material does have opacity information, simply combine these nodes with a multiply:

			[[File:SetMaterialToMasked 03.jpg\|frameless]]

			Note: Since the SDK isn't updated yet, the <code>MF_CustomPaintTwoSidedSwitch</code> node is not yet available. To get the same functionality, do this:

			[[File:SetMaterialToMasked Note.jpg\|frameless]]

	===== Two-Sided Material =====		===== Two-Sided Material =====

Hannah: /* Material Requirements */

2023-03-07T05:23:56Z

Material Requirements

← Older revision		Revision as of 22:23, 6 March 2023
Line 73:		Line 73:

	[[File:CustomPaintSetTwoSided.jpg\|frameless]]		[[File:CustomPaintSetTwoSided.jpg\|frameless]]

			==== Required Usage ====
			Materials need to be compiled for each type of object it can be applied to.

			Make sure when creating your custom paint mod, to <code>Enable</code> the following types in the material's details window:

			* Used with Skeletal Mesh
			* Used with Morph Targets
			* Used with Spline Meshes

			[[File:EnableUseWithMeshTypes.jpg\|frameless]]

	==== Parameter Names ====		==== Parameter Names ====

Hannah: /* An Example Material */

2023-01-18T04:06:59Z

An Example Material

← Older revision		Revision as of 21:06, 17 January 2023
Line 465:		Line 465:
	[[File:Example MaterialDefaultRequirements 002.jpg\|frameless]]		[[File:Example MaterialDefaultRequirements 002.jpg\|frameless]]

	Add a texture object parameter to the Texture Object Input, and a scalar parameter to the Texture Size input:		==== Adding a Texture ====
			Add a FixtureUVs node to the Base Colour input, and add a texture object parameter to the Texture Object Input, and a scalar parameter to the Texture Size input of it:

	[[File:Example FixtureUVs.jpg\|frameless]]		[[File:Example FixtureUVs.jpg\|frameless]]

			==== Controlling the Scale ====
	If you want the player to be able to control the scale of the texture, add a CustomPaintScale node to the Texture Size input:		If you want the player to be able to control the scale of the texture, add a CustomPaintScale node to the Texture Size input:

	[[File:Example FixtureUVsWithScale.jpg\|frameless]]		[[File:Example FixtureUVsWithScale.jpg\|frameless]]

			==== Adding a Normal Map ====
	If you have a normal map, add that to the Normal Object input:		If you have a normal map, add that to the Normal Object input:

	[[File:Example FixtureUVsWithScaleAndNormals.jpg\|frameless]]		[[File:Example FixtureUVsWithScaleAndNormals.jpg\|frameless]]

			==== Adding Normal Strength Adjustment ====
	If your normal map could do with some adjustment for strength, add that with a NormalStrength node:		If your normal map could do with some adjustment for strength, add that with a NormalStrength node:

	[[File:Example FixtureUVsWithScaleAndNormalsAndStrength.jpg\|frameless]]		[[File:Example FixtureUVsWithScaleAndNormalsAndStrength.jpg\|frameless]]

			==== Creating Colour Adjustment ====
	If you want the player to be able to adjust the colours of the texture in-game, do so with a Lerp node and two Vector Parameters:		If you want the player to be able to adjust the colours of the texture in-game, do so with a Lerp node and two Vector Parameters:

	[[File:Example FixtureUVs 005.jpg\|frameless]]		[[File:Example FixtureUVs 005.jpg\|frameless]]

	Note that any parameter that you want the player to be able to edit '''must''' have <code>editable_</code> as the prefix.		''Note that any parameter that you want the player to be able to edit '''must''' have <code>editable_</code> as the prefix.''

			==== Adding Texture Selection Options ====
			If you want the player to be able to select a texture with a slider, the order of operations needs to switch. Remove the texture inputs from the FixtureUVs node, and instead use the UVs, DDX, and DDY outputs from FixtureUVs to feed into the respective inputs of a TexList node. For this example, We'll use a TexList_004, but any number of inputs will work exactly the same way.

			Create four texture object parameters (or any number, to match the number of textures the TexList node requires), and name them all. ''They cannot be static texture objects, they must be parameters.''

			Create a scalar parameter, with the <code>editable_</code> prefix, to be your selector slider.

			For regular textures, use the Selected Texture output. For normal maps, use the Selected Normal output.

			[[File:Example FixtureUVs 006.jpg\|frameless]]

Hannah: /* Using MF_FixtureUVs */

2023-01-17T05:03:49Z

Using MF_FixtureUVs

← Older revision		Revision as of 22:03, 16 January 2023
Line 456:		Line 456:
	== Examples ==		== Examples ==

	=== ~~Using GetStampAlpha and BlendFade~~ ===		=== An Example Material ===
	Set your material to Masked:		Set your material to Masked:

Line 465:		Line 465:
	[[File:Example MaterialDefaultRequirements 002.jpg\|frameless]]		[[File:Example MaterialDefaultRequirements 002.jpg\|frameless]]

	~~=== Using MF_FixtureUVs ===~~
	Add a texture object parameter to the Texture Object Input, and a scalar parameter to the Texture Size input:		Add a texture object parameter to the Texture Object Input, and a scalar parameter to the Texture Size input:

Hannah: /* MF_NormalStrength */

2023-01-17T03:59:46Z

MF_NormalStrength

← Older revision		Revision as of 20:59, 16 January 2023
Line 453:		Line 453:
	* Normal - This is the normal vector you want to adjust.		* Normal - This is the normal vector you want to adjust.
	* Strength - This is a scalar value that will effectively multiply the normals. A strength of 1 means the normal map is un-affected, a strength of 2 means the normal map is twice as strong, a value of 0 will mean the normal vector has no effect on the surface normals of the material, and a value of -1 will invert the direction of the X and Y components of the normal (effectively inverting the normal map without inverting the direction of the surface polygon)		* Strength - This is a scalar value that will effectively multiply the normals. A strength of 1 means the normal map is un-affected, a strength of 2 means the normal map is twice as strong, a value of 0 will mean the normal vector has no effect on the surface normals of the material, and a value of -1 will invert the direction of the X and Y components of the normal (effectively inverting the normal map without inverting the direction of the surface polygon)

			== Examples ==

			=== Using GetStampAlpha and BlendFade ===
			Set your material to Masked:

			[[File:Example MaterialDefaultRequirements 001.jpg\|frameless]]

			Then add the GetStampAlpha, and BlendFade nodes to the opacity mask:

			[[File:Example MaterialDefaultRequirements 002.jpg\|frameless]]

			=== Using MF_FixtureUVs ===
			Add a texture object parameter to the Texture Object Input, and a scalar parameter to the Texture Size input:

			[[File:Example FixtureUVs.jpg\|frameless]]

			If you want the player to be able to control the scale of the texture, add a CustomPaintScale node to the Texture Size input:

			[[File:Example FixtureUVsWithScale.jpg\|frameless]]

			If you have a normal map, add that to the Normal Object input:

			[[File:Example FixtureUVsWithScaleAndNormals.jpg\|frameless]]

			If your normal map could do with some adjustment for strength, add that with a NormalStrength node:

			[[File:Example FixtureUVsWithScaleAndNormalsAndStrength.jpg\|frameless]]

			If you want the player to be able to adjust the colours of the texture in-game, do so with a Lerp node and two Vector Parameters:

			[[File:Example FixtureUVs 005.jpg\|frameless]]

			Note that any parameter that you want the player to be able to edit '''must''' have <code>editable_</code> as the prefix.

Hannah: /* MF_FixtureUVs */

2023-01-06T04:17:15Z

MF_FixtureUVs

← Older revision		Revision as of 21:17, 5 January 2023
Line 416:		Line 416:
	.		.
	===== MF_FixtureUVs =====		===== MF_FixtureUVs =====
			[[File:MatFunction FixtureUVs.jpg\|thumb]]
	This node is the bread-and-butter of custom paint and fixture materials. It contains all the logic and maths required for applying a texture to a model, and should be used in 99% of situations where you want to apply a texture to your Custom Paint shader.		This node is the bread-and-butter of custom paint and fixture materials. It contains all the logic and maths required for applying a texture to a model, and should be used in 99% of situations where you want to apply a texture to your Custom Paint shader.

Line 430:		Line 431:
	* World Position - Leave this section blank, unless you wish to override the world position used to calculate the current pixel's location in world-space. In 99% of situations, this is left blank.		* World Position - Leave this section blank, unless you wish to override the world position used to calculate the current pixel's location in world-space. In 99% of situations, this is left blank.
	* Cutoff Offset - Leave this section blank, unless you wish to override the ratio at which a texture switches between the cardinal directions used for the box unwrap. in 99% of situations, this is left blank.		* Cutoff Offset - Leave this section blank, unless you wish to override the ratio at which a texture switches between the cardinal directions used for the box unwrap. in 99% of situations, this is left blank.
	* Texture Offset - This input defaults to using two <code>editable_</code> parameters for adjusting the texture offset		* Texture Offset - This input defaults to using two <code>editable_</code> parameters for adjusting the texture offset. If left blank, two sliders will appear in-game for adjusting the X and Y axis of the texture. Override this only if you know what you are doing.
	* Texture Rotation -		* Texture Rotation - This input, unlike the Texture Offset input, does not have a default parameter attached to it. This is because it is unfortunately not possible, currently, to rotate the UVs of an exported material. As such, this input remains unused. You can override it to adjust the rotation of the textures along each of the three cardinal directions, as each component of the vector represents a fraction of rotation (ie: a vector [x,y,z] is really just a combination of three rotations, as 0-1 being a 0-360 degree rotation. so a vector [0.25,0.5,1] would rotate the X axis by 90 degrees, the Y axis by 180, and the z axis by 0 degrees).
	* Output Vec4 -		* Output Vec4 - This bool is False by default. If the texture you are using contains RGBA information, and you are using the Alpha channel in your material, set this bool to True, otherwise leave blank.
	* Use Mesh UVs -		* Use Mesh UVs - This bool is False by default. If enabled, most of the features of this node are disabled and only the Texture Size input is used, as a multiplier on the UVs.
	* Has Texture Transition -		* Has Texture Transition - This bool is False by default. If enabled, the box unwrap tries to do a blended transition between each of the three unwraps. This is useful for fine-detail or stochastic, noisy, textures. If left as False, it uses a hard cutoff where the transition between the three unwraps is more obvious. This is useful for textures that try to imitate real patterns, as the hard seams imitate actual seams between sheets of material.

	Outputs;		Outputs;

	* Result -		* Result - This is the unwrapped texture, as either a Vec3, or Vec4 (If Output Vec4 is set to True). If no Texture Object is supplied, this output is unused.
	* Normal -		* Normal - This is as above, but for normal maps. If your texture is a normal map, use this output paired with the Normal Object input. If no Normal Object is supplied, this output is unused.
	* UVs -		* UVs - This is the resulting UVs used for the Texture and Normal Object texture samplers. If you need to use the UVs for more than one texture, or a texture that is not a Colour or Normal Map, this output combined with the DDX and DDY outputs can be used on a texture sampler to get the same result.
	* DDX -		* DDX - Because the UVs of this node are generated procedurally, the DDX and DDY of the UVs need to be explicitly defined and fed to the Texture Sampler. If you are using your own texture sampler, you need to use the DDX and DDY outputs as well as the UVs. You cannot use the UVs just on their own.
	* DDY -		* DDY - See above.

	===== MF_NormalStrength =====		===== MF_NormalStrength =====
			[[File:MatFunction NormalStrength.jpg\|thumb]]
			This node will adjust the strength of a normal map. This is useful when a normal map does not perfectly represent the material you wish to create, or when the material is dynamic and adjustment of the normal map is desired.

			It has two inputs;

			* Normal - This is the normal vector you want to adjust.
			* Strength - This is a scalar value that will effectively multiply the normals. A strength of 1 means the normal map is un-affected, a strength of 2 means the normal map is twice as strong, a value of 0 will mean the normal vector has no effect on the surface normals of the material, and a value of -1 will invert the direction of the X and Y components of the normal (effectively inverting the normal map without inverting the direction of the surface polygon)

Hannah: /* MF_FixtureUVs */

2023-01-05T05:17:03Z

MF_FixtureUVs

← Older revision		Revision as of 22:17, 4 January 2023
Line 6:		Line 6:
	The <code>Custom Paint</code> file contains the settings and applicable options for the Custom Paint, as well as a reference to the paint material.		The <code>Custom Paint</code> file contains the settings and applicable options for the Custom Paint, as well as a reference to the paint material.

	The custom paint material itself is a Material in UE4, which is set up in a specific way. Material variables can have an <code>editable_</code> prefix in ~~the~~ name if you want the player to have access to it in the custom paint settings in-game. Variables and parameters also need to be input into the <code>export user data</code>, contained within the material, for them to export correctly. Materials will not export correctly at all without this <code>export user data</code>.		The custom paint material itself is a Material in UE4, which is set up in a specific way. Material variables can have an <code>editable_</code> prefix in their name if you want the player to have access to it in the custom paint settings in-game. Variables and parameters also need to be input into the <code>export user data</code>, contained within the material, for them to export correctly. Materials will not export correctly at all without this <code>export user data</code>.

	== Workflow ==		== Workflow ==

Hannah at 05:12, 5 January 2023

2023-01-05T05:12:57Z

← Older revision		Revision as of 22:12, 4 January 2023
Line 424:		Line 424:
	Inputs;		Inputs;

	* Texture Object -		* Texture Object - Input the texture object parameter you wish to use here. Unless it is a normal map, in which case use the Normal Object input.
	* Normal Object -		* Normal Object - If the texture object you wish to use is a normal map, use this input instead.
	* Texture Size -		* Texture Size - Input a scalar value here, in world units (a value of 1 is equal to 1cm, and a value of 100 is equal to 100cm), and your texture will be mapped at this scale.
	* World Normal -		* World Normal - Leave this section blank, unless you wish to override the world normal used to calculate the current pixel's normal vector in world-space. In 99% of situations, this is left blank.
	* World Position -		* World Position - Leave this section blank, unless you wish to override the world position used to calculate the current pixel's location in world-space. In 99% of situations, this is left blank.
	* Cutoff Offset -		* Cutoff Offset - Leave this section blank, unless you wish to override the ratio at which a texture switches between the cardinal directions used for the box unwrap. in 99% of situations, this is left blank.
	* Texture Offset -		* Texture Offset - This input defaults to using two <code>editable_</code> parameters for adjusting the texture offset
	* Texture Rotation -		* Texture Rotation -
	* Output Vec4 -		* Output Vec4 -

Hannah: /* MF_FixtureUVs */

2023-01-05T04:41:12Z

MF_FixtureUVs

@@ Line 417: / Line 417: @@
 ===== MF_FixtureUVs =====
 This node is the bread-and-butter of custom paint and fixture materials. It contains all the logic and maths required for applying a texture to a model, and should be used in 99% of situations where you want to apply a texture to your Custom Paint shader.
 ===== MF_NormalStrength =====

Hannah: /* MF_ExportParameterSwitch_Vec3 */

2023-01-05T04:28:55Z

MF_ExportParameterSwitch_Vec3

← Older revision		Revision as of 21:28, 4 January 2023
Line 415:		Line 415:

	.		.



	===== MF_FixtureUVs =====		===== MF_FixtureUVs =====
	This node is the bread-and-butter of custom paint and fixture materials. It contains all the logic and maths required for applying a texture to a model, and should be used in 99% of situations where you want to apply a texture to your Custom Paint shader.		This node is the bread-and-butter of custom paint and fixture materials. It contains all the logic and maths required for applying a texture to a model, and should be used in 99% of situations where you want to apply a texture to your Custom Paint shader.

	===== MF_NormalStrength =====		===== MF_NormalStrength =====