Docs

GenerateImageFile Action

 

Mods Studio 2 version: 2019.07 or newer

Written on: November 20th, 2019

 

GenerateImageFile Action creates an image file of the requested size and fills it with requested color. Saves it in the requested format.

Parameters

Parameter name Parameter type Supports variables Parameter description
Destination string Yes This is the path to the image that will get generated. It's relative to TempModBuildDirectory.
Fill string Yes At the moment, this parameter accepts a variable pointer. Variable pointers are variable names closed in square brackets, eg.: [BaseColor] - this would fill the generated image with the color that was set in the BaseColor color variable that exists in the same template.
Dimension Size No This defines the width and height of the newly created image. See below for details.
OutputFormat OutputImageFormat No This defines the output format of the newly created image. See below for details.

 

Note: Fill parameter will get an update that will add support for hex colors, as well as basic color names, etc... Please let us know if this is something you need!

Note: If the Fill parameter isn't resolved properly, the fill color will be set to transparent.

Dimension Parameter

Parameter name Parameter type Supports variables Parameter description
Width integer No This defines the width of the newly created image
Height integer No This defines the height of the newly created image

 

OutputImageFormat Parameter

Parameter name Parameter type Supports variables Parameter description
Format ImageFormats No This defines the format of the generated image. Currently supported formats: Dds and Jpg.
Preset ImagePresets No We have some presets available for images that can be requested as output formats: Default, ScsSkinImage and ScsIconImage.

 

Note: Png will soon be added to the list of supported export formats. Please let us know if this is something you need!

Note: Presets only work with Dds format.

Comments

Leave a comment

Please note that we won't show your email to others, or use it for sending unwanted emails. We will only use it to render your Gravatar image and to validate you as a real person.