Skip to content

Bug Fables internal docs

ScrewPlatform

Initializing search

Bug Fables internal docs

Welcome to the Bug Fables Internal Docs
Bug Fables files structure
Battle system
Battle system
- ActionCommands
- ApplyBadges
- ApplyStatBonus
- Battle state
- BattleControl
- DoCommand
- RefreshSkills
- StartBattle
- StartUpData
- playerdata addressing
- Action commands
  Action commands
- Actors states
  Actors states
  - BattleData
  - BattlePosition
  - CenterPos
  - CleanKill
  - Conditions
  - Delayed condition
  - Delayed projectile
  - Enemy features
  - HPPercent
  - Heal
  - IsStopped
  - MultiSkillMove
  - RefreshEntities
  - BattleCondition
    BattleCondition
    
    AttackDown
    
    AttackUp
    
    DefenseDown
    
    DefenseUp
    
    Eaten
    
    EventStop
    
    Fire
    
    Flipped
    
    Freeze
    
    GradualHP
    
    GradualTP
    
    Inked
    
    Numb
    
    Poison
    
    Reflection
    
    Shield
    
    Sleep
    
    Sticky
    
    Sturdy
    
    Taunted
    
    Topple
  - Conditions methods
    Conditions methods
    
    ClearStatus
    
    ConditionTurns
    
    HasCondition
    
    HealConditions
    
    RemoveCondition
    
    SetCondition
    
    StatusEffect
    
    TryCondition
  - Enemy party members
    Enemy party members
    
    AddNewEnemy
    
    DropItem
    
    HasWeakness
    
    NewEnemy
    
    ReorganizeEnemies
    
    SummonEnemy
  - Player party members
    Player party members
    
    AllPartyFree
    
    GetAlivePlayerAmmount
    
    GetFreePlayerAmmount
    
    RevivePlayer
  - Targetting
    Targetting
    
    GetAvaliableTargets
    
    GetRandomAvaliablePlayer
    
    GetTargetList
    
    SetTargets
- Battle flow
  Battle flow
  - AdvanceTurnEntity
  - Combat tutorials EventDialogues
  - EndEnemyTurn
  - EndPlayerTurn
  - EventDialogue
  - GetBlock
  - LevelUpMessage
  - Main turn life cycle
  - PlayerTurn
  - Retry
  - Update
  - UseCharm
  - firststrike system
  - Action coroutines
    Action coroutines
    
    AIAttack
    
    AdvanceMainTurn
    
    CheckDead
    
    Chompy
    
    DoAction
    
    Relay
    
    SwitchParty
    
    SwitchPos
    
    Tattle
    
    TryFlee
    
    UseItem
  - EventDialogues
    EventDialogues
    
    Acolyte and AcolyteVine EventDialogue
    
    Cenn and Pisci EventDialogue
    
    EverlastingKing EventDialogue
    
    Kali EventDialogue
    
    Pitcher EventDialogue
    
    SandWyrm and SandWyrmTail EventDialogues
    
    Scarlet
    
    Spuder EventDialogues
    
    UltimaxTank EventDialogue
    
    VenusBoss EventDialogue
    
    WaspKing EventDialogue
  - Terminal coroutines
    Terminal coroutines
    
    AddExperience
    
    DeadParty
    
    GameOver
    
    ReturnToOverworld
  - Terminal wrappers
    Terminal wrappers
    
    EndBattleWon
    
    ExitBattle
  - Update flows
    Update flows
    
    Controlled flow
    
    Terminal flow
    
    Uncontrolled flow
- Damage pipeline
  Damage pipeline
