Species Mod JSON Format - Revision history

SkyCorp: Reverted edits by CuteBen (talk) to last revision by Yaflow9

2023-08-03T02:33:33Z

Reverted edits by CuteBen (talk) to last revision by Yaflow9

@@ Line 4: / Line 4: @@
 == Fixed fields ==
 A "type" of "SPECIES" should be used when creating an entity mod. Here are the [[TF Type]] that exist natively.
 An "id" field should also be specified with the name of the transformation.   Be careful not to use the same id as another mod -- if you use the same mod name as your mod wiki page, you can be assured of no conflicts.

CuteBen: /* Fixed fields */

2020-04-07T14:27:35Z

Fixed fields

@@ Line 4: / Line 4: @@
 == Fixed fields ==
 A "type" of "SPECIES" should be used when creating an entity mod. Here are the [[TF Type]] that exist natively.
 An "id" field should also be specified with the name of the transformation.   Be careful not to use the same id as another mod -- if you use the same mod name as your mod wiki page, you can be assured of no conflicts.

Yaflow9: /* Added TF types */

2020-02-19T11:30:29Z

Added TF types

← Older revision		Revision as of 11:30, 19 February 2020
Line 4:		Line 4:

	== Fixed fields ==		== Fixed fields ==
	A "type" of "SPECIES" should be used when creating an entity mod.		A "type" of "SPECIES" should be used when creating an entity mod. Here are the [[TF Type]] that exist natively.

	An "id" field should also be specified with the name of the transformation. Be careful not to use the same id as another mod -- if you use the same mod name as your mod wiki page, you can be assured of no conflicts.		An "id" field should also be specified with the name of the transformation. Be careful not to use the same id as another mod -- if you use the same mod name as your mod wiki page, you can be assured of no conflicts.

SkyCorp: /* Dynamic fields */

2019-01-31T23:53:44Z

Dynamic fields

← Older revision		Revision as of 23:53, 31 January 2019
Line 62:		Line 62:
	\|-		\|-
	\|boolean		\|boolean
	\|'''checkPlayerMobile'''		\|'''checkPlayerMobile([[Map (Class)\|Map]] originalMap, int originalRoomID, [[Map (Class)\|Map]] newMap, int newRoom)'''
	Called when player attempts to move between rooms. This function can prevent player movement by returning false. If false is returned, a continue scene will be displayed so as to allow displayed text to be viewed by played, before returning to the map scene in the original room. Otherwise, it is not expected this function will output text to screen if movement is allowed, as it would most likely be eaten by the map scene for the next room.		Called when player attempts to move between rooms. This function can prevent player movement by returning false. If false is returned, a continue scene will be displayed so as to allow displayed text to be viewed by played, before returning to the map scene in the original room. Otherwise, it is not expected this function will output text to screen if movement is allowed, as it would most likely be eaten by the map scene for the next room.

Line 69:		Line 69:
	Generally, this function only needs to be overridden if you want to have an allfours/non-bipedal TF that isn't impeded by large breasts/belly (or has different chance for being impeded)		Generally, this function only needs to be overridden if you want to have an allfours/non-bipedal TF that isn't impeded by large breasts/belly (or has different chance for being impeded)

	(Introduced in r30)		(Introduced in r30, updated in r36 to pass additional parameters)
	\|-		\|-
	\|void		\|void
Line 102:		Line 102:

	(Introduced in r30)		(Introduced in r30)
	\|-\|}\|}\|}\|}\|}\|}\|}\|}\|}\|}		\|-\|}\|}\|}\|}\|}\|}\|}\|}\|}\|}\|}

SkyCorp at 01:43, 18 May 2018

2018-05-18T01:43:13Z

← Older revision		Revision as of 01:43, 18 May 2018
Line 58:		Line 58:

	Called on player's active legs to determine if player is quadrapedal / allfours mode. Defaults to bipedal.		Called on player's active legs to determine if player is quadrapedal / allfours mode. Defaults to bipedal.

			(Introduced in r30)
	\|-		\|-
	\|boolean		\|boolean
Line 66:		Line 68:

	Generally, this function only needs to be overridden if you want to have an allfours/non-bipedal TF that isn't impeded by large breasts/belly (or has different chance for being impeded)		Generally, this function only needs to be overridden if you want to have an allfours/non-bipedal TF that isn't impeded by large breasts/belly (or has different chance for being impeded)

			(Introduced in r30)
	\|-		\|-
	\|void		\|void
