Modding:BodyDescription - Revision history

SkyCorp: Add sample code link

2026-02-04T02:06:07Z

Add sample code link

← Older revision		Revision as of 02:06, 4 February 2026
Line 57:		Line 57:

	== Sample code ==		== Sample code ==
	See ~~SetOwnerWithScene~~ sample for an example of body description in use.<syntaxhighlight lang="lua">		See [https://skycorp.global/skyscript/mods/v/96/sample-claim-ownership Claim Ownership] sample for an example of body description in use.<syntaxhighlight lang="lua">
	-- Placed in global scope so it runs on load.		-- Placed in global scope so it runs on load.
	bodyDescription = BodyDescription.generateNew();		bodyDescription = BodyDescription.generateNew();

SkyCorp: Small typo fix

2026-01-09T22:57:00Z

Small typo fix

← Older revision		Revision as of 22:57, 9 January 2026
Line 67:		Line 67:
	bodyDescription.setUniqueBodyPartDescription("TEETH", "fangs");		bodyDescription.setUniqueBodyPartDescription("TEETH", "fangs");
	-- etc...		-- etc...
	this.~~setBodyPartDescription~~(bodyDescription);		this.setBodyDescription(bodyDescription);
	</syntaxhighlight>		</syntaxhighlight>

	[[Category:LUA Class Reference]]		[[Category:LUA Class Reference]]

SkyCorp: Also tag for lua class reference page category

2026-01-09T22:52:26Z

Also tag for lua class reference page category

← Older revision		Revision as of 22:52, 9 January 2026
Line 69:		Line 69:
	this.setBodyPartDescription(bodyDescription);		this.setBodyPartDescription(bodyDescription);
	</syntaxhighlight>		</syntaxhighlight>

			[[Category:LUA Class Reference]]

SkyCorp: Body description lua class

2026-01-09T22:51:41Z

Body description lua class

New page

This class lets you describe an NPC's appearance. [[Modding:Text Variables|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.<syntaxhighlight lang="lua">
-- 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);
</syntaxhighlight>