Monster Advanced JSON Mod Format - Revision history

SkyCorp: fix broken link

2025-09-10T07:08:41Z

fix broken link

← Older revision		Revision as of 07:08, 10 September 2025
Line 6:		Line 6:

	== Example ==		== Example ==
	See [~~[Sample~~: ~~Monster Advanced Example\|~~this sample]] for an example of this monster in action.		See [https://skycorp.global/skyscript/mods/v/29/sample-monster-advanced-example this sample] for an example of this monster in action.

	== Fixed Fields ==		== Fixed Fields ==

SkyCorp: /* Dynamic Fields */

2018-12-29T00:06:02Z

Dynamic Fields

← Older revision		Revision as of 00:06, 29 December 2018
Line 106:		Line 106:
	* You should probably also reset the monster's health via this.resetHPLust().		* You should probably also reset the monster's health via this.resetHPLust().
	* You should probably also reset player's lust, hp, and pregnancy		* You should probably also reset player's lust, hp, and pregnancy
			* Set monster state to REST
	\|-		\|-
	\|void		\|void

SkyCorp: /* Dynamic Fields */

2018-12-29T00:01:10Z

Dynamic Fields

← Older revision		Revision as of 00:01, 29 December 2018
Line 101:		Line 101:

	If overriding this function and not calling the default monster victory, be sure to:		If overriding this function and not calling the default monster victory, be sure to:
	* ~~End~~ this function with a player respawn ~~or a~~ continue scene ~~or game will soft lock.~~		* Game will soft lock if you do not end this function with a continue! Either do a:
			** player respawn (not currently exposed in r35)
			** continue scene
	* You should probably also reset the monster's health via this.resetHPLust().		* You should probably also reset the monster's health via this.resetHPLust().
	* You should probably also reset player's lust, hp, and pregnancy		* You should probably also reset player's lust, hp, and pregnancy

SkyCorp: /* Dynamic Fields */

2018-12-28T23:58:23Z

Dynamic Fields

← Older revision		Revision as of 23:58, 28 December 2018
Line 99:		Line 99:
	\|'''doMonsterVictory'''		\|'''doMonsterVictory'''
	The monster just won, so let them have their way with the player. This could be a one-scene defeat & respawn, or a full transformation sequence. (Note, as of r35, the functions necessary to have a multiple page sequence are not currently exposed, but could fall through to the default version of this function to do a full TF sequence).		The monster just won, so let them have their way with the player. This could be a one-scene defeat & respawn, or a full transformation sequence. (Note, as of r35, the functions necessary to have a multiple page sequence are not currently exposed, but could fall through to the default version of this function to do a full TF sequence).

			If overriding this function and not calling the default monster victory, be sure to:
			* End this function with a player respawn or a continue scene or game will soft lock.
			* You should probably also reset the monster's health via this.resetHPLust().
			* You should probably also reset player's lust, hp, and pregnancy
	\|-		\|-
	\|void		\|void

SkyCorp: /* Dynamic Fields */

2018-12-28T23:22:16Z

Dynamic Fields

← Older revision		Revision as of 23:22, 28 December 2018
Line 98:		Line 98:
	\|void		\|void
	\|'''doMonsterVictory'''		\|'''doMonsterVictory'''
	The monster just won, so let them have their way with the player. This could be a one-scene defeat & respawn, or a full transformation sequence.		The monster just won, so let them have their way with the player. This could be a one-scene defeat & respawn, or a full transformation sequence. (Note, as of r35, the functions necessary to have a multiple page sequence are not currently exposed, but could fall through to the default version of this function to do a full TF sequence).
	\|-		\|-
	\|void		\|void

SkyCorp at 07:02, 28 December 2018

2018-12-28T07:02:01Z

← Older revision		Revision as of 07:02, 28 December 2018
Line 105:		Line 105:
	\|}		\|}
	Note that while the usual '''name''' dynamic field is supported, it is not recommenced to be used. If set, it will not update when the monster is defeated or asleep. Instead, use the fixed field via initialValues.name (see above).		Note that while the usual '''name''' dynamic field is supported, it is not recommenced to be used. If set, it will not update when the monster is defeated or asleep. Instead, use the fixed field via initialValues.name (see above).

			== Non-overrideable Functions ==
			See the [[MonsterAdvanced\|Monster Advanced API]] page for a list of functions that Monster Advanced scripts have access to, including a number of private functions. These can be accessed from the 'this' keyword.

