HowTo/Reskin an Asset using an alias - Revision history

Pcas1986: Added section on using texture replacement for reskins with LOD

2021-09-22T21:25:52Z

Added section on using texture replacement for reskins with LOD

← Older revision		Revision as of 21:25, 22 September 2021
Line 225:		Line 225:

	The config.txt tags (script and class) are changed to the 'reskin' script file name and 'reskin' as the asset primary class.		The config.txt tags (script and class) are changed to the 'reskin' script file name and 'reskin' as the asset primary class.

			== Reskinning an asset that uses Level of Detail (LOD) ==

			If an asset to be reskinned uses the same texture for all LOD meshes then no special action is required. But if that asset uses different textures for LOD meshes then a texture replacement is usually required for each texture.

			1. An example of a reskin mesh-table referencing a mesh asset that uses the LM.TXT LOD method:

			mesh-table {
			default {
			mesh-asset <kuid:12345:1000>
			mesh "body/alias_sample.lm"
			effects {
			reskin-lod0 {
			kind "texture-replacement"
			texture "lod0-map.texture"
			}
			reskin-lod1 {
			kind "texture-replacement"
			texture "lod1-map.texture"
			}
			}
			...
			}

			2. The reskin script must call all the LOD texture replacements in the Init() method. For instance:

			class reskin isclass Locomotive {
			public void Init(void) {
			inherited();

			// Set the specified textures onto the named effects.
			SetFXTextureReplacementTexture("reskin-lod0", "lod0-map.texture");
			SetFXTextureReplacementTexture("reskin-lod1", "lod1-map.texture");
			...
			}



	==Related Links==		==Related Links==

Rob: /* Related Links */

2019-07-23T00:39:16Z

Builderbob: /* Notes */

2016-07-10T03:16:54Z

Notes

← Older revision		Revision as of 03:16, 10 July 2016
Line 203:		Line 203:
	4. If upgrading an asset that previously used the 'alias' tag, those textures and their image file that are not changed from the original should be removed from the skin asset and should not be included in the texture replacement.		4. If upgrading an asset that previously used the 'alias' tag, those textures and their image file that are not changed from the original should be removed from the skin asset and should not be included in the texture replacement.

	Reskinning using an alias and scripted assets.		== Reskinning using an alias and scripted assets ==

	If the existing script is accessible, the texture replacement script lines can be added to that script.		If the existing script is accessible, the texture replacement script lines can be added to that script.

Builderbob: Created.

2016-07-10T03:13:07Z

Created.

@@ Line 203: / Line 203: @@
 . If upgrading an asset that previously used the 'alias' tag, those textures and their image file that are not changed from the original should be removed from the skin asset and should not be included in the texture replacement.
-== TBD ==
+Reskinning using an alias and scripted assets.
-Reskinning using an alias and scripted assets.
+The config.txt tags (script and class) are changed to the 'reskin' script file name and 'reskin' as the asset primary class.
 ==Related Links==

Sailordan: /* How To Reskin an Asset using an alias - A step-by-step guide */

2016-05-07T23:09:15Z

How To Reskin an Asset using an alias - A step-by-step guide

← Older revision		Revision as of 23:09, 7 May 2016
Line 129:		Line 129:
	1. This is the name of the script as it exists in the reskin asset. The name is arbitrary, but the script tag value must match the file name exactly. The file must have a .gs extension.		1. This is the name of the script as it exists in the reskin asset. The name is arbitrary, but the script tag value must match the file name exactly. The file must have a .gs extension.

	2. This is the script class, as defined within the script. This name is arbitrary, but the tag must match the script statement. See script details below.		2. This is the script class, as defined within the script. This name is arbitrary, but the tag must match the name used in the script 'class' statement. See script details below.

	'''reskin.gs'''		'''reskin.gs'''

Builderbob: /* Notes */ Typos

2015-07-22T03:01:32Z

Notes: Typos

← Older revision		Revision as of 03:01, 22 July 2015
Line 199:		Line 199:
	Similar considerations may apply to other kinds of assets.		Similar considerations may apply to other kinds of assets.

	3. Numbering of locomotives. If the original asset supports running numbers then the skin asset can also be set up to support it. The skin asset does not require the digit_xx texture files that were previously required (when the 'alias' tag was used) in order to suppress error message about missing textures. The number images that are used are from the skin asset, not the original, but obviously they must match for size. Note that if the reskinning has overridden the ~~autonumber~~ feature with the running numbers embedded in the texture, then the running number for the loco should be left blank.		3. Numbering of locomotives. If the original asset supports running numbers then the skin asset can also be set up to support it. The skin asset does not require the digit_xx texture files that were previously required (when the 'alias' tag was used) in order to suppress error message about missing textures. The number images that are used are from the skin asset, not the original, but obviously they must match for size. Note that if the reskinning has overridden the running number feature with the running numbers embedded in the texture, then the running number for the loco should be left blank.

	4. If upgrading an asset that previously used the 'alias' tag, those textures and their image file that are not changed from the original should be removed from the skin asset and should not be included in the texture replacement.		4. If upgrading an asset that previously used the 'alias' tag, those textures and their image file that are not changed from the original should be removed from the skin asset and should not be included in the texture replacement.

Builderbob: /* TBD */ Removed numbering

2015-07-22T02:59:30Z

TBD: Removed numbering

← Older revision		Revision as of 02:59, 22 July 2015
Line 204:		Line 204:

	== TBD ==		== TBD ==
	~~Reskinning using an alias for locomotives with auto-numbering~~

	Reskinning using an alias and scripted assets.		Reskinning using an alias and scripted assets.

Builderbob: /* Notes */ Appended (3) and (4)

2015-07-22T02:58:59Z

Notes: Appended (3) and (4)

← Older revision		Revision as of 02:58, 22 July 2015
Line 177:		Line 177:

	== Notes ==		== Notes ==
	1. If the mesh and texture in the original asset are located in a subfolder, the full path must be specified for the mesh, but the textures will be located relative to that mesh. For instance, for a locomotive it is common to put the main mesh and textures in a 'body' folder. Also, there might be more than one texture.		1. If the mesh and texture in the original asset are located in a subfolder, the full path must be specified for the mesh, but the textures will be located relative to that mesh. For instance, for a locomotive it is common to put the main mesh and textures in a 'body' folder - the mesh requires the folder name in the path, but the textures do not. Also, there might be more than one texture.
	mesh-asset <kuid:12345:1000>		mesh-asset <kuid:12345:1000>
	mesh "body/alias_sample.im"		mesh "body/alias_sample.im"
Line 190:		Line 190:
	}		}
	}		}
			The texture replacement line in the script will be repeated accordingly.

	2. The example above is a simple scenery object. For other types of assets it might be necessary to use the script class specific to that asset. In that case, the MeshObject script must be included in order to provide access to the replacement function. For instance, an engine is type Locomotive, so the script file include statements are		2. The example above is a simple scenery object. For other types of assets it might be necessary to use the script class specific to that asset. In that case, the MeshObject script must be included in order to provide access to the replacement function. For instance, an engine is type Locomotive, so the script file include statements are
