Species

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.

bool shouldAttemptTransformation()

Checks if any changes likely to be available. Checking this prior to calling causeTF() or a forced TF sequence helps avoid going into a TF scene with no TF.  Does NOT guarantee causeTF() will actually do a TF!

(added in r54)

bool CheckSpeciesTransformationAllowed(bool silent=false)

Convenience function for checking if species-level transformation is permitted. Outputs to screen if blocked and silent is not set.

(added in r54)

bool checkBodyPartTransformationAllowed(BodyPart bodyPart, bool silent=true)

Convenience function for checking if particular body part transformation is permitted. Outputs to screen if blocked and silent is not set.

Unlike the species version of this check, silent is default for this. That is because usually we don't want to output text for each body part as that would be confusing/spammy to player why the same body parts keep getting attempted.

(added in r54)

void onTransformed()

Intended to be called after every successful transformation, allowing other systems opportunity to react to a species transformation. Custom species should call this so if the game is in permanent TF mode and no permanent species has been set yet, the player can be locked to this species.

(added in r54)

Private Methods

bool checkFullyFeminizedIfShould(int targetBreastSize, int targetVaginaSize=1, bool thisTfAlwaysFeminizes=false)

Helper function called by TFs to determine if this TF can potentially transform player gender more. Species don't always cause feminization, but they can if either the relevant game option is chosen during character creation, or its a transformation that implies gender tf (ex: mermaid).

targetVaginaSize: Most TG's just use the TfNoPenisOneVagina() function, which currently only TF's the player vagina one step. Unless a particular sized vagina is part of the TF, just call this without overloads.

thisTfAlwaysFeminizes: Set true if breast growth should always happen, and also if penis->vagina tf should happen (at least, if it doesn't conflict with player's persist dick setting (ex: cock ring)).

(added in r54)

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.