Lua API Reference - Revision history

Sonic260: /* CBT-Based Attributes */

2026-05-02T20:18:08Z

CBT-Based Attributes

← Older revision		Revision as of 20:18, 2 May 2026
Line 459:		Line 459:

	==== CBT-Based Attributes ====		==== CBT-Based Attributes ====
	These are the attributes based on the [[Console Commands#CBT - Custom Bone Transforms\|Custom Bone Transforms]] command, and changing them either through lua or the console will make them reflect the same value~~. Although you can enter a value between 0 and 1.5 for each of them, it seems they will actually capped between 0.6 and 1.05~~.		These are the attributes based on the [[Console Commands#CBT - Custom Bone Transforms\|Custom Bone Transforms]] command, and changing them either through lua or the console will make them reflect the same value.
	{\| class="wikitable" style="width: 100%"		{\| class="wikitable" style="width: 100%"
	! Property Name		! Property Name

Sonic260: /* Physical Attributes */

2026-05-01T17:54:00Z

Physical Attributes

@@ Line 456: / Line 456: @@
 |float
 |Amount of Iguapi (gorilla-like) mouth protusion. Will also affect foot shape. Max is 2.0
 |}

Sonic260: /* Orc Functions */ As with Orc Properties, Orc Functions must be called on the orc. instance.

2026-02-26T19:03:23Z

Orc Functions: As with Orc Properties, Orc Functions must be called on the orc. instance.

← Older revision		Revision as of 19:03, 26 February 2026
Line 609:		Line 609:

	== Orc Functions ==		== Orc Functions ==
			As with [[Lua API Reference#Orc Properties\|Orc Properties]], Orc Functions must be called on the '''orc.''' instance.

	=== Code Execution / Management ===		=== Code Execution / Management ===

Sonic260: /* Misc Functions */ Adds orc.cc() to orc.consolecommand() 's description.

2026-02-01T21:53:08Z

Misc Functions: Adds orc.cc() to orc.consolecommand() 's description.

← Older revision		Revision as of 21:53, 1 February 2026
Line 886:		Line 886:
	\|-		\|-
	\| consolecommand		\| consolecommand
			cc
	\| void		\| void
	\| consolecommand(''command'':string)		\| consolecommand(''command'':string)
			cc(''command:''string)
	\|		\|
	Executes a console command (including a '''batch''' command). The default target is the Orc instance calling the function.		Executes a console command (including a '''batch''' command). The default target is the Orc instance calling the function.

			This function can be abbreviated as "'''cc'''" instead.

	During online play, this function cannot be used on Orcs who do not share consent with the caster, or are outside of PVP mode.		During online play, this function cannot be used on Orcs who do not share consent with the caster, or are outside of PVP mode.

Sonic260: /* Physical Attributes */

2026-01-13T19:51:03Z

Physical Attributes

← Older revision		Revision as of 19:51, 13 January 2026
Line 448:		Line 448:
	\| tusksize		\| tusksize
	tusksizer		tusksizer

	tusksizel		tusksizel
	\| float		\| float

Sonic260: /* Physical Attributes */ Adds orc.tusksizer and orc.tusksizel

2026-01-13T19:49:38Z

Physical Attributes: Adds orc.tusksizer and orc.tusksizel

← Older revision		Revision as of 19:49, 13 January 2026
Line 447:		Line 447:
	\|-		\|-
	\| tusksize		\| tusksize
			tusksizer
			tusksizel
	\| float		\| float
	\|		\|

Sonic260: /* Physical Properties */ Added muscle clamp note. Clarified that the alpha value for eye color controls eye glow.

2026-01-13T18:24:33Z

Physical Properties: Added muscle clamp note. Clarified that the alpha value for eye color controls eye glow.

← Older revision		Revision as of 18:24, 13 January 2026
Line 254:		Line 254:

	In the place of ''RGBIndex'', you would pass in a value between 1-4, which corresponds to the Red, Green, Blue, and Alpha channels respectively.		In the place of ''RGBIndex'', you would pass in a value between 1-4, which corresponds to the Red, Green, Blue, and Alpha channels respectively.

			The Alpha channel (4), determines the amount the eyes will glow

	\|-		\|-
Line 262:		Line 264:

	All parameters would be an integer value between 0-255.		All parameters would be an integer value between 0-255.

			The Alpha channel (''colorA'') sets by how much the eyes will glow, 0 being not at all, while 255 being at max brightness.
	\|-		\|-
	\|facetaper		\|facetaper
Line 363:		Line 367:
	\| muscle		\| muscle
	\| float		\| float
	\|		\|If muscle is set to 0, it will clamp to 0.25
	\|-		\|-
	\|nipplesize		\|nipplesize
Line 397:		Line 401:
	\|		\|
	\|-		\|-
	\|scleracolor_get		\|scleracolor_get()
	\|int		\|int
	\|An orc function to ~~set~~ the numerical value of a specific eye sclera color channel. To use it write:		\|An orc function to get the numerical value of a specific eye sclera color channel. To use it write:
	'''orc.~~scleracolor_set~~'''(''~~colorR''~~:int, ''~~colorG~~''~~:int,~~ ''~~colorB'':int~~, ~~''colorA'':int)~~		'''orc.scleracolor_get'''(''RGBIndex:int'')

			In the place of ''RGBIndex'', you would pass in a value between 1-4, which corresponds to the Red, Green, Blue, and Alpha channels respectively.

	~~All parameters would be an integer value between 0-255.~~		The Alpha channel (4), determines the amount the eyes will glow
	\|-		\|-
	\|~~scleracolor_set~~		\|scleracolor_se()t
	\|void		\|void
	\|An orc function to set the numerical value of a specific eye sclera color channel. To use it write:		\|An orc function to set the numerical value of a specific eye sclera color channel. To use it write:
Line 410:		Line 416:

	All parameters would be an integer value between 0-255.		All parameters would be an integer value between 0-255.

			The Alpha channel (''colorA'') sets by how much the eyes will glow, 0 being not at all, while 255 being at max brightness.
	\|-		\|-
	\| skincolormid_*		\| skincolormid_*

Sonic260: /* Physical Attributes */ Updated orc.footsize's max value

2026-01-03T00:21:06Z

Physical Attributes: Updated orc.footsize's max value

← Older revision		Revision as of 00:21, 3 January 2026
Line 269:		Line 269:
	\| footsize		\| footsize
	\| float		\| float
	\|		\|Max is 1.5
	\|-		\|-
	\|hair()		\|hair()

Sonic260: Adds orc.isforeplaying, orc.game.isspiritualscene, and orc.sexfdoggy1()

2026-01-02T18:25:15Z

Adds orc.isforeplaying, orc.game.isspiritualscene, and orc.sexfdoggy1()

← Older revision		Revision as of 18:25, 2 January 2026
Line 513:		Line 513:
	\| bool		\| bool
	\| Returns true if the instance is in a sex animation (This includes Self-Action, and Handjobs in the Bath House)		\| Returns true if the instance is in a sex animation (This includes Self-Action, and Handjobs in the Bath House)
			\|-
			\|isforeplaying
			\|bool
			\|Returns true if the instance is foreplaying with another instance (kissing)
	\|-		\|-
	\|sextop		\|sextop
Line 721:		Line 725:
	\| Starts the missionary style sex scene at the nearest circle.		\| Starts the missionary style sex scene at the nearest circle.
	\|-		\|-
	\|~~sexdoggy1~~		\|sexsdoggy1
	\|void		\|void
	\|sexdoggy1()		\|sexdoggy1()
	sexdoggy1(''target'':Orc)		sexdoggy1(''target'':Orc)
	\|Starts the standing doggy style ~~scene where~~ the ~~orc is standing~~. If ~~no parameter~~ is specified, the ~~orc~~ will ~~instead~~ play the "invite" pose.		\|Starts the invite pose standing doggy style animation. If a target is specified, the target instead will play the "invite" pose.
			\|-
			\|sexfdoggy1
			\|void
			\|sexfdoggy1()
			sexfdoggy1(target:Orc)
			\|Starts the invite pose for the floor doggy style animation. If a target is specified, the target instead will play the "invite" pose.
	\|-		\|-
	\| sex69		\| sex69
Line 967:		Line 977:
	\|string		\|string
	\|Returns the current scene, or captures the name of the upcoming scene when using the '''travel''' command, or walking through a portal.		\|Returns the current scene, or captures the name of the upcoming scene when using the '''travel''' command, or walking through a portal.
			\|-
			\|isspiritualscene
			\|bool
			\|Returns true if the current scene is sacred (Cutscenes, Bonfires, Ka, Kurtar encounters, etc)
	\|}		\|}

Sonic260: /* Physical Attributes */ Adds noseupturn, noselength,nosebulbuos, facetaper, and nipplesize

2026-01-02T17:53:49Z

Physical Attributes: Adds noseupturn, noselength,nosebulbuos, facetaper, and nipplesize

@@ Line 185: / Line 185: @@
 ! Type
 ! Description / Usage
 |-
 | ballsize
@@ Line 258: / Line 262: @@
 All parameters would be an integer value between 0-255.
 |-
 | footsize
@@ Line 358: / Line 366: @@
 |-
 |nipplesize
 |float
+|