- Enemy actions
  Enemy actions
  - ChangePosition
  - Dig
  - Enemy actions
  - EnemyFlee
  - ReviveEnemy
  - StealItem
  - Enemies
    Enemies
    
    Abomihoney
    
    Acolyte
    
    Acornling
    
    Ahoneynation
    
    AngryPlant
    
    ArmoredPoly
    
    Bandit
    
    BanditLeader
    
    BeeBoss
    
    BeeBot
    
    BeeTurret
    
    Beetle
    
    Bloatshroom
    
    Burglar
    
    Cactus
    
    Cape
    
    Carmina
    
    Cenn
    
    Centipede
    
    ChomperBrute
    
    CordycepsAnt
    
    CursedSkull
    
    DeadLanderA
    
    DeadLanderB
    
    DeadLanderG
    
    Delilah
    
    DivingSpider
    
    EverlastingKing
    
    FalseMonarch
    
    Fisherman
    
    Flowering
    
    FlyTrap
    
    GoldenSeedling
    
    HoloKabbu
    
    HoloLeif
    
    HoloVi
    
    IceWall
    
    Ironclad
    
    JumpingSpider
    
    Kali
    
    KeyR and KeyL
    
    Kina
    
    Krawler
    
    LeafbugArcher
    
    LeafbugClubber
    
    LeafbugNinja
    
    Maki
    
    MakiTutorial
    
    Mantidfly
    
    MenderBot
    
    Midge
    
    MidgeBroodmother
    
    MimicSpider
    
    MotherChomper
    
    Mothfly
    
    MothflyCluster
    
    Mothiva1
    
    MrTester
    
    Mushroom
    
    PeacockSpider
    
    Pisci
    
    Pitcher
    
    PitcherFlytrap
    
    Plumpling
    
    PrimalWeevil
    
    Pseudoscorpion
    
    Ruffian
    
    SandWall
    
    SandWyrm
    
    SandWyrmTail
    
    Sandworm
    
    Scarlet
    
    Scorpion
    
    Seedling
    
    SeedlingKing
    
    ShockWorm
    
    SkullCaterpillar
    
    Sneil
    
    Spuder
    
    Stratos
    
    Strider
    
    TANGYBUG
    
    Tablet
    
    TermiteNasute
    
    TermiteSoldier
    
    Thief
    
    ToeBiter
    
    UltimaxTank
    
    Underling
    
    VenusBoss
    
    WaspBomber
    
    WaspDriller
    
    WaspGeneral
    
    WaspHealer
    
    WaspKing
    
    WaspKingIntermission
    
    WaspTrooper
    
    Weevil
    
    WildChomper
    
    Yin
    
    Zasp
    
    Zombee
    
    Zombeetle
    
    ZombieRoach
    
    Zommoth
- Player UI
  Player UI
  - Actions
  - AttackArea
  - CancelList
  - GetChoiceInput
  - GotoSelect
  - Pick
  - SetItem
  - SetMaxOptions
  - Confirmation handling
    Confirmation handling
    
    BaseAction ChoiceInput logic
    
    SelectEnemy ChoiceInput logic
    
    SelectPlayer ChoiceInput logic
  - ItemList confirmation handling
    ItemList confirmation handling
    
    Battle strategy list type confirmation handling
    
    Skills list type confirmation handling
    
    Standard items list type confirmation handling
- Player actions
  Player actions
  - Player Actions
  - Basic attacks
    Basic attacks
    
    Bee's basic attack
    
    Beetle's basic attack
    
    Moth's basic attack
  - Items usage
    Items usage
    
    Abombhoney
    
    BurlyBomb
    
    CherryBomb
    
    ClearBomb
    
    Default toss action
    
    FlameRock
    
    FrostBomb
    
    HardSeed
    
    Ice
    
    LonglegSummoner
    
    NumbBomb
    
    NumbDart
    
    PoisonBomb
    
    PoisonDart
    
    SleepBomb
    
    SpicyBomb
  - Skills
    Skills
    
    AttackDown
    
    AttackDownPlus
    
    AttackUp
    
    BeeFly
    
    BeeRangMultiHit
    
    BeetleDig
    
    BeetleTaunt
    
    BubbleShield
    
    BubbleShieldLite
    
    ChargeUpPlus
    
    Cleanse
    
    DefenseBreak1
    
    DefenseBreakAll
    
    DefenseUp
    
    DefenseUpPlus
    
    Empower
    
    EmpowerPlus
    
    FrigidCoffin
    
    HardCharge
    
    HeavyStrike
    
    HeavyThrow
    
    HornDash
    
    HurricaneBeemerang
    
    IceBeemerang
    
    IceDrill
    
    IceRain
    
    IceSphere
    
    Icefall
    
    NeedlePincer
    
    NeedleToss
    
    PebbleTossPlus
    
    PeebleToss
    
    PepTalk
    
    RoyalDecree
    
    SecretStash
    
    SharingStash
    
    Sturdy
