New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Developers] Migrate Gameplay Tags to C++ #60

Open

GuyPaddock opened this issue Feb 8, 2024 · 2 comments

Assignees

Labels

enhancement tech debt

Milestone

MVP Release (1.0)

Contributor

GuyPaddock commented Feb 8, 2024 •

edited

Loading

As a Developer maintaining a project that relies on the OpenPF2 plug-in, I'd like it if the tags that the plug-in exposes and relies on were defined in C++ rather than in a tags INI file so that I don't have to keep the tag files in my project up to date with the plug-in and tags can be accessed from C++ quickly and directly.

Conditions of Acceptance

Given I am adding OpenPF2 to my project: I'd expect to not have to copy INI files containing gameplay tags into my project.
Given I am updating the copy of OpenPF2 in my project: I'd expect to not have to update INI files containing gameplay tags in my project.
Given I need to use a gameplay tag provided by OpenPF2 (e.g., Trait.Condition.Dying.2) in a blueprint: I'd expect the tag to appear in lists of tags in the blueprint editor.
Given I need to use a gameplay tag provided by OpenPF2 (e.g., Skill.Athletics.Expert) in C++ code:
1. I'd expect to not have to "request" the tag by its string name.
2. I'd expect to be able to get a reference to the tag through a namespace or class exposed by OpenPF2.

The text was updated successfully, but these errors were encountered:

GuyPaddock added enhancement good first issue tech debt labels

Contributor Author

GuyPaddock commented Feb 8, 2024

Credit to Cinderblade on Discord for suggesting this change!

GuyPaddock self-assigned this

GuyPaddock added this to the MVP Release (1.0) milestone

GuyPaddock added this to OpenPF2 Core MVP

GuyPaddock moved this to In Progress in OpenPF2 Core MVP

