Skip to content
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

feat!: use new LevelIid type in LevelEvent, LevelSet, and LevelSelection, plus other improvements #219

Merged
merged 23 commits into from
Aug 15, 2023
Merged

feat!: use new LevelIid type in LevelEvent, LevelSet, and LevelSelection, plus other improvements #219

merged 23 commits into from
Aug 15, 2023

Conversation

Trouv
Copy link
Owner

@Trouv Trouv commented Aug 13, 2023 •
edited
Loading

Consistently typing level iids throughout our API will help prevent bugs in bevy_ecs_ldtk, and will help users prevent bugs in their own code as well. Receiving a LevelIid in various places in the ECS API will eventually be even more helpful when we provide features allowing users to lookup raw/loaded level data by reference using a LevelIid.

I also made some other refactors here. For one, I moved each of these types into their own modules. This won't be their final resting place, but I think it'll be easier to move them around later if these items are lonely.

Changes

  • add LevelSelection::iid constructor for creating that variant from a string.
  • add LevelIid::get for getting the internal value as a &String
  • update many doc links for consistent formatting and linking dependencies with https
  • update systems to use LevelIid where necessary, and even improve performance in a couple spots.
  • add some trivial doctests/tests for the affected types
  • implement IntoIterator and FromIterator for LevelSet
  • refactor LevelIid, LevelSet and LevelSelection into their own private modules without changing imports

Breaking