- StartBattle phases
  StartBattle phases
- Visual rendering
  Visual rendering
Entities
Entities
- Entity
- EntityControl
  EntityControl
  - EntityControl Creation
  - EntityControl Fields
  - EntityControl Methods
  - EntityControl
  - Item entity
  - MainManager methods
  - Modifiers
  - Start
  - Animations
    Animations
    
    AnimSpecific
    
    SetAnim
    
    Animstate
  - Notable methods
    Notable methods
    
    AddModel
    
    CheckSpecialID
    
    Death
    
    Drop
    
    Follow
    
    FreezeHandling
    
    LateStart
    
    Move
    
    Special animid startup
  - Update process
    Update process
    
    RefreshShadow
    
    RefreshTrail
    
    UpdateAirAnim
    
    UpdateCollider
    
    UpdateEmoticon
    
    UpdateFlip
    
    UpdateGeneralAnim
    
    UpdateGround
    
    UpdateHeight
    
    UpdateItem
    
    UpdateMoveSmoke
    
    UpdateSound
    
    UpdateSprite
    
    UpdateStatusIcons
    
    UpdateVelocity
    
    Unity events
    Unity events
    
    FixedUpdate
    
    LateUpdate
    
    OnTriggerExit
    
    OnTriggerStay
    
    Update
- NPCControl
  NPCControl
  - ActionBehaviors
  - Enemy
  - Interaction
  - LateUpdate
  - NPC
  - NPCControl
  - NPCType
  - Object
  - Setup
  - Shop system
  - Start
  - Update
  - ActionBehaviors
    ActionBehaviors
    
    AlwaysWander
    
    ChangeSpriteInRandius
    
    ChargeAndAttack
    
    ChargeAtPlayer
    
    ChargeAtPlayerFlipSprite
    
    ChargeAttackUnderground
    
    ChaseOnWater
    
    ChasePlayer
    
    ChaseWhenAnim
    
    Disguise
    
    DisguiseOnce
    
    DisguiseOnceJumpForward
    
    FaceAhead
    
    FaceAwayFromPlayer
    
    FaceBehind
    
    FaceDown
    
    FacePlayer
    
    FaceUp
    
    FleeFromPlayer
    
    None
    
    SetPath
    
    SetPathJump
    
    ShootProjectile
    
    ShootProjectilePredict
    
    StealthAI
    
    TurnFixedInterval
    
    TurnRandomly
    
    Unmoveable
    
    WalkAwayFromPlayer
    
    WalkWhenAnim
    
    Wander
    
    WanderNoWarp
    
    WanderOffscreen
    
    WanderOnWater
    
    WaterUnderground
  - Interaction
    Interaction
    
    CaravanBadge
    
    Check
    
    Event
    
    LockedDoor
    
    QuestBoard
    
    SavePoint
    
    Shop
    
    ShopKeeper
    
    StorageAnt
    
    Talk
    
    TalkReturnToOriginalFlip
    
    VenusHeal
  - Notable methods
    Notable methods
    
    AddPusher
    
    CheckEmoteFlag
    
    CreateDescWindow
    
    Dizzy
    
    DoBehaviour
    
    GetDialogue
    
    GravityFix
    
    HasHiddenItem
    
    Interact
    
    RespawnEnemy
    
    SetInitialBehavior
    
    NPCControl.StartBattle
    
    StopForceBehavior
    
    SwitchSound
  - ObjectTypes
    ObjectTypes
    
    ANDBlock
    
    ANDGate
    
    BattleMapChange
    
    Beemerang
    
    BeetleGrass
    
    BreakableRock
    
    CameraChange
    
    CoiledObject
    
    DialogueTrigger
    
    DigSpot
    
    DoorOtherMap
    
    DoorSameMap
    
    Dropplet
    
    EnemySpawner
    
    EventTrigger
    
    FixedAnim
    
    Geizer
    
    Item
    
    JumpSpring
    
    MusicRange
    
    PathPlatform
    
    PressurePlate
    
    PushRock
    
    ResetCamera
    
    RollingRock
    
    RotatingPlatform
    
    SavePoint
    
    ScrewSwitch
    
    SetPlayerRespawn
    
    SencilSwitch
    
    Switch
    
    TempPlatform
    
    TriggerSwitch
    
    WaterSwitch
    
    WindPusher
