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

Cleanup SetText commands docs

Browse Source
This commit is contained in:
aldelaro5
2023-12-03 09:52:28 -05:00
parent 883575076f
commit 849c6296fb
2 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/SetText/Individual commands/Giveitem.md
View File

@@ -108,6 +108,7 @@ This commands writes to the following:
This command's logic behaves very differently based on the `itemtype` and the resolved `itemid` because the different types and ids requires different presentations and different behaviors.
### Description box rendering
This uses a version of CreateDescWindow that is different than the one used for regular [Item](../../Entities/NPCControl/ObjectTypes/Item.md) objects. It will be documented here as it's the only usage of it.
A description box will be created if `itemtype` isn't berries or Crystal Berries and the caller isn't a CaravanBadge or a Shop (for key items, it also needs to not be Game Tokens and not be in an interior)

6
docs/SetText/Individual commands/Kill.md
View File

@@ -1,6 +1,6 @@
# Kill
Kills an [Entity](../../Entities/Entity.md) by calling [Death](../../Entities/EntityControl/Notable%20methods/Death.md) (with `activatekill` true) on it.
Kills an [Entity](../../Entities/Entity.md) by calling [Death](../../Entities/EntityControl/Notable%20methods/Death.md) (with `activatekill`) on it.
## Syntax
@@ -22,8 +22,8 @@ Any non int value that isn't in one of the predefined values above will cause an
## Remarks
There is a special case for Shop and CaravanBadge entities where it will call SetBadgeShop(true) on the entity's [NPCControl](../../Entities/NPCControl/NPCControl.md) for the former and on the shopkeeper of the [entity](../../Entities/Entity.md)'s [NPCControl](../../Entities/NPCControl/NPCControl.md) for the latter.
There is a special case for [Shop](../../Entities/NPCControl/Interaction/Shop.md) and [CaravanBadge](../../Entities/NPCControl/Interaction/CaravanBadge.md) interactions on the caller where it will call [SetBadgeShop(true)](../../Entities/NPCControl/Interaction/CaravanBadge.md#setbadgeshop) on the entity's [NPCControl](../../Entities/NPCControl/NPCControl.md) for the former and on the `shopkeeper` of the [NPCControl](../../Entities/NPCControl/NPCControl.md) for the latter.
This command only kills the entity if its [NPCControl](../../Entities/NPCControl/NPCControl.md) isn't null and it's not a CaravanBadge.
This command only kills the entity if its [NPCControl](../../Entities/NPCControl/NPCControl.md) isn't null and it doesn't have a `CaravanBadge` interaction.
Once the [entity](../../Entities/Entity.md) has been killed if applicable, the player's list of [NPCControl](../../Entities/NPCControl/NPCControl.md) is reset to a new list.