Branch config options

Contents

• TbyConfig.Skin
• TbyConfig.Instance
• TbyConfig.Callback
• TbyConfig.Placement
• TbyConfig.Sound
• TbyConfig.SoundPitch
• Text effect options for scribble

---

The tby_add_config() script inside a branch can modify a number of config options. These are the available options.

TbyConfig.Skin

Sets the textbox skin.

Reference

tby_add_config(TbyConfig.Skin, skin:Array)

Example

var _skin = [
  sprTbySkinFrameA,
  sprTbySkinBubbleA,
  sprTbySkinPauseA,
  sprTbySkinArrowA
];

tby_branch_create([
  /* ... */
  tby_add_config(TbyConfig.Skin, _skin),
  /* ... */
]);

TbyConfig.Instance

Sets the instance for text bubbles until it is changed again or the branch is finished.

Reference

tby_add_config(TbyConfig.Instance, instance:Number)

Example

tby_branch_create([
  /* ... */
  tby_add_config(TbyConfig.Instance, instance_find(objMyObj, 0)),
  /* ... */
]);

TbyConfig.Callback

Sets a callback script to be called right when the branch is finished.

Reference

tby_add_config(TbyConfig.Callback, script_id:Number)

Example

tby_branch_create([
  /* ... */
  tby_add_config(TbyConfig.Callback, my_callback_script),
  /* ... */
]);

TbyConfig.Placement

Sets the placement of normal textboxes to be one of the following: TbyPlacement.Top, .Middle, .Bottom or .Auto. TbyPlacement.Auto automatically adjust the placement to never obscure the instance defined as tby_game_object_respect_auto in the config. It is also the default.

Reference

tby_add_config(TbyConfig.Placement, placement:TbyPlacement)

Example

tby_branch_create([
  /* ... */
  tby_add_config(TbyConfig.Placement, TbyPlacement.Top),
  /* ... */
]);

TbyConfig.Sound

Sets the sound effect to be played when characters appear.

Reference

tby_add_config(TbyConfig.Sound, sound_asset:Number)

Example

tby_branch_create([
  /* ... */
  tby_add_config(TbyConfig.Sound, sndTbySpeechDefault),
  /* ... */
]);

TbyConfig.SoundPitch

Sets the random range a text sound is pitched. When the array is only one entry long, set the pitch to that level.

Reference

tby_add_config(TbyConfig.SoundPitch, pitch_range:Array)

Example

tby_branch_create([
  /* ... */
  tby_add_config(TbyConfig.SoundPitch, [0.8, 1.2]),
  /* ... */
]);

Text effect options for scribble

Various options to control the text effects scribble provides.

Reference

tby_add_config(TbyConfig.WaveSize, value:Number)
tby_add_config(TbyConfig.WaveFrequency, value:Number)
tby_add_config(TbyConfig.WaveSpeed, value:Number)
tby_add_config(TbyConfig.ShakeSize, value:Number)
tby_add_config(TbyConfig.ShakeSpeed, value:Number)
tby_add_config(TbyConfig.RainbowWeight, value:Number)
tby_add_config(TbyConfig.RainbowSpeed, value:Number)

Example

tby_branch_create([
  /* ... */
  tby_add_config(TbyConfig.WaveSpeed, 0.1),
  /* ... */
]);