Modding:BodyDescription

From SkyCorp Global
Revision as of 22:51, 9 January 2026 by SkyCorp (talk | contribs) (Body description lua class)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This class lets you describe an NPC's appearance. Text variables can then use this appearance data in scenes.

Static Methods

static public BodyDescription generateNew()

Creates a new body description.

Note that it must be assigned to the NPC after you finish configuring it!

Public Methods

void setBreastSize(int breastSize)

Size of breasts -- uses same scale used by player class

int getBreastSize()

void setBreastRows(int breastRows)

Number of rows of breasts

int getBreastRows()

void setDickSize(int dickSize)

Size of dick -- uses same scale as player class

int getDickSize()

void setVaginaSize(int vaginaSize)

Size of vagina -- uses same scale as player class

int getVaginaSize()

void setDexterous(bool dexterous)

Does the character have dexterous hands? False if no hands, hands are bound, or non-dexterous paws

bool isDexterous()

bool getHasAlternateVoice()

If the NPC is incapable of normal human speech (also see Vocal string below).

void setHasAlternateVoice(bool hasAlternateVoice)

string getAlternateVocalString()

If NPC is incapable of normal human speech (alternate vocal bool above), then what noise do they produce instead?

void setAlternateVocalString(string alternateVocalString)

bool getBipedal()

If the NPC walks on two legs

void setBipedal(bool bipedal)

void setUniqueBodyPartDescription(string bodyPartName, string description)

Can set a description for a body part for specific flavor.

string getBodyPartDescription(string bodyPartName)

Tries to get the body part description, if one is defined. If unavailable, just returns ""

Sample code

See SetOwnerWithScene sample for an example of body description in use.

-- Placed in global scope so it runs on load.
bodyDescription = BodyDescription.generateNew();
bodyDescription.setBreastSize(4); -- D Cup
bodyDescription.setBreastRows(2);
bodyDescription.setDickSize(10); -- Inches
bodyDescription.setVaginaSize(2);
bodyDescription.setUniqueBodyPartDescription("HANDS", "oversized paws");
bodyDescription.setUniqueBodyPartDescription("TEETH", "fangs");
-- etc...
this.setBodyPartDescription(bodyDescription);