Skip to content

Commit 57c119f

Browse files
committed
Documentation updates
1 parent e24c6ff commit 57c119f

File tree

6 files changed

+19
-19
lines changed

6 files changed

+19
-19
lines changed

CHANGELOG.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
See [the roadmap](./docs/overview/roadmap.md) for details
1111

12+
## [3.1.0]
13+
1214
### Added
1315

1416
- **Pool Access Frequency Tracking**: Intelligent purge decisions based on pool usage patterns
@@ -57,10 +59,7 @@ See [the roadmap](./docs/overview/roadmap.md) for details
5759
- Lifecycle hooks automatically registered via `RuntimeInitializeOnLoadMethod`
5860
- **RandomExtensions `NextOfExcept`**: New extension methods for selecting random elements with exclusions
5961
- `NextOfExcept(values)` - no exclusions (convenience overload)
60-
- `NextOfExcept(values, exception1)` - exclude one value
61-
- `NextOfExcept(values, exception1, exception2)` - exclude two values
62-
- `NextOfExcept(values, exception1, exception2, exception3)` - exclude three values
63-
- `NextOfExcept(values, exceptions)` - exclude arbitrary set of values
62+
- `NextOfExcept(values, exception1...)` - exclude values
6463
- Zero-allocation using pooled collections internally
6564

6665
### Changed
@@ -71,7 +70,7 @@ See [the roadmap](./docs/overview/roadmap.md) for details
7170
- `DefaultHysteresisSeconds` defaults to `120` (was `60`)
7271
- `DefaultSpikeThresholdMultiplier` defaults to `2.5` (was `2.0`)
7372
- Use `PoolPurgeSettings.DisableGlobally()` to restore previous behavior
74-
- `UnityMainThreadDispatcher` auto-load behavior has changed from auto-loading to not auto-loading (you will need to manually create it.)
73+
- `UnityMainThreadDispatcher` auto-load behavior has changed from auto-loading to not auto-loading.
7574
- `UnityMainThreadDispatcher` hide flags have been changed to `None`.
7675

7776
- **DictionaryExtensions `ToDictionary`**: Now uses last-wins semantics for duplicate keys instead of throwing `ArgumentException`

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -452,7 +452,7 @@ Add to your `Packages/manifest.json`:
452452
}
453453
],
454454
"dependencies": {
455-
"com.wallstop-studios.unity-helpers": "2.2.0"
455+
"com.wallstop-studios.unity-helpers": "3.1.0"
456456
}
457457
}
458458
```
@@ -475,7 +475,7 @@ Install directly from GitHub for the latest version:
475475
}
476476
```
477477

478-
> **Tip:** To lock to a specific version, append `#v2.2.0` to the URL.
478+
> **Tip:** To lock to a specific version, append `#3.1.0` to the URL.
479479
480480
### From NPM Registry
481481

docs/features/effects/effects-system-tutorial.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,7 @@ Select `HasteEffect` and set these values in Inspector:
136136

137137
**Tags:**
138138

139-
- Effect Tags: Add tag `"Haste"`
140-
- Grant Tags: Add tag `"Haste"` (allows gameplay queries)
139+
- Effect Tags: Add `"Haste"` (used for both gameplay queries via `HasTag()` and effect organization)
141140

142141
### 3.3 Add Visual Effects (Optional)
143142

@@ -219,8 +218,7 @@ Let's make a more complex effect that prevents movement.
219218

220219
**Tags:**
221220

222-
- Effect Tags: `"Stun"`, `"Debuff"`
223-
- Grant Tags: `"Stunned"`, `"CC"` (crowd control)
221+
- Effect Tags: `"Stunned"`, `"Stun"`, `"Debuff"`, `"CC"` (for gameplay queries and organization)
224222

225223
### 5.3 Query Tags in Gameplay
226224

docs/features/effects/effects-system.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2100,17 +2100,20 @@ public class DebugConsole : MonoBehaviour
21002100
/// Burning - Takes fire damage over time, can ignite others
21012101
```
21022102

2103-
4. **Use effect tags for internal organization**
2103+
4. **Use effect tags for multiple purposes**
21042104

21052105
```csharp
2106-
// EffectTags vs GrantTags:
2107-
// - EffectTags: Internal organization (removable via GetHandlesWithTag + RemoveEffects)
2108-
// - GrantTags: Gameplay queries (checked via HasTag)
2106+
// effectTags serve multiple purposes:
2107+
// - Internal organization (removable via GetHandlesWithTag + RemoveEffects)
2108+
// - Gameplay queries (checked via HasTag)
2109+
// - Effect identification and categorization
21092110
21102111
// Example effect:
21112112
// HastePotion.asset:
2112-
// - effectTags: ["Potion", "Buff", "Consumable"] // For removal/organization
2113-
// - grantTags: ["Haste", "MovementBuff"] // For gameplay queries
2113+
// - effectTags: ["Haste", "Potion", "Buff", "MovementBuff"]
2114+
// - Use "Haste" for gameplay queries (player.HasTag("Haste"))
2115+
// - Use "Potion" for finding/removing all potions
2116+
// - Use "Buff" for UI categorization
21142117
```
21152118

21162119
5. **Test tag combinations** - Verify interactions work correctly

docs/images/unity-helpers-banner.svg

Lines changed: 1 addition & 1 deletion
Loading

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "com.wallstop-studios.unity-helpers",
3-
"version": "3.0.5",
3+
"version": "3.1.0",
44
"displayName": "Unity Helpers",
55
"description": "Treasure chest of Unity developer tools ",
66
"unity": "2021.3",

0 commit comments

Comments
 (0)