Enums and IDs
Enums and IDs
- AnimIDs
- BattleMaps
- BoardQuests
- Enemies
- Events
- Items
- Maps
- Medal / badge
- Musics
- Skills
- Crystalbflags
- Librarystuff
  Librarystuff
External data format
External data format
- Config file
- Bug Fables Save Format
Flags arrays
Flags arrays
General systems
General systems
InputIO
InputIO
ItemList
ItemList
- ItemList State Machine
- ItemList
- Setup methods
- ShowItemList Life Cycle
- ShowItemList
- ItemList utility methods
- inlist issue
- listtype
- List Types Group Details
  List Types Group Details
- ShowItemList Life Cycle
  ShowItemList Life Cycle
  - Description box rendering
  - Rerendering after scroll
MainManager
MainManager
- Boot and reset process
- DoClock
- LateUpdate
- MainManager Fields
- MainManager
- RefreshEntities
- Unused fields
- Update and FixedUpdate
- Methods
  Methods
MapControl
MapControl
- Battles configuration in map
- Map camera system
- DigWall
- EntityOnly
- Follower system
- Map graphics configuration
- MapControl init process
- Insides
- Map entities
- Map identification
- Map loading
- Map music system
- MapControl
- Merged mesh
- Miscellaneous features
- Particles level
- MapControl public utitlities methods
- Respawn
- Map SetText configuration
- MapControl update process
- Fields
  Fields
  - MapControl configuration fields
  - MapControl tracking fields
- Init methods
  Init methods
Miscellaneous logic
Miscellaneous logic
- Rendering components
- Conditional rendering
  Conditional rendering
  - ConditionChecker
  - FlagAnimation
- Entities
  Entities
- Environment
  Environment
- GameObject utilities
  GameObject utilities
- Minigames
  Minigames
  - CardGame
  - Fishing
  - FlappyBee
  - MazeGame
  - WackaWorm
- SetText
  SetText
  - FontEffects
  - MiniBubble
- UI
  UI
- Unused
  Unused
PlayerControl
PlayerControl
- PlayerControl fields
- DashBehavior
- Field abilities
- PlayerControl FixedUpdate
- GetInput
- JumpTo
- PlayerControl LateUpdate
- Movement
- PlayerControl
- PlayerControl Start
- StopDash
- Submarine
- Trigger colliders handing
- PlayerControl Update
- Actions
  Actions
SetText
SetText
- SetText Commands Sorted By Enum Value
- SetText Commands
- Dialogue mode
- SetText Entry Points
- Letter slots
- SetText lifecycle
- Notable states
- SetText
- Bleep
- languageid
- Common commands id schemes
  Common commands id schemes
  - Dialogue line ID
  - Entity ID