BEGIN_COMMIT_OVERRIDE
feat!: use new LevelIid type in LevelEvent, LevelSet, and LevelSelection, plus other improvements (#219)

feat!: change LevelEvent inner types from String to LevelIid (#219)
feat!: change LevelSet inner type from String to LevelIid (#219)
feat!: change LevelSelection::Iid inner type from String to LevelIid (#219)
feat!: replace LevelSet::from_iid with LevelSet::from_iids, which can convert from any collection of strings. (#219)
END_COMMIT_OVERRIDE

Trouv added 23 commits August 12, 2023 17:08
@Trouv
refactor: make resources a directory module for now
b3e231d
@Trouv
feat: move LevelSelection to its own file
1ef7523
@Trouv
feat: add LevelIid::get for getting the level Iid as a String
de66555
@Trouv
feat: use LevelIid as inner type for LevelSelection::Iid, and provide…
c964406 
… a more convenient constructor
@Trouv
refactor: move LevelSet to its own module
5fc6b5d
@Trouv
feat: use LevelIid in LevelSet
ab5cd4b
@Trouv
feat: implement iterator conversion for LevelSet
0487e7a
@Trouv
feat: improve memory management of pre-spawning levels
5d0a77c
@Trouv
feat: do a little more borrowing in apply_level_set
eb1e5e4
@Trouv
refactor: move LevelEvent to its own module
c3e7d19
@Trouv
feat: update LevelEvent to use LevelIids internally
422af79
@Trouv
docs(example): update level set example to use LevelIids
138be29
@Trouv
test: add one more test case to string_converts_to_and_from_level_iid
5775e48
@Trouv
docs: fix doc links for LevelSet
f870ab2
@Trouv
feat: change from_iid to from_iids which accepts a generic iterator
d6b258c
@Trouv
feat: update level_set example to use LevelSet::from_iids
cd010b5
@Trouv
test: add another trivial test for LevelSet
ebd4e6c
@Trouv
docs: properly link to Component in LevelIid docs
07aebe0
@Trouv
docs: update imports in components module to adjust for moved/unused …
660cccb 
…unused imports
@Trouv
docs: update LevelSelection docs with proper links and a doctest
db7696b
@Trouv
docs: fix typo in LevelSelection::is_match docs
e8b55fb
@Trouv
docs: no longer use unused unused import in resources module
8e7d2e0
@Trouv
docs: fix code links in LevelEvent docs
3d6d6a3
@Trouv Trouv changed the title feat!: use new LevelIid type in LevelEvent, LevelSet, and LevelSelection, plus other improvements feat!: use new LevelIid type in LevelEvent, LevelSet, and LevelSelection, plus other improvements Aug 13, 2023
@Trouv Trouv merged commit 0039ed7 into main Aug 15, 2023
@github-actions github-actions bot mentioned this pull request Aug 10, 2023
Merged
@Trouv Trouv deleted the feat/level-iid-everywhere branch August 26, 2023 23:25
Trouv added a commit that referenced this pull request Feb 11, 2024
@github-actions @Trouv
chore(main): release 0.9.0 (#213)
e040747 
🤖 I have created a release *beep* *boop*
---


##
[0.9.0](v0.8.0...v0.9.0)
(2024-02-11)


### ⚠ BREAKING CHANGES

* upgrade to bevy 0.12
([#265](#265))
* upgrade to LDtk 1.5.3, dropping support for previous versions
([#295](#295))
* add `SpawnExclusions` to `LdtkSettings` for skipping layers by
identifier ([#275](#275))
* add layer entity for Entity layers, changing the hierarchy
([#257](#257))
* upgrade to LDtk types and examples to 1.4.1 (drop support for <1.4.1)
([#256](#256))
* LdtkLevel renamed to LdtkExternalLevel and is no longer used as a
component ([#244](#244))
* redesign LdtkProject with better level data accessors and correct
modeling of internal/external levels
([#244](#244))
* use the bundle's `Default` implementation rather than the field's in
`LdtkEntity` and `LdtkIntCell` derive macros
([#222](#222))
* add `RawLevelAccessor` trait for `LdtkJson` level borrowing/iteration,
replacing existing methods
([#225](#225))
* add `LevelIndices` type defining a level's location in a project and
use it in `LevelSelection::Indices`
([#221](#221))
* change `LevelEvent` inner types from `String` to `LevelIid`
([#219](#219))
* change `LevelSet` inner type from `String` to `LevelIid`
([#219](#219))
* change `LevelSelection::Iid` inner type from `String` to `LevelIid`
([#219](#219))
* replace `LevelSet::from_iid` with `LevelSet::from_iids`, which can
convert from any collection of strings.
([#219](#219))
* use new LevelIid type in LevelEvent, LevelSet, and LevelSelection,
plus other improvements
([#219](#219))
* `LdtkProject::project` and `LdtkLevel::level` fields have both been
renamed to `data`
([#206](#206))
* All fields of `LdtkProject` and `LdtkLevel` are now privatized, and
have immutable getter methods
([#206](#206))
* `LevelMap` and `TilesetMap` type aliases have been removed
([#206](#206))
* `LdtkAsset` and `LdtkProject` are now exported in new `assets` module
instead of `lib.rs`
([#206](#206))
* asset `Loader` types are now private
([#206](#206))
* `LdtkAsset` renamed to `LdtkProject`
([#206](#206))

### Features

* add `LevelIndices` type defining a level's location in a project and
use it in `LevelSelection::Indices`
([#221](#221))
([59618fe](59618fe))
* add `RawLevelAccessor` trait for `LdtkJson` level borrowing/iteration,
replacing existing methods
([#225](#225))
([d3de2d9](d3de2d9))
* add `SpawnExclusions` to `LdtkSettings` for skipping layers by
identifier ([#275](#275))
([282404d](282404d)),
closes [#272](#272)
* add layer entity for Entity layers, changing the hierarchy
([#257](#257))
([ee20a53](ee20a53))
* add LdtkJsonWithMetadata type for representing internal- and
external-level project data with generics
([#242](#242))
([630434a](630434a))
* add LdtkProjectData for representing either internal- or
external-level project data concretely
([#243](#243))
([c530bc9](c530bc9))
* add level locale types and begin splitting internal_levels and
external_levels features
([#237](#237))
([8129e55](8129e55))
* add LevelIid component and spawn it on every level
([#215](#215))
([ad83455](ad83455))
* add LoadedLevel type that wraps around levels with complete data
([#214](#214))
([3d40c15](3d40c15))
* add types and traits around LevelMetadata
([#229](#229))
([382dea2](382dea2))
* change `LevelEvent` inner types from `String` to `LevelIid`
([#219](#219))
([0039ed7](0039ed7))
* change `LevelSelection::Iid` inner type from `String` to `LevelIid`
([#219](#219))
([0039ed7](0039ed7))
* change `LevelSet` inner type from `String` to `LevelIid`
([#219](#219))
([0039ed7](0039ed7))
* LdtkLevel renamed to LdtkExternalLevel and is no longer used as a
component ([#244](#244))
([670cd4e](670cd4e))
* redesign LdtkProject with better level data accessors and correct
modeling of internal/external levels
([#244](#244))
([670cd4e](670cd4e))
* replace `LevelSet::from_iid` with `LevelSet::from_iids`, which can
convert from any collection of strings.
([#219](#219))
([0039ed7](0039ed7))
* upgrade to bevy 0.12
([#265](#265))
([194731e](194731e))
* upgrade to LDtk 1.5.3, dropping support for previous versions
([#295](#295))
([4926a50](4926a50))
* upgrade to LDtk types and examples to 1.4.1 (drop support for
&lt;1.4.1) ([#256](#256))
([ab21e2c](ab21e2c))
* use new LevelIid type in LevelEvent, LevelSet, and LevelSelection,
plus other improvements
([#219](#219))
([0039ed7](0039ed7))
* use the bundle's `Default` implementation rather than the field's in
`LdtkEntity` and `LdtkIntCell` derive macros
([#222](#222))
([f003127](f003127))


### Bug Fixes

* don't apply level set until project and dependencies are completely
loaded ([#296](#296))
([dbfe1c6](dbfe1c6))
* normalize resolved asset paths using `path_clean`
([#255](#255))
([33a8998](33a8998)),
closes [#240](#240)
* only spawn invisible tiles on first sub-layer of AutoTile+IntGrid
layers ([#231](#231))
([d2873e3](d2873e3))
* recalculate layer offset to adjust for tileset sizes
([#254](#254))
([c00085d](c00085d))
* use entity definition tile size instead of entity instance tile size
as basis when calculating ldtk entity scale
([#271](#271))
([833af01](833af01))


### Documentation Changes

* add 0.8 to 0.9 migration guide
([#266](#266))
([bb91660](bb91660))
* add collectathon cargo example
([#288](#288))
([32dfb85](32dfb85))
* add mdbook with outline and introduction
([#261](#261))
([810b25a](810b25a))
* add tile-based game example w/ a tutorial in the book, replacing
getting-started guide
([#269](#269))
([2d43efa](2d43efa))
* document all-features in docs.rs
([#252](#252))
([321bb07](321bb07))
* reference book in API ref and README.md, replacing redundant sections
([#282](#282))
([e7afdad](e7afdad))
* remove README.md caveat for hot reloading external levels
([#253](#253))
([59eb6b3](59eb6b3))
* write *Anatomy of the World* chapter of book
([#285](#285))
([29d5e33](29d5e33))
* write *Create bevy relations from ldtk entity references* chapter of
book ([#287](#287))
([8080f24](8080f24))
* write *Game Logic Integration* chapter of the book
([#279](#279))
([a62a556](a62a556))
* write *Level Selection* chapter of book
([#284](#284))
([226c60c](226c60c))
* write *Make level selection follow player* chapter of book
([#293](#293))
([201d908](201d908))
* write *Respawn levels and worlds* chapter of book
([#289](#289))
([55ed30f](55ed30f))


### Code Refactors

* `LdtkAsset` and `LdtkProject` are now exported in new `assets` module
instead of `lib.rs`
([#206](#206))
([fe44774](fe44774))
* `LdtkAsset` renamed to `LdtkProject`
([#206](#206))
([fe44774](fe44774))
* `LdtkProject::project` and `LdtkLevel::level` fields have both been
renamed to `data`
([#206](#206))
([fe44774](fe44774))
* `LevelMap` and `TilesetMap` type aliases have been removed
([#206](#206))
([fe44774](fe44774))
* All fields of `LdtkProject` and `LdtkLevel` are now privatized, and
have immutable getter methods
([#206](#206))
([fe44774](fe44774))
* asset `Loader` types are now private
([#206](#206))
([fe44774](fe44774))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: Trevor Lovell <trevorlovelldesign@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Trouv