forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix #15496 missing doc links (#15542)

Browse Source 
# Objective

- #15496 introduced documentation with some missing links.

## Solution

- Add the missing links and clean up a little.
This commit is contained in:
Antony 2024-09-30 19:41:56 +01:00 committed by GitHub
parent e7c6228e8b
commit 97f2caa693
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
crates/bevy_ecs/src/world/mod.rs
View File

@ -336,19 +336,20 @@ impl World {
/// Registers a new [`Resource`] type and returns the [`ComponentId`] created for it.
///
/// Note that the resource doesn't have a value in world, it's only registered.
/// if you want to insert the [`Resource`] in the [`World`], use [`World::init_resource`] or [`World::insert_resource`] instead.
/// The [`Resource`] doesn't have a value in the [`World`], it's only registered. If you want
/// to insert the [`Resource`] in the [`World`], use [`World::init_resource`] or
/// [`World::insert_resource`] instead.
pub fn register_resource<R: Resource>(&mut self) -> ComponentId {
self.components.register_resource::<R>()
}
/// Returns the [`ComponentId`] of the given [`Resource`] type `T`.
///
/// The returned `ComponentId` is specific to the `World` instance
/// it was retrieved from and should not be used with another `World` instance.
/// The returned [`ComponentId`] is specific to the [`World`] instance it was retrieved from
/// and should not be used with another [`World`] instance.
///
/// Returns [`None`] if the `Resource` type has not yet been initialized within
/// the `World` using [`World::register_resource`], [`World::init_resource`] or [`World::insert_resource`].
/// Returns [`None`] if the [`Resource`] type has not yet been initialized within the
/// [`World`] using [`World::register_resource`], [`World::init_resource`] or [`World::insert_resource`].
pub fn resource_id<T: Resource>(&self) -> Option<ComponentId> {
self.components.get_resource_id(TypeId::of::<T>())
}