aargonian/Bug-Fables-Internal-Docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add Inked condition docs

Browse Source
This commit is contained in:
aldelaro5
2024-03-02 08:37:33 -05:00
parent 5ab51db56a
commit d7ceb90231
3 changed files with 22 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/Battle system/Actors states/BattleCondition/Inked.md
View File

@@ -0,0 +1,16 @@
# Inked
A condition that prevents a player party member from using a [skill](../../../Enums%20and%20IDs/Skills.md) that may be inflicted in [CalculateBaseDamage](../../Damage%20pipeline/CalculateBaseDamage.md) if property is `Ink` or `InkOnBlock` (without a resistance field) featuring a `Prefabs/Particles/InkDrip` as a `firepart`.
## [GetChoiceInput](../../Player%20UI/GetChoiceInput.md)
This condition prevents the `Skill` [Actions](../../Player%20UI/Actions.md) option (the buzzer is played instead).
## [SetMaxOptions](../../Player%20UI/SetMaxOptions.md)
This condition causes the vine icons for the `Skill` [Actions](../../Player%20UI/Actions.md) to render with the MainManager.`grayscale` material instead of MainManager.`spritedefaultunity`.
## [CalculateBaseDamage](../../Damage%20pipeline/CalculateBaseDamage.md)
This condition may be inflicted if the property is `Ink` or `InkOnBlock`. This means it's also supported by the `StatusMirror` [medal](../../../Enums%20and%20IDs/Medal.md). It does not use a resistance field, check the method's documentation to learn more on the conditions needed for the infliction to work.
## [UpdateEntities](../../Visual%20rendering/UpdateEntities.md)
This condition will have the battleentity.`sprite`.material.color to be set to a lerp from the existing one to 0x7200D8 (bright purple) with a factor of 1/5 of the frametime. Check the documentation of the method to learn more about how the alpha channel is determined.
This condition includes the initialisation of the actor's `firepart` as a new instance of `Prefabs/Particles/InkDrip` childed to the `sprite` with a `DelAftBtl` tag and a local position of Vector3.up.

6
docs/Battle system/Actors states/BattleCondition/Taunted.md
View File

@@ -11,7 +11,11 @@ This condition prevents the following [Actions](../../Player%20UI/Actions.md) op
This condition will also deny the confirmation of another player party member's choice when selecting who to relay to when handling the `Relay` choice for a `SelectPlayer` action. Effectively, it means not only the condition prevents the player party member from relaying, it also prevents them to be relayed to.
## [SetMaxOptions](../../Player%20UI/SetMaxOptions.md)
This condition causes the vine icons for these [Actions](../../Player%20UI/Actions.md) to render with the MainManager.`grayscale` material instead of MainManager.`spritedefaultunity`.
This condition causes the vine icons for these [Actions](../../Player%20UI/Actions.md) to render with the MainManager.`grayscale` material instead of MainManager.`spritedefaultunity`:
- `Skill`
- `Item`
- `Relay`
## [ClearStatus](../Conditions%20methods/ClearStatus.md)
This condition is excluded from removal meaning it will remain even after calling this method.

2
docs/Battle system/Actors states/Conditions.md
View File

@@ -40,6 +40,6 @@ Here are the different BattleCondition that exists in the game and a summary of
|15|[Eaten](BattleCondition/Eaten.md)||
|16|[EventStop](BattleCondition/EventStop.md)|A stop condition specifically made for [event](../../../Enums%20and%20IDs/Events.md) 182 (trying to exit the room after approaching the tank in the last room of Upper Snakemouth) that simply disables a party member until it is manually removed (it is not meant to expire naturally)|
|17|[Fire](BattleCondition/Fire.md)||
|18|[Inked](BattleCondition/Inked.md)||
|18|[Inked](BattleCondition/Inked.md)|A condition that prevents a player party member from using a [skill](../../../Enums%20and%20IDs/Skills.md) that may be inflicted in [CalculateBaseDamage](../../Damage%20pipeline/CalculateBaseDamage.md) if property is `Ink` or `InkOnBlock` (without a resistance field) featuring a `Prefabs/Particles/InkDrip` as a `firepart`|
|19|[Sticky](BattleCondition/Sticky.md)||
|20|[Reflection](BattleCondition/Reflection.md)||