Skip to content

[Merged by Bors] - make ComponentTicks::set_changed public #1711

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

Closed
wants to merge 4 commits into from
Closed

[Merged by Bors] - make ComponentTicks::set_changed public #1711

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e984b04
make ComponentTicks::set_changed public
jakobhellermann Mar 20, 2021
0d5ee87
add doc comment
jakobhellermann Mar 21, 2021
deb756c
DerefMut, not Deref
jakobhellermann Mar 22, 2021
bbd7672
change todo!() to unimplemented!()
jakobhellermann Mar 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion crates/bevy_ecs/src/component/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,8 +340,19 @@ impl ComponentTicks {
check_tick(&mut self.changed, change_tick);
}

/// Manually sets the change tick.
/// Usually, this is done automatically via the [`Deref`](std::ops::Deref) implementation on [`Mut`](crate::world::Mut) or [`ResMut`](crate::system::ResMut) etc.
///
/// # Example
/// ```rust,no_run
/// # use bevy_ecs::{world::World, component::ComponentTicks};
/// let world: World = todo!();
/// let component_ticks: ComponentTicks = todo!();
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you intend to fill this in this PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I just wanted the variables in scope, but I agree that todo!() doesn't really fit. Do you think changing it to unimplemented!() would be fine or would you like a larger example with proper values?

Its hard to come up with a simple example as this is the code I used (copied from bevy):

#[inline]
unsafe fn get_component_and_ticks(
    world: &World,
    component_id: ComponentId,
    entity: Entity,
    location: EntityLocation,
) -> Option<(*mut u8, *mut ComponentTicks)> {
    let archetype = &world.archetypes()[location.archetype_id];
    let component_info = world.components().get_info_unchecked(component_id);
    match component_info.storage_type() {
        StorageType::Table => {
            let table = &world.storages().tables[archetype.table_id()];
            let components = table.get_column(component_id)?;
            let table_row = archetype.entity_table_row(location.index);
            // SAFE: archetypes only store valid table_rows and the stored component type is T
            Some((
                components.get_unchecked(table_row),
                components.get_ticks_unchecked(table_row),
            ))
        }
        StorageType::SparseSet => world
            .storages()
            .sparse_sets
            .get(component_id)
            .and_then(|sparse_set| sparse_set.get_with_ticks(entity)),
    }
}

Copy link
Member

Choose a reason for hiding this comment

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

Yeah lets just change these to unimplemented().

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

///
/// component_ticks.set_changed(world.read_change_tick());
/// ```
#[inline]
pub(crate) fn set_changed(&mut self, change_tick: u32) {
pub fn set_changed(&mut self, change_tick: u32) {
self.changed = change_tick;
}
}
Expand Down