Item DB: replace numbers with constants and split View into Subtype and ViewSprite #1828

MishimaHaruna · 2017-08-22T00:57:56Z

Pull Request Prelude

I have followed proper Hercules code styling.
I have read and understood the contribution guidelines before making this PR.
I am aware that this PR will be closed if the above-mentioned criteria are not fulfilled.

Changes Proposed

Added support for bitmasks, in the form of libconfig arrays of constants (strings) in the Upper and Loc fields of the item DB.
Split the View field into Subtype and ViewSprite, to better describe its actual use, depending on the item type.
Changed several numeric values into human-readable constants:
- W_* and A_* constants for the Subtype field
- IT_* constants for the Type field (thanks to @iRagno, from PR Change numbers into constants in item_db.conf #1633)
- SEX_* constants for the Gender field (thanks to @iRagno, from PR Change numbers into constants in item_db.conf #1633)
- ITEMUPPER_* (bitmask) constants for the Upper field
- EQP_* (bitmask) constants for the Loc field.
Fixed some incorrect values in the Renewal item DB, detected thanks to the above changes.
Differentiated and refactored the variables that hold view sprites from those that hold item subtypes.

This includes entire contents of PR #1633, which was merged (rebased and fast-forwarded) into this branch.

Known Issues and TODO List

The commits that differentiate the variables holding view sprites and item subtypes have only received summary testing. Careful review and/or further testing is advised.
The point "Add constant for View in Headears, Shields and Garments" wasn't addressed, and is beyond the scope of this PR, as discussed in PR Change numbers into constants in item_db.conf #1633

HerculesWSAPI · 2017-08-22T00:58:01Z

This change is

Signed-off-by: Haru <[email protected]>

…array Equivalent: `["EQP_HEAD_LOW", "EQP_HEAD_TOP"]` Signed-off-by: Haru <[email protected]>

…array Equivalent: `["EQP_HEAD_LOW", "EQP_HEAD_MID"]` Signed-off-by: Haru <[email protected]>

…array Equivalent: `["EQP_HEAD_TOP", "EQP_HEAD_MID"]` Signed-off-by: Haru <[email protected]>

…array Equivalent: `["EQP_HEAD_LOW", "EQP_HEAD_TOP", "EQP_HEAD_MID"]` Signed-off-by: Haru <[email protected]>

… array Equivalent: `["EQP_COSTUME_HEAD_TOP", "EQP_COSTUME_HEAD_MID"]` Signed-off-by: Haru <[email protected]>

… array Equivalent: `["EQP_COSTUME_HEAD_TOP", "EQP_COSTUME_HEAD_LOW"]` Signed-off-by: Haru <[email protected]>

… array Equivalent: `["EQP_COSTUME_HEAD_MID", "EQP_COSTUME_HEAD_LOW"]` Signed-off-by: Haru <[email protected]>

… array Equivalent: `["EQP_COSTUME_HEAD_TOP", "EQP_COSTUME_HEAD_MID", "EQP_COSTUME_HEAD_LOW"]` Signed-off-by: Haru <[email protected]>

… array Equivalent: `["EQP_HELM", "EQP_ARMS", "EQP_GARMENT", "EQP_ACC", "EQP_ARMOR", "EQP_SHOES"]` Signed-off-by: Haru <[email protected]>

Signed-off-by: Haru <[email protected]>

MishimaHaruna · 2017-09-17T21:51:53Z

Thanks! I'll merge it now, so that it won't grow any further :)

Adds the ability to query an item's view sprite, lost with HerculesWS#1828 Fixes HerculesWS#1895 Signed-off-by: Haru <[email protected]>

The field was replaced with ViewSprite and Subtype in a98b2d9 and PR HerculesWS#1828 (2016-09-04). Signed-off-by: Haru <[email protected]>

MishimaHaruna force-pushed the item_viewid branch from 53d6869 to 31e7c3e Compare September 17, 2017 15:47

ghost assigned MishimaHaruna Sep 17, 2017

MishimaHaruna added 22 commits September 17, 2017 17:47

Add item subtype (weapon/ammunition type) constants

9047b6c

Signed-off-by: Haru <[email protected]>

Replace W_DAGGER in the item database applicable entries

a10c6d2

Signed-off-by: Haru <[email protected]>

Replace W_1HSWORD in the item database applicable entries

6cb7039

Signed-off-by: Haru <[email protected]>

Replace W_2HSWORD in the item database applicable entries

c633997

Signed-off-by: Haru <[email protected]>

Replace W_1HSPEAR in the item database applicable entries

9433bf0

Signed-off-by: Haru <[email protected]>

Replace W_2HSPEAR in the item database applicable entries

fdebf87

Signed-off-by: Haru <[email protected]>

Replace W_1HAXE in the item database applicable entries

05e7c4f

Signed-off-by: Haru <[email protected]>

Replace W_2HAXE in the item database applicable entries

550b70f

Signed-off-by: Haru <[email protected]>

Replace W_MACE in the item database applicable entries

61075c5

Signed-off-by: Haru <[email protected]>

Replace W_STAFF in the item database applicable entries

bca1a51

Signed-off-by: Haru <[email protected]>

Replace W_BOW in the item database applicable entries

3fa951c

Signed-off-by: Haru <[email protected]>

Replace W_KNUCKLE in the item database applicable entries

0aa7f78

Signed-off-by: Haru <[email protected]>

Replace W_MUSICAL in the item database applicable entries

5cc248a

Signed-off-by: Haru <[email protected]>

Replace W_WHIP in the item database applicable entries

eb700fb

Signed-off-by: Haru <[email protected]>

Replace W_BOOK in the item database applicable entries

73c48b6

Signed-off-by: Haru <[email protected]>

Replace W_KATAR in the item database applicable entries

a7803aa

Signed-off-by: Haru <[email protected]>

Replace W_REVOLVER in the item database applicable entries

4d04e1b

Signed-off-by: Haru <[email protected]>

Replace W_RIFLE in the item database applicable entries

3ba1028

Signed-off-by: Haru <[email protected]>

Replace W_GATLING in the item database applicable entries

0f40dc3

Signed-off-by: Haru <[email protected]>

Replace W_SHOTGUN in the item database applicable entries

6d20606

Signed-off-by: Haru <[email protected]>

Replace W_GRENADE in the item database applicable entries

8358139

Signed-off-by: Haru <[email protected]>

Replace W_HUUMA in the item database applicable entries

4a13098

Signed-off-by: Haru <[email protected]>

MishimaHaruna added 16 commits September 17, 2017 17:48

Replace 262144 with EQP_SHADOW_SHIELD in the item_db Loc field

c802b78

Signed-off-by: Haru <[email protected]>

Replace 524288 with EQP_SHADOW_SHOES in the item_db Loc field

9694ecc

Signed-off-by: Haru <[email protected]>

Replace 1048576 with EQP_SHADOW_ACC_R in the item_db Loc field

8a2352f

Signed-off-by: Haru <[email protected]>

Replace 2097152 with EQP_SHADOW_ACC_L in the item_db Loc field

cb4c234

Signed-off-by: Haru <[email protected]>

Replace recurring value 43 with "EQP_ARMS" in the item_db Loc field

abe10bf

Signed-off-by: Haru <[email protected]>

Replace recurring value 136 with "EQP_ACC" in the item_db Loc field

98bf5a5

Signed-off-by: Haru <[email protected]>

Replace the recurring 'Loc: 257' value in the item_db with a bitmask …

e203b69

…array Equivalent: `["EQP_HEAD_LOW", "EQP_HEAD_TOP"]` Signed-off-by: Haru <[email protected]>

Replace the recurring 'Loc: 513' value in the item_db with a bitmask …

b6a220f

…array Equivalent: `["EQP_HEAD_LOW", "EQP_HEAD_MID"]` Signed-off-by: Haru <[email protected]>

Replace the recurring 'Loc: 768' value in the item_db with a bitmask …

f644db3

…array Equivalent: `["EQP_HEAD_TOP", "EQP_HEAD_MID"]` Signed-off-by: Haru <[email protected]>

Replace the recurring 'Loc: 769' value in the item_db with a bitmask …

f92bdce

…array Equivalent: `["EQP_HEAD_LOW", "EQP_HEAD_TOP", "EQP_HEAD_MID"]` Signed-off-by: Haru <[email protected]>

Replace the recurring 'Loc: 3072' value in the item_db with a bitmask…

37756b5

… array Equivalent: `["EQP_COSTUME_HEAD_TOP", "EQP_COSTUME_HEAD_MID"]` Signed-off-by: Haru <[email protected]>

Replace the recurring 'Loc: 5120' value in the item_db with a bitmask…

dbf92ff

… array Equivalent: `["EQP_COSTUME_HEAD_TOP", "EQP_COSTUME_HEAD_LOW"]` Signed-off-by: Haru <[email protected]>

Replace the recurring 'Loc: 6144' value in the item_db with a bitmask…

776a33b

… array Equivalent: `["EQP_COSTUME_HEAD_MID", "EQP_COSTUME_HEAD_LOW"]` Signed-off-by: Haru <[email protected]>

Replace the recurring 'Loc: 7168' value in the item_db with a bitmask…

ed19d99

… array Equivalent: `["EQP_COSTUME_HEAD_TOP", "EQP_COSTUME_HEAD_MID", "EQP_COSTUME_HEAD_LOW"]` Signed-off-by: Haru <[email protected]>

Replace the recurring 'Loc: 1023' value in the item_db with a bitmask…

a966739

… array Equivalent: `["EQP_HELM", "EQP_ARMS", "EQP_GARMENT", "EQP_ACC", "EQP_ARMOR", "EQP_SHOES"]` Signed-off-by: Haru <[email protected]>

Add a FIXME comment next to an unknown 'Loc: 16384' value in the item_db

5e23e50

Signed-off-by: Haru <[email protected]>

MishimaHaruna force-pushed the item_viewid branch from 31e7c3e to 5e23e50 Compare September 17, 2017 15:49

4144 approved these changes Sep 17, 2017

View reviewed changes

dastgirp approved these changes Sep 17, 2017

View reviewed changes

MishimaHaruna merged commit d472373 into master Sep 17, 2017

ghost removed the status:code-review Awaiting code review label Sep 17, 2017

MishimaHaruna deleted the item_viewid branch September 17, 2017 21:52

MishimaHaruna mentioned this pull request Nov 12, 2017

getiteminfo() / setiteminfo() fixes #1902

Merged

3 tasks

MishimaHaruna mentioned this pull request Oct 23, 2022

Cleanup old deprecated code #3170

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Item DB: replace numbers with constants and split View into Subtype and ViewSprite #1828

Item DB: replace numbers with constants and split View into Subtype and ViewSprite #1828

Uh oh!

MishimaHaruna commented Aug 22, 2017

Uh oh!

HerculesWSAPI commented Aug 22, 2017

Uh oh!

MishimaHaruna commented Sep 17, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Item DB: replace numbers with constants and split View into Subtype and ViewSprite #1828

Item DB: replace numbers with constants and split View into Subtype and ViewSprite #1828

Uh oh!

Conversation

MishimaHaruna commented Aug 22, 2017

Pull Request Prelude

Changes Proposed

Known Issues and TODO List

Uh oh!

HerculesWSAPI commented Aug 22, 2017

Uh oh!

MishimaHaruna commented Sep 17, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants