Image Layers¶

ChangeImageFor - DEPRECATED.¶

Warning

Will be removed in a future update. See ChangeImageLayer for its replacement, and breakingchange for a general overview.

Changes the image of a displayed character. The number represents which of the characters that are currently being displayed will have their image changed. In combat, it will change the focused monster instead of a specific one. Typically for characters that don't make use of layers.

"ChangeImageFor", "1", "ImageName"

In combat with "FocusOnMonster":

"FocusOnMonster", "1", "ChangeImageFor", "ImageName"

ChangeImageLayer¶

Changes a specific layer of art for the specified character in the scene, works almost the same as above. If you set the image name to "" or "None", it will stop displaying the layer. Excluding layers with "alwaysOn": enabled. When using |f|ChangeImageLayer|/| type function, to stop displaying the layer you need to use "None".

"ChangeImageLayer", "LayerType", "1", "ImageName"

Make sure the LayerType field is the same as that layer's name in the monster's json.

Instead of a number, you can instead use a Monster's nameID. It will change their layer regardless of what position they are in from DisplayCharactersFunc. It's also useful for tracking whose face you're changing.

however while in an active combat, for both the monsters file and combat events, the number/selection field should be ignored like this, which is applicable to ANY image layer related function for selection:

"ChangeImageLayer", "LayerType", "ImageName"

ActiveOverlay & DeactivateOverlay¶

"ChangeImageLayer", "RightArm", "1", "ActivateOverlay"

"ChangeImageLayer", "LeftArm", "1", "DeactivateOverlay"

"ActivateOverlay" and "DeactivateOverlay" toggles the visibility of a layer.

ImageSet & ImageSetPersist¶

"ChangeImageLayer", "ImageSet", "1", "Plush"

"ImageSet" will swap a set of images to the name of the set in the final string as seen above. It will automatically carry over any current expressions and related. Note this is not held persistently and would need to be called every time the character is called.

"ImageSetPersist" will swap to the stated image set and stay on it whenever that character is called again, even in combat. Used for Aiko's body type variants.

"ChangeImageLayer", "ImageSetPersist", "1", "Plush"

ImageSetDontCarryOver¶

Gives the ability to use Image Sets as alternate CGs without needing to be the exact same layer layout as the other sets.

"ChangeImageLayer", "ImageSetDontCarryOver", "1", "Hypno"

ImageSetRoleStart¶

For combat only. Starts the given image set CG in the final string.

See CGRoles for more information on role CGs.

"ChangeImageLayer", "ImageSetRoleStart", "1", "Sex"

ForEvery¶

"ForEvery" can be alternatively given in place of the speaker value. You use it to change every instance of the given monster to the assigned expression.

Optionally, you can use a "Random" block closed with "EndLoop" to randomly select from a number of expressions for each instance of the monster.

"ChangeImageLayer", "Expression", "ForEvery", "Imp", "Sleeping",
"ChangeImageLayer", "Expression", "ForEvery", "Imp", "Random" "Smile", "Smug", "XD", "EndLoop",

This is optimal for performance and convenience when setting an expression for multiples of the same generic monster in a scene.

ForSpecific¶

"ForSpecific" can be alternatively given in place of the speaker value. You can change the image layer in mass for specific instances of a given monster type based on their order of instance in the scene, rather than the order they are displayed.

Take the example:

"ChangeImageLayer", "Expression", "ForSpecific", "Imp",
  "3" "Smile", "8", "Smug",
"EndLoop",
"ChangeImageLayer", "Blush", "ForSpecific", "Imp",
  "2" "Blush", "5", "",
"EndLoop",

If there are 8 imps present, the 8th imp will have a smug expression, even if it is the 12th displayed character.

If there are only 3, even if the 3rd imp is the 8th displayed monster, it will not be set to the smug expression, it will be set to the smile expression, as that is what the third imp present is being set to.

RoledCGEnd¶

Turns off any active role-based CG started via ImageSetRoleStart.

If the CG doesn't have any "ActiveRequirment" keys to turn it off, this must be called before leaving the encounter.

See CGRoles for more information on role CGs.

"RoledCGEnd"

AnimateImageLayer¶

Can override a specific layer of a character to do frame by frame animation on a loop, primarily for CG usage. Up to 3 separate layers can be animated. Check Aiko's titfuck scene in BedMimic.json for an example of this in use.

"AnimateImageLayer", "Animation2", "LayerTarget", "CharacterTarget", "1.5",
    "Monsters/Aiko/Paizuri/AikoBoobs__AikoPaizuri_Titfuck.png",
    "Monsters/Aiko/Paizuri/AikoBoobsSqueeze__AikoPaizuri_Titfuck.png",
"EndLoop",

Disambiguation in order of strings used in the first row:

String	Description
`"AnimateImageLayer"`	Declares the function.
`"Animation2"`	Which of the three animation channels you're using, ranging across: `"Animation"`, `"Animation2"`, & `Animation3"`.
`"LayerTarget"`	Which layer on the character you're targeting, e.g.: `"Expression"`
`"CharacterTarget"`	The character in the scene you're targeting, like ChangeImageLayer, you can pick speaker number or nameID. e.g.: `"Aiko"` & `"1"`
`"1.5"`	The number of seconds passed before the animation moves to the next frame in the list.

After this is a list of the images you want it to swap to which must be acquired manually and can't be called from the lists in the monster file.

To end an animation, you need to call a blank use of the function:

"AnimateImageLayer", "", "LayerTarget", "CharacterTarget", "0",  "EndLoop",

Else the animation will continue to play.