4 lines
10 KiB
HTML
4 lines
10 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Types for declaring and storing `Component`s."><title>bevy_ecs::component - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bevy_ecs" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="icon" href="https://bevyengine.org/assets/icon.png"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../../bevy_ecs/index.html"><img src="https://bevyengine.org/assets/icon.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../bevy_ecs/index.html"><img src="https://bevyengine.org/assets/icon.png" alt="logo"></a><h2><a href="../../bevy_ecs/index.html">bevy_<wbr>ecs</a><span class="version">0.15.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module component</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li><li><a href="#derives" title="Derive Macros">Derive Macros</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate bevy_<wbr>ecs</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">bevy_ecs</a></span><h1>Module <span>component</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/bevy_ecs/component.rs.html#1-1855">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Types for declaring and storing <a href="trait.Component.html" title="trait bevy_ecs::component::Component"><code>Component</code></a>s.</p>
|
|
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.ComponentDescriptor.html" title="struct bevy_ecs::component::ComponentDescriptor">Component<wbr>Descriptor</a></div><div class="desc docblock-short">A value describing a component or resource, which may or may not correspond to a Rust type.</div></li><li><div class="item-name"><a class="struct" href="struct.ComponentHooks.html" title="struct bevy_ecs::component::ComponentHooks">Component<wbr>Hooks</a></div><div class="desc docblock-short"><a href="../world/struct.World.html" title="struct bevy_ecs::world::World"><code>World</code></a>-mutating functions that run as part of lifecycle events of a <a href="trait.Component.html" title="trait bevy_ecs::component::Component"><code>Component</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.ComponentId.html" title="struct bevy_ecs::component::ComponentId">Component<wbr>Id</a></div><div class="desc docblock-short">A value which uniquely identifies the type of a <a href="trait.Component.html" title="trait bevy_ecs::component::Component"><code>Component</code></a> or <a href="../system/trait.Resource.html" title="trait bevy_ecs::system::Resource"><code>Resource</code></a> within a
|
|
<a href="../world/struct.World.html" title="struct bevy_ecs::world::World"><code>World</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.ComponentIdFor.html" title="struct bevy_ecs::component::ComponentIdFor">Component<wbr>IdFor</a></div><div class="desc docblock-short">A <a href="../system/trait.SystemParam.html" title="trait bevy_ecs::system::SystemParam"><code>SystemParam</code></a> that provides access to the <a href="struct.ComponentId.html" title="struct bevy_ecs::component::ComponentId"><code>ComponentId</code></a> for a specific component type.</div></li><li><div class="item-name"><a class="struct" href="struct.ComponentInfo.html" title="struct bevy_ecs::component::ComponentInfo">Component<wbr>Info</a></div><div class="desc docblock-short">Stores metadata for a type of component or resource stored in a specific <a href="../world/struct.World.html" title="struct bevy_ecs::world::World"><code>World</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.ComponentTicks.html" title="struct bevy_ecs::component::ComponentTicks">Component<wbr>Ticks</a></div><div class="desc docblock-short">Records when a component or resource was added and when it was last mutably dereferenced (or added).</div></li><li><div class="item-name"><a class="struct" href="struct.Components.html" title="struct bevy_ecs::component::Components">Components</a></div><div class="desc docblock-short">Stores metadata associated with each kind of <a href="trait.Component.html" title="trait bevy_ecs::component::Component"><code>Component</code></a> in a given <a href="../world/struct.World.html" title="struct bevy_ecs::world::World"><code>World</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.RequiredComponent.html" title="struct bevy_ecs::component::RequiredComponent">Required<wbr>Component</a></div><div class="desc docblock-short">Metadata associated with a required component. See <a href="trait.Component.html" title="trait bevy_ecs::component::Component"><code>Component</code></a> for details.</div></li><li><div class="item-name"><a class="struct" href="struct.RequiredComponentConstructor.html" title="struct bevy_ecs::component::RequiredComponentConstructor">Required<wbr>Component<wbr>Constructor</a></div><div class="desc docblock-short">A Required Component constructor. See <a href="trait.Component.html" title="trait bevy_ecs::component::Component"><code>Component</code></a> for details.</div></li><li><div class="item-name"><a class="struct" href="struct.RequiredComponents.html" title="struct bevy_ecs::component::RequiredComponents">Required<wbr>Components</a></div><div class="desc docblock-short">The collection of metadata for components that are required for a given component.</div></li><li><div class="item-name"><a class="struct" href="struct.Tick.html" title="struct bevy_ecs::component::Tick">Tick</a></div><div class="desc docblock-short">A value that tracks when a system ran relative to other systems.
|
|
This is used to power change detection.</div></li><li><div class="item-name"><a class="struct" href="struct.TickCells.html" title="struct bevy_ecs::component::TickCells">Tick<wbr>Cells</a></div><div class="desc docblock-short">Interior-mutable access to the <a href="struct.Tick.html" title="struct bevy_ecs::component::Tick"><code>Tick</code></a>s for a single component or resource.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.RequiredComponentsError.html" title="enum bevy_ecs::component::RequiredComponentsError">Required<wbr>Components<wbr>Error</a></div><div class="desc docblock-short">An error returned when the registration of a required component fails.</div></li><li><div class="item-name"><a class="enum" href="enum.StorageType.html" title="enum bevy_ecs::component::StorageType">Storage<wbr>Type</a></div><div class="desc docblock-short">The storage used for a specific component type.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Component.html" title="trait bevy_ecs::component::Component">Component</a></div><div class="desc docblock-short">A data type that can be used to store data for an <a href="../entity/index.html" title="mod bevy_ecs::entity">entity</a>.</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.ComponentHook.html" title="type bevy_ecs::component::ComponentHook">Component<wbr>Hook</a></div><div class="desc docblock-short">The type used for <a href="trait.Component.html" title="trait bevy_ecs::component::Component"><code>Component</code></a> lifecycle hooks such as <code>on_add</code>, <code>on_insert</code> or <code>on_remove</code></div></li></ul><h2 id="derives" class="section-header">Derive Macros<a href="#derives" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="derive" href="derive.Component.html" title="derive bevy_ecs::component::Component">Component</a></div></li></ul></section></div></main></body></html> |