Species: Difference between revisions

From SkyCorp Global
Jump to navigation Jump to search
(Created page with "Represents a particular transformation the player can undergo.")
 
No edit summary
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(string bodyPartName) ===
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(string bodyPartName, 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?
[[Category:LUA Class Reference]]

Revision as of 22:01, 1 February 2018

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(string bodyPartName)

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(string bodyPartName, 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?