- Individual commands
  Individual commands
  - Activateselectedquest
  - Addboard
  - Addfollower
  - AddItem
  - AddItemToss
  - Addprize
  - Addquest
  - Addstat
  - Addvar
  - Align
  - Alwaysactive
  - Anim
  - Anstring
  - Area
  - Backbox
  - Backline
  - Battle
  - Battlesize
  - Battlewon
  - BeeGame
  - Blank
  - Bleep
  - Boxspeed
  - Boxstyle
  - Break
  - Breakend
  - Breakflag
  - Button
  - Call
  - Camangle
  - Camlimit
  - Camoffset
  - Camspeed
  - Camtarget
  - Cancelaction
  - Caravanmedal
  - Cardbattle
  - Cberrytotal
  - Center
  - Chapterinto
  - Checkallquests
  - Checkanim
  - Checkflag
  - Checkinvqtd
  - Checkmapflag
  - Checkminibubble
  - Checkmoney
  - Checkpos
  - Checkregional
  - Checksum
  - Checktrue
  - Checkvar
  - Choicewave
  - Conestring
  - Color
  - Common
  - Completequest
  - Copyvar
  - Createitem
  - Currency
  - Deathsmoke
  - Define
  - Destroydescbox
  - Destroyminibubble
  - Discovery
  - Dropshadow
  - DungeonGame
  - Emoticon
  - End
  - Entityalive
  - Event
  - Exitgame
  - Exp
  - Face
  - FadeIn
  - FadeOut
  - Fadeletter
  - Fademusic
  - Faketail
  - Fixchompy
  - Flag
  - Flagvalue
  - Flip
  - Follow
  - Font
  - Forcewait
  - Fwait
  - GetFromMap
  - Getstorage
  - Gettail
  - Giveitem
  - Glitchy
  - Goto
  - Halfline
  - Halt
  - Heal
  - Hide
  - Hidemoney
  - Hidespeed
  - Icon
  - Igcolmove
  - Ignorenext
  - Innsleep
  - Itemname
  - Itemvalue
  - Jump
  - Kill
  - Kinematicplayer
  - Layer
  - LetterPrompt
  - Level
  - Librarybook
  - Libraryline
  - Librarysize
  - Limit
  - Line
  - Listsize
  - Loadcamera
  - Loadmap
  - Lock
  - Lockbacktrack
  - Lockmovement
  - Lore
  - Mapflag
  - Mapsize
  - Maxmedals
  - Medaltotal
  - Menu
  - Minibubble
  - Money
  - Mothfly
  - Move
  - Moveahead
  - Movewait
  - Music
  - Next
  - Noskip
  - NumberPrompt
  - Openpause
  - Optionvar
  - Overfollower
  - Parent
  - Particle
  - PartyGame
  - Pauseline
  - Pausesize
  - PickItem
  - Plural
  - Position
  - Prompt
  - Quarterline
  - Questbreak
  - Questprompt
  - Questsize
  - Rainbow
  - Regionalflag
  - Removebadgeshop
  - Removefollower
  - Removeitem
  - Removeitemat
  - Removemaplimits
  - Removestat
  - Rerollshops
  - Resetcamera
  - Resetmaplimits
  - Resetregion
  - Save
  - Savecamera
  - Scorecheck
  - Setbreak
  - Setprize
  - Setvar
  - Shakecamera
  - Shaky
  - Shopline
  - Shoppool
  - Showmoney
  - Showtokens
  - Single
  - Singlebreak
  - Sizemulti
  - Sort
  - Sound
  - Spd
  - Speed
  - Sstring
  - Stars
  - Stopskip
  - String
  - Switch
  - Tab
  - Tail
  - Tailextra
  - Takeopenquests
  - Teleportparty
  - Termacadecheck
  - Testdiag
  - Textangle
  - Transfert
  - Transitionsort
  - Triui
  - Unpauseline
  - Unpausesize
  - Updateanim
  - Var
  - Wait
  - Waitcn
  - Waitminibubble
  - Warp
  - Wavy
  - Size
- Letter Rendering Methods
  Letter Rendering Methods
  - Regular Letter Rendering
  - Single Letter Rendering
- Related Systems
  Related Systems
  - Backtracking
  - FontEffects
  - GetDialogueFromMap
  - GlobalCommands
  - Obtaining values
  - SetTalk
  - Text advances
  - Automatic Line Breaks
    Automatic Line Breaks
    
    Automatic Line Breaking
    
    OrganiseLines known issues
    
    OrganiseLines
TextAsset Data
TextAsset Data

ScrewPlatform¶

TODO: this is complex, document later

Made with Material for MkDocs