GuyPaddock added a commit that referenced this issue


          [#60] WIP: Migrate Tags from *.ini Files to Native C++ Tags

c991482

GuyPaddock added a commit that referenced this issue


          [#60] WIP: Migrate Tags from *.ini Files to Native C++ Tags

93caacd

GuyPaddock added a commit that referenced this issue


          [#60] WIP: Migrate Tags from *.ini Files to Native C++ Tags

f7b9add

GuyPaddock added a commit that referenced this issue


          [#60] WIP: Migrate Tags from *.ini Files to Native C++ Tags

8460a33

GuyPaddock added a commit that referenced this issue


          [#60] Re-organize Gameplay Tags into Consistent Namespace w/. Descs.

4f2bc67

This organizes all the OpenPF2-related tags under "PF2" tag categories
so that they don't clash with anything in a game that's using OpenPF2.
This change also adds descriptions to all tag categories.

GuyPaddock added a commit that referenced this issue


          [#60] Update Code References to Gameplay Tags for New Tag Names

b189594

GuyPaddock added a commit that referenced this issue


          [#60] Simplify Logic for Convertering Tag Name to String

9bbdca2

GuyPaddock added a commit that referenced this issue


          [#60] Switch to Explicit Trigger Tag for Ability Boost GAs

43293c1

GuyPaddock added a commit that referenced this issue


          [#60] Re-save All Blueprints to Pickup Tag Changes

9166efd

GuyPaddock added a commit that referenced this issue


          [#60] Eliminate FGameplayTag::GetTag()

a9182f4

This was identical to `FGameplayTag::RequestGameplayTag()` in the
`FName` case, and not that much extra effort to invoke `FName()`
ourselves in the `FString` case, so it doesn't make sense for this to
exist.

GuyPaddock added a commit that referenced this issue


          [#60] Move FGameplayAbilityUtilities::HasTag() into PF2TagLibrary...

38cffd6

...as `ContainerHasTag()`. This makes more sense with the other
tag-related utility methods in the library. We're also able to expose it
to Blueprint, as long as we take in a const reference instead of a
pointer.

GuyPaddock added a commit that referenced this issue


          [#60] Implement PF2TagLibrary::RequestCombinedTag*() Methods

9c27c3e

This makes assembling a gameplay tag from a root tag and suffix name
more efficient by using a `NameBuilder` for this instead of
concatenation.

GuyPaddock added a commit that referenced this issue


          [#60] Update Damage Type Mappings for New Naming

0d82026

GuyPaddock added a commit that referenced this issue


          [#60] Gracefully Handle Missing Damage Type

86555be

Previously, if a damage type passed in was not a recognized damage type,
the damage callout would report `-999` as the damage. Now, it merely
renders the proper damage amount in black text.

GuyPaddock removed the good first issue label

Contributor Author

GuyPaddock commented Jul 16, 2024

Nearly done implementing this, but I can say that this was definitely NOT a good first issue. There was a surprising amount of stuff that needed to be updated to switch to the new tag system.

GuyPaddock added a commit that referenced this issue


          [#60] Switch to GetSingleTagContainer()

2f06e7c

GuyPaddock added a commit that referenced this issue


          [#60] Migrate Tags from *.ini Files to Native C++ Tags

8dd6c6e

GuyPaddock added a commit that referenced this issue


          [#60] Re-organize Gameplay Tags into Consistent Namespace w/. Descs.

f2c0ab9

This organizes all the OpenPF2-related tags under "PF2" tag categories
so that they don't clash with anything in a game that's using OpenPF2.
This change also adds descriptions to all tag categories.

GuyPaddock added a commit that referenced this issue


          [#60] Update Code References to Gameplay Tags for New Tag Names

931f127

GuyPaddock added a commit that referenced this issue


          [#60] Simplify Logic for Convertering Tag Name to String

7e4f699

GuyPaddock added a commit that referenced this issue


          [#60] Switch to Explicit Trigger Tag for Ability Boost GAs

9b3d8fe

GuyPaddock added a commit that referenced this issue


          [#60] Re-save All Blueprints to Pickup Tag Changes

cbb091d

GuyPaddock added a commit that referenced this issue


          [#60] Eliminate FGameplayTag::GetTag()

4eee547

This was identical to `FGameplayTag::RequestGameplayTag()` in the
`FName` case, and not that much extra effort to invoke `FName()`
ourselves in the `FString` case, so it doesn't make sense for this to
exist.

GuyPaddock added a commit that referenced this issue


          [#60] Move FGameplayAbilityUtilities::HasTag() into PF2TagLibrary...

1be6244

...as `ContainerHasTag()`. This makes more sense with the other
tag-related utility methods in the library. We're also able to expose it
to Blueprint, as long as we take in a const reference instead of a
pointer.

GuyPaddock added a commit that referenced this issue


          [#60] Implement PF2TagLibrary::RequestCombinedTag*() Methods

3cf07bf

This makes assembling a gameplay tag from a root tag and suffix name
more efficient by using a `NameBuilder` for this instead of
concatenation.

GuyPaddock added a commit that referenced this issue


          [#60] Update Damage Type Mappings for New Naming

5bee7b7

GuyPaddock added a commit that referenced this issue


          [#60] Gracefully Handle Missing Damage Type

326f56a

Previously, if a damage type passed in was not a recognized damage type,
the damage callout would report `-999` as the damage. Now, it merely
renders the proper damage amount in black text.

GuyPaddock added a commit that referenced this issue


          [#60] Switch to GetSingleTagContainer()

149cccd

GuyPaddock added a commit that referenced this issue


          [#60] Remove Gameplay Tags Step from README.md

b9c834d

GuyPaddock added a commit that referenced this issue


          [#60] Re-organize Gameplay Tags into Consistent Namespace w/. Descs.

25be08a

This organizes all the OpenPF2-related tags under "PF2" tag categories
so that they don't clash with anything in a game that's using OpenPF2.
This change also adds descriptions to all tag categories.

GuyPaddock added a commit that referenced this issue


          [#60] Update Code References to Gameplay Tags for New Tag Names

20afee2

GuyPaddock added a commit that referenced this issue


          [#60] Simplify Logic for Convertering Tag Name to String

a497c25

GuyPaddock added a commit that referenced this issue


          [#60] Switch to Explicit Trigger Tag for Ability Boost GAs

1f9cf60

GuyPaddock added a commit that referenced this issue


          [#60] Re-save All Blueprints to Pickup Tag Changes

d526d91

GuyPaddock added a commit that referenced this issue


          [#60] Eliminate FGameplayTag::GetTag()

0283bf8

This was identical to `FGameplayTag::RequestGameplayTag()` in the
`FName` case, and not that much extra effort to invoke `FName()`
ourselves in the `FString` case, so it doesn't make sense for this to
exist.

GuyPaddock added a commit that referenced this issue


          [#60] Move FGameplayAbilityUtilities::HasTag() into PF2TagLibrary...

680aef6

...as `ContainerHasTag()`. This makes more sense with the other
tag-related utility methods in the library. We're also able to expose it
to Blueprint, as long as we take in a const reference instead of a
pointer.

GuyPaddock added a commit that referenced this issue


          [#60] Implement PF2TagLibrary::RequestCombinedTag*() Methods

83a88e3

This makes assembling a gameplay tag from a root tag and suffix name
more efficient by using a `NameBuilder` for this instead of
concatenation.

GuyPaddock added a commit that referenced this issue


          [#60] Update Damage Type Mappings for New Naming

0fdaed6

GuyPaddock added a commit that referenced this issue


          [#60] Gracefully Handle Missing Damage Type

1ca89fa

Previously, if a damage type passed in was not a recognized damage type,
the damage callout would report `-999` as the damage. Now, it merely
renders the proper damage amount in black text.

GuyPaddock added a commit that referenced this issue


          [#60] Switch to GetSingleTagContainer()

ed3b163

GuyPaddock added a commit that referenced this issue


          [#60] Remove Gameplay Tags Step from README.md

1b24bf4

GuyPaddock added a commit that referenced this issue


          [#60] Switch TEML Calculations to Use Native Tags instead of Strings

7adc4e1

This makes the code less fragile if tags get renamed in the future,
since the tag names no longer appear in the code as strings. If the
variable name is wrong, it will fail to build, rather than it being a
run-time error.

GuyPaddock added a commit that referenced this issue


          [#60] Switch Key Ability TEML Calcs. to Use Nat. Tags instead of Strings

9d9db8d

This makes the code less fragile if tags get renamed in the future,
since the tag names no longer appear in the code as strings. If the
variable name is wrong, it will fail to build, rather than it being a
run-time error.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment