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

[Merged by Bors] - Improve EntityMap API #5231

Closed
wants to merge 3 commits into from
Closed

[Merged by Bors] - Improve EntityMap API #5231

wants to merge 3 commits into from

Conversation

Shatur
Copy link
Contributor

@Shatur Shatur commented Jul 6, 2022 •
edited
Loading

Objective

EntityMap lacks documentation, don't have len() / is_empty and insert doesn't work as in the regular HashMap`.

Solution

  • Add len() method.
  • Return previously mapped entity from insert() as in the regular HashMap.
  • Add documentation.

Changelog

  • Add EntityMap::len().
  • Return previously mapped entity from EntityMap::insert() as in the regular HashMap.
  • Add documentation for EntityMap methods.

@Shatur
Improve EntityMap API
7e30574 
* Add len() and is_empty() methods.
* Return previously mapped entity from insert() as in the regular HashMap.
* Add documentation to all methods.
@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-ECS Entities, components, systems, and events labels Jul 6, 2022
alice-i-cecile
alice-i-cecile approved these changes Jul 6, 2022
View reviewed changes
Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like better docs on EntityMap as a whole, but this is 100% an improvement! New methods seem useful and make a lot of sense.

@alice-i-cecile alice-i-cecile added the C-Usability A simple quality-of-life change that makes Bevy easier to use label Jul 6, 2022
@CGMossa
Copy link
Contributor

CGMossa commented Jul 6, 2022

What is this used for?

@Shatur
Copy link
Contributor Author

Shatur commented Jul 6, 2022

What is this used for?

To map entities between scenes and the world.

@Shatur @alice-i-cecile
Update crates/bevy_ecs/src/entity/map_entities.rs
124aa3f 
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
@cart
Copy link
Member

cart commented Jul 8, 2022

bors r+

bors bot pushed a commit that referenced this pull request Jul 8, 2022
@Shatur
Improve EntityMap API (#5231)
17e87f1 
# Objective

`EntityMap` lacks documentation, don't have `len()` / `is_empty` and `insert` doesn't work as in the regular HashMap`.

## Solution

* Add `len()` method.
* Return previously mapped entity from `insert()` as in the regular `HashMap`.
* Add documentation.

---

## Changelog

* Add `EntityMap::len()`.
* Return previously mapped entity from `EntityMap::insert()` as in the regular `HashMap`.
* Add documentation for `EntityMap` methods.
@bors
Copy link
Contributor

bors bot commented Jul 8, 2022

Pull request successfully merged into main.

Build succeeded:

@bors bors bot changed the title Improve EntityMap API [Merged by Bors] - Improve EntityMap API Jul 8, 2022
@bors bors bot closed this Jul 8, 2022
inodentry pushed a commit to IyesGames/bevy that referenced this pull request Aug 8, 2022
@Shatur @inodentry
Improve EntityMap API (bevyengine#5231)
4cf66e4 
# Objective

`EntityMap` lacks documentation, don't have `len()` / `is_empty` and `insert` doesn't work as in the regular HashMap`.

## Solution

* Add `len()` method.
* Return previously mapped entity from `insert()` as in the regular `HashMap`.
* Add documentation.

---

## Changelog

* Add `EntityMap::len()`.
* Return previously mapped entity from `EntityMap::insert()` as in the regular `HashMap`.
* Add documentation for `EntityMap` methods.
james7132 pushed a commit to james7132/bevy that referenced this pull request Oct 28, 2022
@Shatur @james7132
Improve EntityMap API (bevyengine#5231)
85ec69f 
# Objective

`EntityMap` lacks documentation, don't have `len()` / `is_empty` and `insert` doesn't work as in the regular HashMap`.

## Solution

* Add `len()` method.
* Return previously mapped entity from `insert()` as in the regular `HashMap`.
* Add documentation.

---

## Changelog

* Add `EntityMap::len()`.
* Return previously mapped entity from `EntityMap::insert()` as in the regular `HashMap`.
* Add documentation for `EntityMap` methods.
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
@Shatur @ItsDoot
Improve EntityMap API (bevyengine#5231)
8ef86d8 
# Objective

`EntityMap` lacks documentation, don't have `len()` / `is_empty` and `insert` doesn't work as in the regular HashMap`.

## Solution

* Add `len()` method.
* Return previously mapped entity from `insert()` as in the regular `HashMap`.
* Add documentation.

---

## Changelog

* Add `EntityMap::len()`.
* Return previously mapped entity from `EntityMap::insert()` as in the regular `HashMap`.
* Add documentation for `EntityMap` methods.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

Assignees
No one assigned
Labels
A-ECS Entities, components, systems, and events C-Docs An addition or correction to our documentation C-Usability A simple quality-of-life change that makes Bevy easier to use
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@Shatur @CGMossa @cart @alice-i-cecile