AssetImportConfig
Defines properties for an AssetImprotConfig object. @AssetImportConfig is a SimObject derived object intended to act as a container for all the necessary configuration data when running the Asset Importer. @It dictates if and how any given asset type will be processed when running an import action. This is because the Asset Importer utilizes a lot of informed logic @to try and automate as much of the import process as possible. In theory, you would run the import on a given file, and based on your config the importer will do @everything from importing the designated file, as well as finding and importing any associated files such as images or materials, and prepping the objects at time @of import to avoid as much manual post-processing as possible.
General
string
Duplicate Asset Auto-Resolution Action. Options are None, AutoPrune, AutoRename.
bool
Indicates if warnings should be treated as errors.
bool
Indicates if importing should be prevented from completing if any errors are detected at all.
bool
Should the importer automatically prompt to find missing files if they are not detected automatically by the importer.
Meshes
bool
Indicates if this config supports importing meshes.
bool
When importing a shape, this indicates if it should automatically add a standard suffix onto the name.
string
If AlwaysAddShapeSuffix is on, this is the suffix to be added.
bool
Indicates if this config should override the per-format sis files with the config's specific settings.
bool
Indicates if the up axis in the model file should be overridden.
string
If overriding, what axis should be used as up. Options are X_AXIS, Y_AXIS, Z_AXIS.
bool
Indicates if the scale in the model file should be overridden.
float
If overriding, what scale should be used.
bool
Indicates if scale of nodes should be ignored.
bool
Indicates if the center of the model file should be automatically recentered.
bool
Indicates if the floor height of the model file should be automatically zero'd.
bool
Indicates if submeshes should be collapsed down into a single main mesh.
string
Indicates what LOD mode the model file should utilize to process out LODs. Options are TrailingNumber, DetectDTS, SingleSize.
string
A list of what nodes should be guaranteed to be imported if found in the model file. Separated by either , or ;.
string
A list of what nodes should be guaranteed to not be imported if found in the model file. Separated by either , or ;.
string
A list of what mesh objects should be guaranteed to be imported if found in the model file. Separated by either , or ;.
string
A list of what mesh objects should be guaranteed to not be imported if found in the model file. Separated by either , or ;.
bool
Flag to indicate the shape loader should convert to a left-handed coordinate system.
bool
Should the shape loader calculate tangent space values.
bool
Should the shape loader automatically prune redundant/duplicate materials.
bool
Should the shape loader auto-generate UV Coordinates for the mesh.
bool
Should the UV coordinates be transformed.
bool
Should the UV coordinates be flipped.
bool
Should the shape loader automatically look for instanced submeshes in the model file.
bool
Should the shape loader limit the bone weights.
bool
Should the shape loader automatically merge identical/duplicate verts.
bool
Should the shape loader reverse the winding order of the mesh's face indicies.
bool
Should the normals on the model be inverted.
Materials
bool
Does this config allow for importing of materials.
bool
When importing a material, this indicates if it should automatically add a standard suffix onto the name.
string
If AlwaysAddMaterialSuffix is on, this is the suffix to be added.
bool
When importing a material, should it automatically attempt to merge Roughness, AO and Metalness maps into a single, composited PBR Configuration map.
bool
When generating a material off of an importing image, should the importer force appending a diffusemap suffix onto the end to avoid potential naming confusion.
bool
Should the importer try and use existing material assets in the game directory if at all possible. (Not currently utilized)
string
A list of material names that should not be imported. Separated by either , or ;.
bool
When processing a material asset, should the importer attempt to populate the various material maps on it by looking up common naming conventions for potentially relevent image files.
Animation
bool
Does this config allow for importing Shape Animations.
bool
When importing a shape file, should the animations within be separated out into unique files.
string
If separating animations out from a source file, what prefix should be added to the names for grouping association.
string
Defines the animation timing for the given animation sequence. Options are FrameTime, Seconds, Milliseconds.
bool
The FPS of the animation sequence.
Collision
bool
Does this configuration generate collision geometry when importing. (Not currently enabled)
string
What sort of collision geometry is generated. (Not currently enabled)
string
What prefix is added to the collision geometry generated. (Not currently enabled)
bool
Does this configuration generate Line of Sight collision geometry. (Not currently enabled)
string
What sort of Line of Sight collision geometry is generated. (Not currently enabled)
string
What prefix is added to the Line of Sight collision geometry generated. (Not currently enabled)
Images
bool
Does this configuration support importing images.
bool
When importing an image, this indicates if it should automatically add a standard suffix onto the name.
string
If AlwaysAddImageSuffix is on, this is the suffix to be added.
string
What is the default ImageType images are imported as. Options are: N/A, Diffuse, Normal, Metalness, Roughness, AO, ORMConfig, GUI, Cubemap.
string
What type of suffixes are scanned to detect if an importing image is a diffuse map.
string
What type of suffixes are scanned to detect if an importing image is a normal map.
string
What type of suffixes are scanned to detect if an importing image is a metalness map.
string
What type of suffixes are scanned to detect if an importing image is a roughness map.
string
What type of suffixes are scanned to detect if an importing image is a smoothness map.
string
What type of suffixes are scanned to detect if an importing image is a ambient occlusion map.
string
What type of suffixes are scanned to detect if an importing image is a ORMConfig map.
string
Indicates what filter mode images imported with this configuration utilizes. Options are Linear, Bilinear, Trilinear.
bool
Indicates if images imported with this configuration utilize mipmaps.
bool
Indicates if images imported with this configuration are in an HDR format.
float
Indicates what amount of scaling images imported with this configuration use.
bool
Indicates if images imported with this configuration are compressed.
bool
Indicates if images imported with this configuration generate a parent material for it as well.
Sounds
bool
Indicates if sounds are imported with this configuration.
float
Indicates what amount the volume is adjusted on sounds imported with this configuration.
float
Indicates what amount the pitch is adjusted on sounds imported with this configuration.
bool
Indicates if sounds imported with this configuration are compressed.
Public Functions
void
loadImportConfig(Settings configSettings, String configName)
Creates a new script asset using the targetFilePath.
Detailed Description
Defines properties for an AssetImprotConfig object. @AssetImportConfig is a SimObject derived object intended to act as a container for all the necessary configuration data when running the Asset Importer. @It dictates if and how any given asset type will be processed when running an import action. This is because the Asset Importer utilizes a lot of informed logic @to try and automate as much of the import process as possible. In theory, you would run the import on a given file, and based on your config the importer will do @everything from importing the designated file, as well as finding and importing any associated files such as images or materials, and prepping the objects at time @of import to avoid as much manual post-processing as possible.
General
string DuplicatAutoResolution
Duplicate Asset Auto-Resolution Action. Options are None, AutoPrune, AutoRename.
bool WarningsAsErrors
Indicates if warnings should be treated as errors.
bool PreventImportWithErrors
Indicates if importing should be prevented from completing if any errors are detected at all.
bool AutomaticallyPromptMissingFiles
Should the importer automatically prompt to find missing files if they are not detected automatically by the importer.
Meshes
bool ImportMesh
Indicates if this config supports importing meshes.
bool AlwaysAddShapeSuffix
When importing a shape, this indicates if it should automatically add a standard suffix onto the name.
string AddedShapeSuffix
If AlwaysAddShapeSuffix is on, this is the suffix to be added.
bool UseManualShapeConfigRules
Indicates if this config should override the per-format sis files with the config's specific settings.
bool DoUpAxisOverride
Indicates if the up axis in the model file should be overridden.
string UpAxisOverride
If overriding, what axis should be used as up. Options are X_AXIS, Y_AXIS, Z_AXIS.
bool DoScaleOverride
Indicates if the scale in the model file should be overridden.
float ScaleOverride
If overriding, what scale should be used.
bool IgnoreNodeScale
Indicates if scale of nodes should be ignored.
bool AdjustCenter
Indicates if the center of the model file should be automatically recentered.
bool AdjustFloor
Indicates if the floor height of the model file should be automatically zero'd.
bool CollapseSubmeshes
Indicates if submeshes should be collapsed down into a single main mesh.
string LODType
Indicates what LOD mode the model file should utilize to process out LODs. Options are TrailingNumber, DetectDTS, SingleSize.
string AlwaysImportedNodes
A list of what nodes should be guaranteed to be imported if found in the model file. Separated by either , or ;.
string AlwaysIgnoreNodes
A list of what nodes should be guaranteed to not be imported if found in the model file. Separated by either , or ;.
string AlwaysImportMeshes
A list of what mesh objects should be guaranteed to be imported if found in the model file. Separated by either , or ;.
string AlwaysIgnoreMeshes
A list of what mesh objects should be guaranteed to not be imported if found in the model file. Separated by either , or ;.
bool convertLeftHanded
Flag to indicate the shape loader should convert to a left-handed coordinate system.
bool calcTangentSpace
Should the shape loader calculate tangent space values.
bool removeRedundantMats
Should the shape loader automatically prune redundant/duplicate materials.
bool genUVCoords
Should the shape loader auto-generate UV Coordinates for the mesh.
bool TransformUVs
Should the UV coordinates be transformed.
bool flipUVCoords
Should the UV coordinates be flipped.
bool findInstances
Should the shape loader automatically look for instanced submeshes in the model file.
bool limitBoneWeights
Should the shape loader limit the bone weights.
bool JoinIdenticalVerts
Should the shape loader automatically merge identical/duplicate verts.
bool reverseWindingOrder
Should the shape loader reverse the winding order of the mesh's face indicies.
bool invertNormals
Should the normals on the model be inverted.
Materials
bool ImportMaterials
Does this config allow for importing of materials.
bool AlwaysAddMaterialSuffix
When importing a material, this indicates if it should automatically add a standard suffix onto the name.
string AddedMaterialSuffix
If AlwaysAddMaterialSuffix is on, this is the suffix to be added.
bool CreateORMConfig
When importing a material, should it automatically attempt to merge Roughness, AO and Metalness maps into a single, composited PBR Configuration map.
bool UseDiffuseSuffixOnOriginImage
When generating a material off of an importing image, should the importer force appending a diffusemap suffix onto the end to avoid potential naming confusion.
e.g. MyCoolStuff.png is imported, generating MyCoolStuff material asset and MyCoolStuff_Diffuse image asset
bool UseExistingMaterials
Should the importer try and use existing material assets in the game directory if at all possible. (Not currently utilized)
string IgnoreMaterials
A list of material names that should not be imported. Separated by either , or ;.
bool PopulateMaterialMaps
When processing a material asset, should the importer attempt to populate the various material maps on it by looking up common naming conventions for potentially relevent image files.
e.g. If MyCoolStuff_Diffuse.png is imported, generating MyCoolStuff material, it would also find MyCoolStuff_Normal and MyCoolStuff_PBR images and map them to the normal and ORMConfig maps respectively automatically
Animation
bool ImportAnimations
Does this config allow for importing Shape Animations.
bool SeparateAnimations
When importing a shape file, should the animations within be separated out into unique files.
string SeparateAnimationPrefix
If separating animations out from a source file, what prefix should be added to the names for grouping association.
string animTiming
Defines the animation timing for the given animation sequence. Options are FrameTime, Seconds, Milliseconds.
bool animFPS
The FPS of the animation sequence.
Collision
bool GenerateCollisions
Does this configuration generate collision geometry when importing. (Not currently enabled)
string GenCollisionType
What sort of collision geometry is generated. (Not currently enabled)
string CollisionMeshPrefix
What prefix is added to the collision geometry generated. (Not currently enabled)
bool GenerateLOSCollisions
Does this configuration generate Line of Sight collision geometry. (Not currently enabled)
string GenLOSCollisionType
What sort of Line of Sight collision geometry is generated. (Not currently enabled)
string LOSCollisionMeshPrefix
What prefix is added to the Line of Sight collision geometry generated. (Not currently enabled)
Images
bool importImages
Does this configuration support importing images.
bool AlwaysAddImageSuffix
When importing an image, this indicates if it should automatically add a standard suffix onto the name.
string AddedImageSuffix
If AlwaysAddImageSuffix is on, this is the suffix to be added.
string imageType
What is the default ImageType images are imported as. Options are: N/A, Diffuse, Normal, Metalness, Roughness, AO, ORMConfig, GUI, Cubemap.
string DiffuseTypeSuffixes
What type of suffixes are scanned to detect if an importing image is a diffuse map.
e.g. _Albedo or _Color
string NormalTypeSuffixes
What type of suffixes are scanned to detect if an importing image is a normal map.
e.g. _Normal or _Norm
string MetalnessTypeSuffixes
What type of suffixes are scanned to detect if an importing image is a metalness map.
e.g. _Metalness or _Metal
string RoughnessTypeSuffixes
What type of suffixes are scanned to detect if an importing image is a roughness map.
e.g. _roughness or _rough
string SmoothnessTypeSuffixes
What type of suffixes are scanned to detect if an importing image is a smoothness map.
e.g. _smoothness or _smooth
string AOTypeSuffixes
What type of suffixes are scanned to detect if an importing image is a ambient occlusion map.
e.g. _ambient or _ao
string PBRTypeSuffixes
What type of suffixes are scanned to detect if an importing image is a ORMConfig map.
e.g. _Composite or _PBR
string TextureFilteringMode
Indicates what filter mode images imported with this configuration utilizes. Options are Linear, Bilinear, Trilinear.
bool UseMips
Indicates if images imported with this configuration utilize mipmaps.
bool IsHDR
Indicates if images imported with this configuration are in an HDR format.
float Scaling
Indicates what amount of scaling images imported with this configuration use.
bool ImagesCompressed
Indicates if images imported with this configuration are compressed.
bool GenerateMaterialOnImport
Indicates if images imported with this configuration generate a parent material for it as well.
Sounds
bool importSounds
Indicates if sounds are imported with this configuration.
float VolumeAdjust
Indicates what amount the volume is adjusted on sounds imported with this configuration.
float PitchAdjust
Indicates what amount the pitch is adjusted on sounds imported with this configuration.
bool SoundsCompressed
Indicates if sounds imported with this configuration are compressed.
Public Functions
loadImportConfig(Settings configSettings, String configName)
Creates a new script asset using the targetFilePath.
The bool result of calling exec