Species: Difference between revisions
(Created page with "Represents a particular transformation the player can undergo.") |
(New TF modding functions!) |
||
(2 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
Represents a particular transformation the player can undergo. | Represents a particular transformation the player can undergo. | ||
== Public Static Methods == | |||
=== static Map getSpecies(string speciesName) === | |||
Gets species object from species name (ID string). Returns null if species with that name can not be found. | |||
== Public Methods == | |||
=== string getID() === | |||
Gets species name (ID) of this TF | |||
=== void causeTF() === | |||
Causes one step of this transformation to be applied to the player. Text will be output to screen. | |||
=== int countPlayerPartsOfThisType() === | |||
Returns the number of body parts transformed into this species type | |||
=== int getSeverityTFed([[BodyPart]] bodyPart) === | |||
Gets how severly the player is transformed to THIS type of species for this body part. | |||
IE, a fox tf would return 0 if the player is a level 0 human, or a level 1 cat, because they're not at all fox tf'ed. | |||
=== bool getIsFullyTransformed() === | |||
If player is as transformed into this species as they possibly can be. If not, causeTF() should cause the player to be TF'ed further. | |||
=== string getBodyPartDescription([[BodyPart]] bodyPart, int severity) === | |||
Get a text description for what a body part at a given severity of transformation looks like. | |||
Note that it is usually just easier to use text parsing variables if you're describing the player at their current state. | |||
=== bool hasAlternateVoice() === | |||
With a non-human voice, players will have difficulty communicating with humans. (False for normal english speech) | |||
=== string getAlternateVocal() === | |||
If the player has a non-human voice, what kind of noise do they make when trying to communicate? | |||
=== bool tfBreast() === | |||
Increases player's breast size up to the ''minimumTargetBreastSize'' property. Returns true if any TF was performed. | |||
=== bool tfNoPenisOneVagina() === | |||
Will TF player towards having one vagina and no penis (shrink dick then grow vagina). Will also cause breast growth if ''minimumTargetBreastSize'' is set (it calls tfBreast()). | |||
If there is a reason player must have a penis, then don't affect penis but still grow vagina. For instance, a male player wearing a cursed cock ring will result in a futa character. | |||
Returns true if any TF was performed. | |||
== Private Variables == | |||
=== int minimumTargetBreastSize === | |||
How big player breasts should be due to this transformation. Repeated calls to tfBreast() or tfNoPenisOneVagina() will increase player's breast size to these. See [[Player#int getBreastSize.28.29|Player.GetBreastSize()]] for size reference. | |||
<br /> | |||
[[Category:LUA Class Reference]] |
Latest revision as of 01:24, 4 August 2023
Represents a particular transformation the player can undergo.
Public Static Methods
static Map getSpecies(string speciesName)
Gets species object from species name (ID string). Returns null if species with that name can not be found.
Public Methods
string getID()
Gets species name (ID) of this TF
void causeTF()
Causes one step of this transformation to be applied to the player. Text will be output to screen.
int countPlayerPartsOfThisType()
Returns the number of body parts transformed into this species type
int getSeverityTFed(BodyPart bodyPart)
Gets how severly the player is transformed to THIS type of species for this body part.
IE, a fox tf would return 0 if the player is a level 0 human, or a level 1 cat, because they're not at all fox tf'ed.
bool getIsFullyTransformed()
If player is as transformed into this species as they possibly can be. If not, causeTF() should cause the player to be TF'ed further.
string getBodyPartDescription(BodyPart bodyPart, int severity)
Get a text description for what a body part at a given severity of transformation looks like.
Note that it is usually just easier to use text parsing variables if you're describing the player at their current state.
bool hasAlternateVoice()
With a non-human voice, players will have difficulty communicating with humans. (False for normal english speech)
string getAlternateVocal()
If the player has a non-human voice, what kind of noise do they make when trying to communicate?
bool tfBreast()
Increases player's breast size up to the minimumTargetBreastSize property. Returns true if any TF was performed.
bool tfNoPenisOneVagina()
Will TF player towards having one vagina and no penis (shrink dick then grow vagina). Will also cause breast growth if minimumTargetBreastSize is set (it calls tfBreast()).
If there is a reason player must have a penis, then don't affect penis but still grow vagina. For instance, a male player wearing a cursed cock ring will result in a futa character.
Returns true if any TF was performed.
Private Variables
int minimumTargetBreastSize
How big player breasts should be due to this transformation. Repeated calls to tfBreast() or tfNoPenisOneVagina() will increase player's breast size to these. See Player.GetBreastSize() for size reference.