Skip to content

Latest commit

 

History

History
107 lines (93 loc) · 5.82 KB

OSC_Parameters.md

File metadata and controls

107 lines (93 loc) · 5.82 KB
Raw

General

Parameter Type Description
ToN_RoundType INT The current round type. See the Round Type Values document for more info.
ToN_Map INT The current map of this round.
ToN_Item INT The current item you are holding. See the Item Values document for more info.
ToN_OptedIn BOOL Is the player opted-in at the lobby

Events

Parameter Type Description
ToN_IsAlive BOOL Is the player alive or not. Should be true on Intermission.
ToN_Reborn BOOL Set to true when the player gets reborn using Maxwell. Should reset back to false if you die again.
ToN_IsStarted BOOL True if the round has started and ongoing.
ToN_Pages INT The amount of pages collected on an Eight Pages round. This number can be a value from 0 to 8
ToN_ItemStatus BOOL (Experimental) Determines the active status of items like the Chaos Coil, Emerald Coil, Corkscrew and TBH.
ToN_Saboteur BOOL The player is the killer on a Sabotage round.
ToN_MasterChange BOOL Set to true for a short period of time when the instance master has changed.
ToN_Damaged INT
FLOAT		 Value set for a few frames when the player takes damage. The number represents the amount of damage taken on that hit. If the player dies the base damage number will be 255
ToN_DeathID INT You can use this parameter to track when your friends die in the game.

ToN_Damaged

You can customize the output value for the ToN_Damaged parameter using JavaScript.
Just click on Settings > Send Damage Event > (Set Output) and here you can specify the code that will be evaluated before sending the damage value as a float.

For example:

  • Let's assume the incoming damage value in every example is 34
  • If the code is set to Damage / 100 it will send 0.34 instead.
  • Remember, this is JavaScript so you can use almost any native function:
    • Math.random() = 0.8461484
    • Math.pow(Damage / 100, 0.3) = 0.72350856231
    • Math.min(Damage / 30, 0.9) = 0.9

ToN_DeathID

You need to specify a list of player names to use with the ToN_DeathID parameter.
You can do so under Settings > Send Death ID > (Edit)
Specify here a list of player names that you want to track. Each display name needs to be separated by a comma (,) to be identified as a different user.

For example:

  • Setting the player names as Kittenji,YoBro,TONPRO42 will create a list like this:
    • ID 1 - Kittenji
    • ID 2 - YoBro
    • ID 3 - TONPRO42

So, if 'Kittenji' dies in the round, the parameter ToN_DeathID will be set to 1, then it will be set back to 0 after the specified decay time.
You can specify 254 player names in here, have fun!

Terrors

Terrors in Round

These values represent the current index or id of the terror in the current round.
Since these ID's are index based, the value will be 255 when no terror has spawned.

Parameter Type Description
ToN_Terror1 INT The current terror index.
ToN_Terror2 INT The second terror index. (Bloodbath & Midnight)
ToN_Terror3 INT The third terror index. (Bloodbath & Midnight)
This last one will be an Alternate ID on Midnight.

Please note that there's some special cases where these values change a bit. Monarch will use the Terror3 as identifier and Terror1 and Terror2 will be set to 255.

8 PAGES uses these parameters a bit differently.

  • Terror1 is the normalized terror ID, meaning it will use the index from the corresponding group.
  • Terror2 is the group that the Terror1 belongs to.
    • 0 - is Classic
    • 1 - is Alternate
    • 2 - is 8 Pages Original
  • Terror3 would be the actual index on the 8 PAGES pool.

Terrors phase index.

These values represent the different phases of some terrors.
For example: Faker or Bliss.

Parameter Type Description
ToN_TPhase1 INT The current terror phase.
ToN_TPhase2 INT The second terror phase. (Bloodbath)
ToN_TPhase3 INT The third terror phase. (Bloodbath & Midnight)

Colors

HSV - HSL Format (Default)

If the format is set to HSV, these parameters will be sent to OSC.
In HSL format, ToN_ColorV will change to ToN_ColorL instead.

Parameter Type Description
ToN_ColorH FLOAT HUD Terror Color (HUE)
ToN_ColorS FLOAT HUD Terror Color (Saturation)
ToN_ColorV
ToN_ColorL		 FLOAT HUD Terror Color (Value)
(Lightness) If format is HSL.

RGB - RGB32 Format

If the format is set to RGB, these parameters will be sent instead of HSV.
In RGB32 format, these values will be sent as an Int (Range 0-255) instead of a Float.

Parameter Type Description
ToN_ColorR FLOAT HUD Terror Color RED channel.
ToN_ColorG FLOAT HUD Terror Color GREEN channel.
ToN_ColorB FLOAT HUD Terror Color BLUE channel.

Encounters

Parameter Type Description
ToN_EncounterHHI BOOL Hungry Home Invader (Stop raiding my refrigerator)
ToN_EncounterATR BOOL Atrached
ToN_EncounterWYB BOOL Wild Yet Bloodthirsty Creature
ToN_EncounterGLO BOOL Glorbo