Struct CreatePortal

pub struct CreatePortal {
    pub destination: PortalDestinationSource,
    pub portal_mode: PortalMode,
    pub main_camera: Option<Entity>,
    pub cull_mode: Option<Face>,
    pub render_layer: RenderLayers,
    pub debug: Option<DebugPortal>,
}

Component to create a Portal and everything needed to make it work.

The portal will be created with everything needed by a trigger after the insertion/spawning command is flushed, and this component will be removed.

Requires Mesh3d to define the mesh of the portal, and all its dependencies. Indirectly requires Transform to locate the portal.

Fields

destination: PortalDestinationSource

Where the portal should lead to.

portal_mode: PortalMode

What technique to use to render the portal effect, and how to define the frustum when applicable.

main_camera: Option<Entity>

The camera that will see this portal, defaults to the first camera found.

cull_mode: Option<Face>

Whether to cull the “front”, “back” or neither side of a the portal mesh.

If set to None, the two sides of the portal are visible and work as a portal. Be sure to set an appropriate PortalMode so that the frustum isn’t assuming you only see the back of your mesh.

Defaults to Some(Face::Back), see StandardMaterial.

render_layer: RenderLayers

Render layer used by the PortalCamera, and debug elements.

debug: Option<DebugPortal>

Configures debug elements, defaults to None.

Trait Implementations

impl Clone for CreatePortal

fn clone(&self) -> CreatePortal

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for CreatePortal

where Self: Send + Sync + 'static,

Required Components: Mesh3d.

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

Called when registering this component, allowing mutable access to its ComponentHooks.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Default for CreatePortal

fn default() -> Self

Returns the “default value” for a type.