Class: Branch

Branch


new Branch(id)

Parameters:
Name Type Description
id
Source:
Returns:
Type
Branch

Methods


addBranch(branchID)

Parameters:
Name Type Description
branchID string
Source:
Returns:
Type
Branch

battle(BATTLE [, index])

Parameters:
Name Type Argument Description
BATTLE Battle
index integer <optional>
Source:

bossBattle(bossID, bossDifficulty [, index])

Parameters:
Name Type Argument Description
bossID string
bossDifficulty string
index integer <optional>
Source:
Returns:
Type
Branch

bukkake(girl [, index])

Parameters:
Name Type Argument Description
girl string | Array.<string>

Girl ID or Array of IDs

index integer <optional>
Source:
Returns:
Type
Branch

completeQuest(questID, subquestID [, onCompleteParameter] [, index])

Parameters:
Name Type Argument Description
questID string
subquestID string
onCompleteParameter * <optional>
index integer <optional>
Source:
Returns:
Type
Branch

cumOn(girl, bodyPart [, amount] [, index])

Parameters:
Name Type Argument Default Description
girl string | Array.<string>

Girl ID or Array of IDs

bodyPart GirlManager.bodyPart
amount number <optional>
1
index integer <optional>
Source:
Returns:
Type
Branch

equipClothes(girl, clothes [, force] [, index])

Parameters:
Name Type Argument Default Description
girl string

Girl ID

clothes string

Clothes ID

force boolean <optional>
false

Force the clothes on

index integer <optional>
Source:
Returns:
Type
Branch

Fade( [delay] [, index])

Parameters:
Name Type Argument Default Description
delay number <optional>
1000
index integer <optional>
Source:
Returns:
Type
Branch

Flash( [index])

Parameters:
Name Type Argument Description
index integer <optional>
Source:
Returns:
Type
Branch

Function(callback [, index])

Callback answer gets saved into answers

Parameters:
Name Type Argument Description
callback function

Must return a promise

index integer <optional>
Source:
Returns:
Type
Branch

getAnswers(step)

Parameters:
Name Type Description
step number
Source:
Returns:
Type
number

getBranch(branchID)

Parameters:
Name Type Description
branchID
Source:
Returns:
Type
Branch

getBranches()

Source:
Returns:
Type
Object

getID()

Source:
Returns:
Type
string

getLastAnswer( [skipAnswers])

Parameters:
Name Type Argument Default Description
skipAnswers number <optional>
0

If there are 3 answers, you can get the 3rd answer by passing 2 in this variable

Source:
Returns:
Type
number

getLeaves( [index])

Parameters:
Name Type Argument Description
index <optional>
Source:
Returns:
Type
Array.<DialogueStep> | boolean

getParameter()

Source:
Returns:
Type
*

getParent()

Source:
Returns:
Type
Object

getTree()

Source:
Returns:
Type
Object

ifAnswersAtStep(step, answer, branchID [, dialogueID] [, index])

Parameters:
Name Type Argument Description
step number
answer *
branchID string
dialogueID string <optional>
index integer <optional>
Source:
Returns:
Type
Branch

ifLastAnswer(answer, branchID [, dialogueID] [, skipAnswers] [, index])

Parameters:
Name Type Argument Default Description
answer *
branchID string
dialogueID string <optional>
skipAnswers number <optional>
0

If there are 3 answers, you can get the 3rd answer by passing 3 in this variable

index integer <optional>
Source:
Returns:
Type
Branch

play(parameter)

Parameters:
Name Type Description
parameter *
Source:
Returns:
Type
Promise.<any>

playAnimation(animationID [, index])

Parameters:
Name Type Argument Description
animationID string
index integer <optional>
Source:
Returns:
Type
Branch

playBranch(branchID [, index])

Parameters:
Name Type Argument Description
branchID string
index integer <optional>
Source:
Returns:
Type
Promise.<any>

Parameters:
Name Type Argument Default Description
text string
type boolean <optional>
false

True = Yes/No, False = Okay

index integer <optional>
Source:
Returns:
Type
Branch

question(answers [, exit] [, text] [, character] [, index])

Parameters:
Name Type Argument Default Description
answers Array.<string>
exit boolean <optional>
false
text string <optional>
character string <optional>
index integer <optional>
Source:
Returns:
Type
Branch

QuestPicker(mapKey [, text] [, character] [, greet] [, index])

Parameters:
Name Type Argument Default Description
mapKey string
text string <optional>
character string <optional>
greet boolean <optional>
false
index integer <optional>
Source:
Returns:
Type
Branch

removeBackground( [index])

Parameters:
Name Type Argument Description
index integer <optional>
Source:
Returns:
Type
Branch

removeLeaf(index)

Parameters:
Name Type Description
index integer
Source:
Returns:
Type
Branch

removeLeavesBetween(startIndex, endIndex)

Parameters:
Name Type Description
startIndex integer
endIndex integer
Source:
Returns:
Type
Branch

return(value [, index])

Parameters:
Name Type Argument Description
value *
index integer <optional>
Source:
Returns:
Type
Branch

returnLastAnswer( [index])

Parameters:
Name Type Argument Description
index integer <optional>
Source:
Returns:
Type
Branch

setAnswer(step, answer)

Parameters:
Name Type Description
step number
answer number
Source:
Returns:
Type
Branch

setBackground( [key] [, index])

Parameters:
Name Type Argument Description
key string | boolean <optional>
index integer <optional>
Source:
Returns:
Type
Branch

setClothesStyle(girl, style [, clothes] [, index])

Parameters:
Name Type Argument Description
girl string

Girl ID

style string | boolean

Style ID

clothes string <optional>

Clothes ID if you want to change the style of non-equipped clothes

index integer <optional>
Source:
Returns:
Type
Branch

setFuta(girl, boolean [, index])

Parameters:
Name Type Argument Description
girl string | Array.<string>

Girl ID or Array of IDs

boolean boolean

Futa on or off

index integer <optional>
Source:
Returns:
Type
Branch

setNaked(girl, boolean [, index])

Parameters:
Name Type Argument Description
girl string | Array.<string>

Girl ID or Array of IDs

boolean boolean

Clothes on or off

index integer <optional>
Source:
Returns:
Type
Branch

SwitchBranch(branchID [, index])

Parameters:
Name Type Argument Description
branchID string
index integer <optional>
Source:
Returns:
Type
Branch

SwitchDialogue(id, branchID [, index])

Parameters:
Name Type Argument Description
id string
branchID string
index integer <optional>
Source:
Returns:
Type
Branch

switchMap(mapID [, index])

Parameters:
Name Type Argument Description
mapID string
index integer <optional>
Source:
Returns:
Type
Branch

talk(character, text [, emotion] [, duration] [, index])

Parameters:
Name Type Argument Default Description
character string
text string
emotion string <optional>
"Neutral"
duration number <optional>

How fast the text moves

index integer <optional>
Source:
Returns:
Type
Branch