SkyCorp at 06:58, 28 December 2018

2018-12-28T06:58:07Z

← Older revision		Revision as of 06:58, 28 December 2018
Line 61:		Line 61:
	\|void		\|void
	\|'''tickRest'''		\|'''tickRest'''
			Called when the monster is resting, waiting for the player. Note: this is called even if player isn't in same room as monster.

	\|-		\|-
	\|void		\|void
	\|'''tickAttack'''		\|'''tickAttack'''
			Called when the monster is attacking the player. Note: this is called even if player isn't in same room as monster (and would normally change the state to resting).
	\|-		\|-
	\|void		\|void
	\|'''tickDefeat'''		\|'''tickDefeat'''
			Called when the monster is defeated by player while still usable by player Note: this is called even if player isn't in same room as monster.
	\|-		\|-
	\|void		\|void
	\|'''tickSleep'''		\|'''tickSleep'''
			Called when the monster is asleep (after being defeated by player). Note: this is called even if player isn't in same room as monster.
	\|-		\|-
	\|void		\|void
	\|'''resetHPLust'''		\|'''resetHPLust'''
			Called when the monsters HP & Lust should return to fully healed values. IE: On sleep.
	\|-		\|-
	\|boolean		\|boolean
	\|'''isAttackable'''		\|'''isAttackable'''
			Determines whether attack & lust buttons will be shown in UI. Defaults to showing them whenever not in sleep state.
	\|-		\|-
	\|void		\|void
	\|'''doAttackPhysical'''		\|'''doAttackPhysical'''
			The player has executed a physical attack on this object. Will check if the player is prevented from attacking and if the strike hits. There's a lot of logic here, so if you override this and still want to do the usual logic, call this.defaultDoAttackPhysical() to fall through to the usual attack logic.
	\|-		\|-
	\|void		\|void
	\|'''doAttackLust'''		\|'''doAttackLust'''
			Same as doAttackPhysical, but for lust.
	\|-		\|-
	\|void		\|void
	\|'''beginSleep'''		\|'''beginSleep'''
			Enters sleep state (sets state and amount of sleep turns to sleep for).
	\|-		\|-
	\|void		\|void
	\|'''doMonsterVictory'''		\|'''doMonsterVictory'''
			The monster just won, so let them have their way with the player. This could be a one-scene defeat & respawn, or a full transformation sequence.
	\|-		\|-
	\|void		\|void
	\|'''rewardDrop'''		\|'''rewardDrop'''
			Called on the winning attack by the player -- drops a random reward (ie: cash, item, etc). Override this to drop something specific.
	\|}		\|}
	Note that while the usual '''name''' dynamic field is supported, it is not recommenced to be used. If set, it will not update when the monster is defeated or asleep. Instead, use the fixed field via initialValues.name (see above).		Note that while the usual '''name''' dynamic field is supported, it is not recommenced to be used. If set, it will not update when the monster is defeated or asleep. Instead, use the fixed field via initialValues.name (see above).

SkyCorp at 06:51, 28 December 2018

2018-12-28T06:51:00Z

← Older revision		Revision as of 06:51, 28 December 2018
Line 4:		Line 4:

	(All [[Entity Mod JSON Format\|Entity JSON]] parameters are also supported!)		(All [[Entity Mod JSON Format\|Entity JSON]] parameters are also supported!)

			== Example ==
			See [[Sample: Monster Advanced Example\|this sample]] for an example of this monster in action.

	== Fixed Fields ==		== Fixed Fields ==