Line 72:		Line 76:

	Currently only called on the species of the player's legs, however, this may be expanded in future to be called once per movement for every active species, so please write your code to accommodate this. Note, if not explicitly defined, the default version of function provides flavor text / lust increase for if the player is on all fours and has large breasts or belly. (In future, there should be a way for mods to call this flavor text if they want to override tickMovement() -- maybe via superclass call?)		Currently only called on the species of the player's legs, however, this may be expanded in future to be called once per movement for every active species, so please write your code to accommodate this. Note, if not explicitly defined, the default version of function provides flavor text / lust increase for if the player is on all fours and has large breasts or belly. (In future, there should be a way for mods to call this flavor text if they want to override tickMovement() -- maybe via superclass call?)

			(Introduced in r30)
	\|-		\|-
	\|string		\|string
Line 87:		Line 93:
	* You stand (for bipedal mode)		* You stand (for bipedal mode)
	* You walk on all fours (for non-bipedal mode)		* You walk on all fours (for non-bipedal mode)
			(Introduced in r30)
	\|-		\|-
	\|string		\|string
Line 93:		Line 100:

	If not explicitly defined, the default version of this function returns 'stand'		If not explicitly defined, the default version of this function returns 'stand'
	\|-\|}\|}\|}\|}\|}\|}\|}\|}\|}
			(Introduced in r30)
			\|-\|}\|}\|}\|}\|}\|}\|}\|}\|}\|}

SkyCorp: /* Dynamic fields */

2018-05-18T01:42:10Z

Dynamic fields

← Older revision		Revision as of 01:42, 18 May 2018
Line 75:		Line 75:
	\|string		\|string
	\|'''getHeightDescription'''		\|'''getHeightDescription'''
	Returns the string the prefaces the player's current height. ~~examples~~:		Returns the string the prefaces the player's current height. Examples:
			* You stand
	~~<nowiki>~~*~~</nowiki>~~ You stand		* You crawl along on all fours
			* You worm along
	~~<nowiki>~~*~~</nowiki>~~ You crawl along on all fours

	~~<nowiki>~~*~~</nowiki>~~ You worm along

	This phrase is followed by 'at <height> tall,...'		This phrase is followed by 'at <height> tall,...'
Line 88:		Line 85:

	If not explicitly defined, the default version of this function will return:		If not explicitly defined, the default version of this function will return:
			* You stand (for bipedal mode)
	~~<nowiki>~~*~~</nowiki>~~ You stand (for bipedal mode)		* You walk on all fours (for non-bipedal mode)

	~~<nowiki>~~*~~</nowiki>~~ You walk on all fours (for non-bipedal mode)
	\|-		\|-
	\|string		\|string
Line 98:		Line 93:

	If not explicitly defined, the default version of this function returns 'stand'		If not explicitly defined, the default version of this function returns 'stand'
	\|-\|}\|}\|}\|}\|}\|}\|}\|}		\|-\|}\|}\|}\|}\|}\|}\|}\|}\|}

SkyCorp: /* Dynamic fields */

2018-05-18T01:41:28Z

Dynamic fields

← Older revision		Revision as of 01:41, 18 May 2018
Line 98:		Line 98:

	If not explicitly defined, the default version of this function returns 'stand'		If not explicitly defined, the default version of this function returns 'stand'
	\|-\|}\|}\|}\|}\|}\|}\|}		\|-\|}\|}\|}\|}\|}\|}\|}\|}

SkyCorp: /* Dynamic fields */

2018-05-18T01:40:19Z

Dynamic fields

@@ Line 74: / Line 74: @@
 |-
 |string
-|getHeightDescription
+|'''getHeightDescription'''
 |-
 |string
-|getPostureDescription
+|'''getPostureDescription'''
-|-|}|}|}|}|}|}
+Returns string representation of player's posture.  Default is 'stand'.  This is referred to when describing the player's legs, ie: 'You stand on human legs...'

SkyCorp: /* Dynamic fields */

2018-05-18T01:38:04Z

Dynamic fields

@@ Line 53: / Line 53: @@
 |'''hasUselessHands'''
 If true, will prevent the player from interacting with some objects in the game which require fine motor skills.  For instance, return true if the player has hooves for hands.
-|-|}|}|}|}|}
+|-

SkyCorp: hasUselessHands support

2018-05-15T20:48:16Z

hasUselessHands support

← Older revision		Revision as of 20:48, 15 May 2018
Line 49:		Line 49:
	\|'''getAlternateVocal'''		\|'''getAlternateVocal'''
	If the player has a non-human voice, what kind of noise do they make when trying to communicate?		If the player has a non-human voice, what kind of noise do they make when trying to communicate?
	\|-\|}\|}\|}\|}		\|-
			\|boolean
			\|'''hasUselessHands'''
			If true, will prevent the player from interacting with some objects in the game which require fine motor skills. For instance, return true if the player has hooves for hands.
			\|-\|}\|}\|}\|}\|}