Line 196:		Line 197:
	and the class definition is		and the class definition is
	alias_reskin isclass Locomotive		alias_reskin isclass Locomotive
			Similar considerations may apply to other kinds of assets.

			3. Numbering of locomotives. If the original asset supports running numbers then the skin asset can also be set up to support it. The skin asset does not require the digit_xx texture files that were previously required (when the 'alias' tag was used) in order to suppress error message about missing textures. The number images that are used are from the skin asset, not the original, but obviously they must match for size. Note that if the reskinning has overridden the autonumber feature with the running numbers embedded in the texture, then the running number for the loco should be left blank.

			4. If upgrading an asset that previously used the 'alias' tag, those textures and their image file that are not changed from the original should be removed from the skin asset and should not be included in the texture replacement.

	== TBD ==		== TBD ==

Builderbob: /* Notes */ Correction to path comment

2015-07-21T03:01:25Z

Notes: Correction to path comment

← Older revision		Revision as of 03:01, 21 July 2015
Line 177:		Line 177:

	== Notes ==		== Notes ==
	1. If the texture in the original asset is located in a subfolder, the full path must be specified in the ~~texture replacement container~~. For instance, for a locomotive it is common to put the main mesh and textures in a 'body' folder. Also, there might be more than one texture.		1. If the mesh and texture in the original asset are located in a subfolder, the full path must be specified for the mesh, but the textures will be located relative to that mesh. For instance, for a locomotive it is common to put the main mesh and textures in a 'body' folder. Also, there might be more than one texture.
	~~default {~~		mesh-asset <kuid:12345:1000>
	effects {		mesh "body/alias_sample.im"
			effects {
	reskin1 {		reskin1 {
	kind "texture-replacement"		kind "texture-replacement"
	texture "~~body/~~map1.texture"		texture "map1.texture"
	}		}
	reskin2 {		reskin2 {
	kind "texture-replacement"		kind "texture-replacement"
	texture "~~body/~~map2.texture"		texture "map2.texture"
	}		}
	}		}
	~~The full path may also required for the mesh itself.~~

	2. The example above is a simple scenery object. For other types of assets it might be necessary to use the script class specific to that asset. In that case, the MeshObject script must be included in order to provide access to the replacement function. For instance, an engine is type Locomotive, so the script file include statements are		2. The example above is a simple scenery object. For other types of assets it might be necessary to use the script class specific to that asset. In that case, the MeshObject script must be included in order to provide access to the replacement function. For instance, an engine is type Locomotive, so the script file include statements are
Line 195:		Line 195:
	include "MeshObject.gs"		include "MeshObject.gs"
	and the class definition is		and the class definition is
	alias_reskin isclass Locomotive		alias_reskin isclass Locomotive

	== TBD ==		== TBD ==

Builderbob: Author reference

2015-07-21T02:45:03Z

Author reference

← Older revision		Revision as of 02:45, 21 July 2015
Line 136:		Line 136:
	// Script: reskin		// Script: reskin
	// Function: reskin aliased asset		// Function: reskin aliased asset
	// Author: ~~BuilderBob~~		// Author:
	// Revision: 0.1 July 2015		// Revision: 0.1 July 2015
	//		//

← Older revision		Revision as of 00:39, 23 July 2019
Line 228:		Line 228:
	==Related Links==		==Related Links==


			* [[Texture-Replacement_Effect]]
	* [[HowToGuides]]		* [[HowToGuides]]

	[[Category:How-to guides]]		[[Category:How-to guides]]