Line 9:		Line 12:

	'''id''' and '''customPublicFunctions''' are also supported (see entity JSON docs for details), don't forget to set id if you plan to have multiple custom monsters loaded at a time.		'''id''' and '''customPublicFunctions''' are also supported (see entity JSON docs for details), don't forget to set id if you plan to have multiple custom monsters loaded at a time.

			For setting up the below values, you may want to use [[Creating a Monster Mod\|SCLab]] to generate a base simple monster (Monster Code), test it a bit, then update its type to MONSTERADVANCED, and move the parameters around into the correct structure.

	=== initialValues ===		=== initialValues ===
Line 25:		Line 30:
	* inseminationAttemptOnPlayerVictory		* inseminationAttemptOnPlayerVictory
	* inseminationAttemptOnPlayerDefeat		* inseminationAttemptOnPlayerDefeat
	~~defaultText~~

			=== defaultText ===
	This collection of text follows the format of Monster Mods. These key-value pairs are supported:		This collection of text follows the format of Monster Mods. These key-value pairs are supported:
	* alert		* alert
Line 35:		Line 40:
	* playerUse		* playerUse
	* playerDefeat		* playerDefeat

			=== defeatTf ===
			If set, and if the default monster victory function is called, then will cause the player to TF.

			This collection follows the format of Monster Mods. These key-value pairs are supported:
			* tfTime
			* tfTotal
			* tfEscapeFailure
			* tfEscapeSuccess
			* tfAccept
			* bodyType

	== Dynamic Fields ==		== Dynamic Fields ==
Line 42:		Line 58:
	!Return Type		!Return Type
	!Parameter		!Parameter
			\|-
			\|void
			\|'''tickRest'''

			\|-
			\|void
			\|'''tickAttack'''
			\|-
			\|void
			\|'''tickDefeat'''
			\|-
			\|void
			\|'''tickSleep'''
			\|-
			\|void
			\|'''resetHPLust'''
	\|-		\|-
	\|boolean		\|boolean
	\|'''~~isVulnerableToMasculineTheft~~'''		\|'''isAttackable'''
	~~If true, this item can be lost in situations where masculine clothes are lost (currently only the thief scene).~~		\|-
			\|void
			\|'''doAttackPhysical'''
	\|-		\|-
	\|~~boolean~~		\|void
	\|'''~~isConcealableClothing~~'''		\|'''doAttackLust'''
	~~If true, this item can conceal a transformation in the slot it is in (true for most clothing items).~~		\|-
			\|void
			\|'''beginSleep'''
			\|-
			\|void
			\|'''doMonsterVictory'''
	\|-		\|-
	\|~~string~~		\|void
	\|'''~~getSlot~~'''		\|'''rewardDrop'''
	~~Which [[Clothing slot\|slot]] the clothes exists in.~~

	~~This should almost certainly be a literal string -- changing this value during run-time will lead to unknown results.~~
	\|}		\|}
	Note that while the usual '''name''' field is supported, it is not recommenced to be used. If set, it will not update when the monster is defeated or asleep. Instead, use the fixed field initialValues.name (see above).		Note that while the usual '''name''' dynamic field is supported, it is not recommenced to be used. If set, it will not update when the monster is defeated or asleep. Instead, use the fixed field via initialValues.name (see above).

SkyCorp at 06:42, 28 December 2018

2018-12-28T06:42:55Z

@@ Line 1: / Line 1: @@
-'''Monster Advanced''' is a special type of entity which combines the power of LUA driven entities with the existing Monster Mods system.
+'''Monster Advanced''' is a special type of entity which combines the power of LUA driven entities with the existing Monster Mods system.  It is one of the hardest types of entities to create, so it is recommended to start with a simpler mod type before creating a Monster Advanced.
 Monster Advanced JSON supports a variety of parameters to create custom monsters.  JSON definitions can specify each as programmable (LUA) or literal values.
@@ Line 5: / Line 5: @@
 (All [[Entity Mod JSON Format|Entity JSON]] parameters are also supported!)
-Note that Monster Advanced entities uses a type of 'MONSTERADVANCED' instead of 'ENTITY'
+== Fixed Fields ==
 {| class="wikitable"
@@ Line 25: / Line 57: @@
 This should almost certainly be a literal string -- changing this value during run-time will lead to unknown results.
 |}

SkyCorp at 06:33, 28 December 2018

2018-12-28T06:33:56Z

← Older revision		Revision as of 06:33, 28 December 2018
Line 6:		Line 6:

	Note that Monster Advanced entities uses a type of 'MONSTERADVANCED' instead of 'ENTITY'		Note that Monster Advanced entities uses a type of 'MONSTERADVANCED' instead of 'ENTITY'

			{\| class="wikitable"
			!Return Type
			!Parameter
			\|-
			\|boolean
			\|'''isVulnerableToMasculineTheft'''
			If true, this item can be lost in situations where masculine clothes are lost (currently only the thief scene).
			\|-
			\|boolean
			\|'''isConcealableClothing'''
			If true, this item can conceal a transformation in the slot it is in (true for most clothing items).
			\|-
			\|string
			\|'''getSlot'''
			Which [[Clothing slot\|slot]] the clothes exists in.

			This should almost certainly be a literal string -- changing this value during run-time will lead to unknown results.
			\|}