Skip to main content

ParamSet

Struct ParamSet 

Source
pub struct ParamSet<'w, 's, T>
where T: SystemParam,
{ /* private fields */ }
Expand description

A collection of potentially conflicting SystemParams allowed by disjoint access.

Allows systems to safely access and interact with up to 8 mutually exclusive SystemParams, such as two queries that reference the same mutable data or an event reader and writer of the same type.

Each individual SystemParam can be accessed by using the functions p0(), p1(), …, p7(), according to the order they are defined in the ParamSet. This ensures that there’s either only one mutable reference to a parameter at a time or any number of immutable references.

§Examples

The following system mutably accesses the same component two times, which is not allowed due to rust’s mutability rules.

ⓘ
// This will panic at runtime when the system gets initialized.
fn bad_system(
    mut enemies: Query<&mut Health, With<Enemy>>,
    mut allies: Query<&mut Health, With<Ally>>,
) {
    // ...
}

Conflicting SystemParams like these can be placed in a ParamSet, which leverages the borrow checker to ensure that only one of the contained parameters are accessed at a given time.

// Given the following system
fn fancy_system(
    mut set: ParamSet<(
        Query<&mut Health, With<Enemy>>,
        Query<&mut Health, With<Ally>>,
    )>
) {
    // This will access the first `SystemParam`.
    for mut health in set.p0().iter_mut() {
        // Do your fancy stuff here...
    }

    // The second `SystemParam`.
    // This would fail to compile if the previous parameter was still borrowed.
    for mut health in set.p1().iter_mut() {
        // Do even fancier stuff here...
    }
}

Of course, ParamSets can be used with any kind of SystemParam, not just queries.

fn message_system(
    mut set: ParamSet<(
        // PROBLEM: `MessageReader` and `MessageWriter` cannot be used together normally,
        // because they both need access to the same message queue.
        // SOLUTION: `ParamSet` allows these conflicting parameters to be used safely
        // by ensuring only one is accessed at a time.
        // Note that a better solution here is to use `MessageMutator`,
        // which both reads and writes messages with a single parameter.
        MessageReader<MyMessage>,
        MessageWriter<MyMessage>,
        // PROBLEM: `&World` needs read access to everything, which conflicts with
        // any mutable access in the same system.
        // SOLUTION: `ParamSet` ensures `&World` is only accessed when we're not
        // using the other mutable parameters.
        &World,
    )>,
) {
    for message in set.p0().read() {
        // ...
    }
    set.p1().write(MyMessage::new());

    let entities = set.p2().entities();
    // ...
}

Implementations§

Source§

impl<'w, 's, P0> ParamSet<'w, 's, (P0,)>
where P0: SystemParam,

Source

pub fn p0<'a>(&'a mut self) -> <P0 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 0 in this ParamSet. No other parameters may be accessed while this one is active.

Source§

impl<'w, 's, P0, P1> ParamSet<'w, 's, (P0, P1)>
where P0: SystemParam, P1: SystemParam,

Source

pub fn p0<'a>(&'a mut self) -> <P0 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 0 in this ParamSet. No other parameters may be accessed while this one is active.

Examples found in repository?
examples/showcase/alien_cake_addict.rs (line 304)
268fn focus_camera(
269    time: Res<Time>,
270    mut game: ResMut<Game>,
271    mut transforms: ParamSet<(Query<&mut Transform, With<Camera3d>>, Query<&Transform>)>,
272) {
273    const SPEED: f32 = 2.0;
274    // if there is both a player and a bonus, target the mid-point of them
275    if let (Some(player_entity), Some(bonus_entity)) = (game.player.entity, game.bonus.entity) {
276        let transform_query = transforms.p1();
277        if let (Ok(player_transform), Ok(bonus_transform)) = (
278            transform_query.get(player_entity),
279            transform_query.get(bonus_entity),
280        ) {
281            game.camera_should_focus = player_transform
282                .translation
283                .lerp(bonus_transform.translation, 0.5);
284        }
285        // otherwise, if there is only a player, target the player
286    } else if let Some(player_entity) = game.player.entity {
287        if let Ok(player_transform) = transforms.p1().get(player_entity) {
288            game.camera_should_focus = player_transform.translation;
289        }
290        // otherwise, target the middle
291    } else {
292        game.camera_should_focus = Vec3::from(RESET_FOCUS);
293    }
294    // calculate the camera motion based on the difference between where the camera is looking
295    // and where it should be looking; the greater the distance, the faster the motion;
296    // smooth out the camera movement using the frame time
297    let mut camera_motion = game.camera_should_focus - game.camera_is_focus;
298    if camera_motion.length() > 0.2 {
299        camera_motion *= SPEED * time.delta_secs();
300        // set the new camera's actual focus
301        game.camera_is_focus += camera_motion;
302    }
303    // look at that new camera's actual focus
304    for mut transform in transforms.p0().iter_mut() {
305        *transform = transform.looking_at(game.camera_is_focus, Vec3::Y);
306    }
307}
More examples
Hide additional examples
examples/ui/text/multiline_text_input.rs (line 240)
55fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
56    commands.spawn(Camera2d);
57
58    commands
59        .spawn(Node {
60            width: percent(100.),
61            height: percent(100.),
62            justify_content: JustifyContent::Center,
63            align_items: AlignItems::Center,
64            ..default()
65        })
66        .with_children(|parent| {
67            parent
68                .spawn((
69                    Node {
70                        flex_direction: FlexDirection::Column,
71                        align_items: AlignItems::End,
72                        row_gap: px(10.),
73                        ..default()
74                    },
75                    TabGroup::default(),
76                ))
77                .with_children(|parent| {
78                    parent
79                        .spawn(Node {
80                            display: Display::Grid,
81                            grid_template_columns: vec![
82                                RepeatedGridTrack::auto(1),
83                                RepeatedGridTrack::auto(1),
84                            ],
85                            column_gap: px(4.),
86                            ..default()
87                        })
88                        .with_children(|parent| {
89                            parent
90                                .spawn((
91                                    Node {
92                                        width: px(450.),
93                                        border: px(2.).all(),
94                                        padding: px(8.).all(),
95                                        ..default()
96                                    },
97                                    TextInput,
98                                    EditableText {
99                                        visible_lines: Some(8.),
100                                        allow_newlines: true,
101                                        ..default()
102                                    },
103                                    TextLayout {
104                                        linebreak: LineBreak::WordOrCharacter,
105                                        ..default()
106                                    },
107                                    TextCursorStyle {
108                                        color: Color::WHITE,
109                                        selected_text_color: Some(Color::BLACK),
110                                        ..default()
111                                    },
112                                    TextFont {
113                                        font: asset_server.load("fonts/FiraMono-Medium.ttf").into(),
114                                        font_size: FontSize::Px(30.),
115                                        ..default()
116                                    },
117                                    BackgroundColor(DARK_SLATE_GRAY.into()),
118                                    BorderColor::all(SLATE_300),
119                                    MultilineInput,
120                                    TabIndex(0),
121                                    AutoFocus,
122                                ))
123                                .observe(
124                                    |on: On<FocusedInput<KeyboardInput>>,
125                                     keys: Res<ButtonInput<Key>>,
126                                     input_query: Query<&EditableText, With<MultilineInput>>| {
127                                        if !(on.input.state.is_pressed()
128                                            && on.input.logical_key == Key::Enter
129                                            && keys.pressed(Key::Control))
130                                        {
131                                            return;
132                                        }
133                                        let Ok(input) = input_query.get(on.focused_entity) else {
134                                            return;
135                                        };
136
137                                        let mut output = String::new();
138                                        output
139                                            .reserve(input.value().into_iter().map(str::len).sum());
140                                        for sub_str in input.value() {
141                                            output.push_str(sub_str);
142                                        }
143
144                                        info!("{output}");
145                                    },
146                                );
147
148                            // Vertical scrollbar for the multiline input above. Not part of the
149                            // input's tab group and has no `TabIndex`, so it's unreachable via
150                            // Tab navigation and can't take input focus.
151                            parent
152                                .spawn((
153                                    Node {
154                                        min_width: px(10.),
155                                        ..default()
156                                    },
157                                    BackgroundColor(DARK_SLATE_GRAY.into()),
158                                ))
159                                .with_children(|parent| {
160                                    parent
161                                        .spawn((
162                                            Node {
163                                                position_type: PositionType::Absolute,
164                                                width: percent(100.),
165                                                left: px(0.),
166                                                border_radius: BorderRadius::all(px(4.)),
167                                                ..default()
168                                            },
169                                            BackgroundColor(SLATE_300.into()),
170                                            Visibility::Hidden,
171                                            InputScrollThumb,
172                                            InputScrollDragState::default(),
173                                        ))
174                                        .observe(on_thumb_drag_start)
175                                        .observe(on_thumb_drag)
176                                        .observe(on_thumb_drag_end);
177                                });
178                        });
179
180                    parent
181                        .spawn((
182                            Node {
183                                flex_direction: FlexDirection::Row,
184                                column_gap: px(10.),
185                                ..default()
186                            },
187                            children![
188                                (
189                                    Text::new("visible lines:"),
190                                    TextFont {
191                                        font: asset_server.load("fonts/FiraMono-Medium.ttf").into(),
192                                        font_size: FontSize::Px(30.),
193                                        ..default()
194                                    },
195                                ),
196                                (
197                                    Node {
198                                        width: px(100.),
199                                        border: px(2.).all(),
200                                        ..default()
201                                    },
202                                    TextFont {
203                                        font: asset_server.load("fonts/FiraMono-Medium.ttf").into(),
204                                        font_size: FontSize::Px(30.),
205                                        ..default()
206                                    },
207                                    TextLayout {
208                                        justify: Justify::End,
209                                        ..default()
210                                    },
211                                    BackgroundColor(DARK_SLATE_GRAY.into()),
212                                    BorderColor::all(SLATE_300),
213                                    TextInput,
214                                    EditableText::new("8"),
215                                    EditableTextFilter::new(|c| c.is_ascii_digit() || c == '.'),
216                                    TextCursorStyle {
217                                        color: Color::WHITE,
218                                        selected_text_color: Some(Color::BLACK),
219                                        unfocused_selection_color: Color::NONE,
220                                        ..default()
221                                    },
222                                    SelectAllOnFocus,
223                                    VisibleLinesInput,
224                                    TabIndex(1),
225                                )
226                            ],
227                        ))
228                        .observe(
229                            |on: On<FocusedInput<KeyboardInput>>,
230                             mut query_set: ParamSet<(
231                                Query<&EditableText, With<VisibleLinesInput>>,
232                                Query<&mut EditableText, With<MultilineInput>>,
233                            )>| {
234                                if !(on.input.state.is_pressed()
235                                    && on.input.logical_key == Key::Enter)
236                                {
237                                    return;
238                                }
239
240                                let visible_lines_query = query_set.p0();
241                                let Ok(input) = visible_lines_query.get(on.original_event_target())
242                                else {
243                                    return;
244                                };
245
246                                let mut output = String::new();
247                                output.reserve(input.value().into_iter().map(str::len).sum());
248                                for sub_str in input.value() {
249                                    output.push_str(sub_str);
250                                }
251
252                                let Ok(lines) = output.parse::<f32>() else {
253                                    return;
254                                };
255
256                                let mut multiline_query = query_set.p1();
257                                let Ok(mut multiline_input) = multiline_query.single_mut() else {
258                                    return;
259                                };
260
261                                multiline_input.visible_lines = Some(lines.clamp(1., 10.));
262                            },
263                        );
264
265                    parent
266                        .spawn((
267                            Node {
268                                flex_direction: FlexDirection::Row,
269                                column_gap: px(10.),
270                                ..default()
271                            },
272                            children![
273                                (
274                                    Text::new("font size:"),
275                                    TextFont {
276                                        font: asset_server.load("fonts/FiraMono-Medium.ttf").into(),
277                                        font_size: FontSize::Px(30.),
278                                        ..default()
279                                    },
280                                ),
281                                (
282                                    Node {
283                                        width: px(100.),
284                                        border: px(2.).all(),
285                                        ..default()
286                                    },
287                                    TextFont {
288                                        font: asset_server.load("fonts/FiraMono-Medium.ttf").into(),
289                                        font_size: FontSize::Px(30.),
290                                        ..default()
291                                    },
292                                    TextLayout {
293                                        justify: Justify::End,
294                                        ..default()
295                                    },
296                                    BackgroundColor(DARK_SLATE_GRAY.into()),
297                                    BorderColor::all(SLATE_300),
298                                    TextInput,
299                                    EditableText::new("30"),
300                                    EditableTextFilter::new(|c| c.is_ascii_digit()),
301                                    TextCursorStyle {
302                                        color: Color::WHITE,
303                                        selected_text_color: Some(Color::BLACK),
304                                        unfocused_selection_color: Color::NONE,
305                                        ..default()
306                                    },
307                                    SelectAllOnFocus,
308                                    FontSizeInput,
309                                    TabIndex(2),
310                                )
311                            ],
312                        ))
313                        .observe(
314                            |on: On<FocusedInput<KeyboardInput>>,
315                             font_size_input_query: Query<&EditableText, With<FontSizeInput>>,
316                             mut multiline_input_font: Single<
317                                &mut TextFont,
318                                With<MultilineInput>,
319                            >| {
320                                if !(on.input.state.is_pressed()
321                                    && on.input.logical_key == Key::Enter)
322                                {
323                                    return;
324                                }
325
326                                let Ok(input) =
327                                    font_size_input_query.get(on.original_event_target())
328                                else {
329                                    return;
330                                };
331
332                                let mut output = String::new();
333                                output.reserve(input.value().into_iter().map(str::len).sum());
334                                for sub_str in input.value() {
335                                    output.push_str(sub_str);
336                                }
337
338                                let Ok(font_size) = output.parse::<f32>() else {
339                                    return;
340                                };
341
342                                multiline_input_font.font_size =
343                                    FontSize::Px(font_size.clamp(5., 50.));
344                            },
345                        );
346
347                    parent
348                        .spawn((
349                            Node {
350                                flex_direction: FlexDirection::Row,
351                                column_gap: px(10.),
352                                ..default()
353                            },
354                            children![
355                                (
356                                    Text::new("corner radius:"),
357                                    TextFont {
358                                        font: asset_server.load("fonts/FiraMono-Medium.ttf").into(),
359                                        font_size: FontSize::Px(30.),
360                                        ..default()
361                                    },
362                                ),
363                                (
364                                    Node {
365                                        width: px(100.),
366                                        border: px(2.).all(),
367                                        ..default()
368                                    },
369                                    TextFont {
370                                        font: asset_server.load("fonts/FiraMono-Medium.ttf").into(),
371                                        font_size: FontSize::Px(30.),
372                                        ..default()
373                                    },
374                                    TextLayout {
375                                        justify: Justify::End,
376                                        ..default()
377                                    },
378                                    BackgroundColor(DARK_SLATE_GRAY.into()),
379                                    BorderColor::all(SLATE_300),
380                                    TextInput,
381                                    EditableText::new("0"),
382                                    EditableTextFilter::new(|c| c.is_ascii_digit() || c == '.'),
383                                    TextCursorStyle {
384                                        color: Color::WHITE,
385                                        selected_text_color: Some(Color::BLACK),
386                                        ..default()
387                                    },
388                                    SelectionRadiusInput,
389                                    TabIndex(2),
390                                )
391                            ],
392                        ))
393                        .observe(
394                            |on: On<FocusedInput<KeyboardInput>>,
395                             radius_input_query: Query<
396                                &EditableText,
397                                With<SelectionRadiusInput>,
398                            >,
399                             mut cursor_style: Single<
400                                &mut TextCursorStyle,
401                                With<MultilineInput>,
402                            >| {
403                                if !(on.input.state.is_pressed()
404                                    && on.input.logical_key == Key::Enter)
405                                {
406                                    return;
407                                }
408
409                                let Ok(input) = radius_input_query.get(on.original_event_target())
410                                else {
411                                    return;
412                                };
413
414                                let mut output = String::new();
415                                output.reserve(input.value().into_iter().map(str::len).sum());
416                                for sub_str in input.value() {
417                                    output.push_str(sub_str);
418                                }
419
420                                let Ok(radius) = output.parse::<f32>() else {
421                                    return;
422                                };
423
424                                cursor_style.selection_radius = radius.clamp(0., 0.5);
425                            },
426                        );
427
428                    parent
429                        .spawn(Node::default())
430                        .observe(
431                            |on: On<MenuEvent>,
432                             mut popup: Single<
433                                (&mut Node, &mut MenuFocusState),
434                                With<MenuPopup>,
435                            >,
436                             button: Single<Entity, With<MenuButton>>,
437                             mut focus: ResMut<InputFocus>| {
438                                match on.action {
439                                    MenuAction::Open(direction) => {
440                                        popup.0.display = Display::Flex;
441                                        *popup.1 = MenuFocusState::Opening(direction);
442                                    }
443                                    MenuAction::Toggle => {
444                                        if popup.0.display == Display::None {
445                                            popup.0.display = Display::Flex;
446                                            *popup.1 = MenuFocusState::Opening(
447                                                bevy::input_focus::tab_navigation::NavAction::First,
448                                            );
449                                        } else {
450                                            popup.0.display = Display::None;
451                                        }
452                                    }
453                                    MenuAction::CloseAll => {
454                                        popup.0.display = Display::None;
455                                    }
456                                    MenuAction::FocusRoot => {
457                                        focus.set(*button, FocusCause::Navigated);
458                                    }
459                                }
460                            },
461                        )
462                        .with_children(|parent| {
463                            parent.spawn((
464                                Node {
465                                    border: px(2.).all(),
466                                    padding: px(8.).horizontal(),
467                                    ..default()
468                                },
469                                Button,
470                                MenuButton,
471                                TabIndex(4),
472                                BackgroundColor(DARK_SLATE_GRAY.into()),
473                                BorderColor::all(SLATE_300),
474                                children![(
475                                    Text::new("Justify::Left"),
476                                    TextFont {
477                                        font: asset_server.load("fonts/FiraMono-Medium.ttf").into(),
478                                        font_size: FontSize::Px(24.),
479                                        ..default()
480                                    },
481                                    JustifyLabel,
482                                )],
483                            ));
484
485                            parent
486                                .spawn((
487                                    Node {
488                                        display: Display::None,
489                                        flex_direction: FlexDirection::Column,
490                                        min_width: percent(100.),
491                                        border: px(2.).all(),
492                                        position_type: PositionType::Absolute,
493                                        ..default()
494                                    },
495                                    MenuPopup::default(),
496                                    Popover {
497                                        positions: vec![PopoverPlacement {
498                                            side: PopoverSide::Top,
499                                            align: PopoverAlign::End,
500                                            gap: 2.,
501                                        }],
502                                        ..default()
503                                    },
504                                    GlobalZIndex(1),
505                                    BackgroundColor(DARK_SLATE_GRAY.into()),
506                                    BorderColor::all(SLATE_300),
507                                ))
508                                .with_children(|parent| {
509                                    for (label, justify) in [
510                                        ("Justify::Left", Justify::Left),
511                                        ("Justify::Center", Justify::Center),
512                                        ("Justify::Right", Justify::Right),
513                                        ("Justify::Justified", Justify::Justified),
514                                        ("Justify::Start", Justify::Start),
515                                        ("Justify::End", Justify::End),
516                                    ] {
517                                        parent
518                                            .spawn((
519                                                Node {
520                                                    padding: px(8.).horizontal(),
521                                                    ..default()
522                                                },
523                                                MenuItem,
524                                                TabIndex(0),
525                                                children![(
526                                                    Text::new(label),
527                                                    TextFont {
528                                                        font: asset_server
529                                                            .load("fonts/FiraMono-Medium.ttf",)
530                                                            .into(),
531                                                        font_size: FontSize::Px(24.),
532                                                        ..default()
533                                                    },
534                                                )],
535                                            ))
536                                            .observe(
537                                                move |_: On<Activate>,
538                                                      mut layout: Single<
539                                                    &mut TextLayout,
540                                                    With<MultilineInput>,
541                                                >,
542                                                      mut selected: Single<
543                                                    &mut Text,
544                                                    With<JustifyLabel>,
545                                                >| {
546                                                    layout.justify = justify;
547                                                    selected.0 = label.into();
548                                                },
549                                            );
550                                    }
551                                });
552                        });
553                });
554        });
555}
Source

pub fn p1<'a>(&'a mut self) -> <P1 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 1 in this ParamSet. No other parameters may be accessed while this one is active.

Examples found in repository?
examples/showcase/alien_cake_addict.rs (line 276)
268fn focus_camera(
269    time: Res<Time>,
270    mut game: ResMut<Game>,
271    mut transforms: ParamSet<(Query<&mut Transform, With<Camera3d>>, Query<&Transform>)>,
272) {
273    const SPEED: f32 = 2.0;
274    // if there is both a player and a bonus, target the mid-point of them
275    if let (Some(player_entity), Some(bonus_entity)) = (game.player.entity, game.bonus.entity) {
276        let transform_query = transforms.p1();
277        if let (Ok(player_transform), Ok(bonus_transform)) = (
278            transform_query.get(player_entity),
279            transform_query.get(bonus_entity),
280        ) {
281            game.camera_should_focus = player_transform
282                .translation
283                .lerp(bonus_transform.translation, 0.5);
284        }
285        // otherwise, if there is only a player, target the player
286    } else if let Some(player_entity) = game.player.entity {
287        if let Ok(player_transform) = transforms.p1().get(player_entity) {
288            game.camera_should_focus = player_transform.translation;
289        }
290        // otherwise, target the middle
291    } else {
292        game.camera_should_focus = Vec3::from(RESET_FOCUS);
293    }
294    // calculate the camera motion based on the difference between where the camera is looking
295    // and where it should be looking; the greater the distance, the faster the motion;
296    // smooth out the camera movement using the frame time
297    let mut camera_motion = game.camera_should_focus - game.camera_is_focus;
298    if camera_motion.length() > 0.2 {
299        camera_motion *= SPEED * time.delta_secs();
300        // set the new camera's actual focus
301        game.camera_is_focus += camera_motion;
302    }
303    // look at that new camera's actual focus
304    for mut transform in transforms.p0().iter_mut() {
305        *transform = transform.looking_at(game.camera_is_focus, Vec3::Y);
306    }
307}
More examples
Hide additional examples
examples/ui/text/multiline_text_input.rs (line 256)
55fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
56    commands.spawn(Camera2d);
57
58    commands
59        .spawn(Node {
60            width: percent(100.),
61            height: percent(100.),
62            justify_content: JustifyContent::Center,
63            align_items: AlignItems::Center,
64            ..default()
65        })
66        .with_children(|parent| {
67            parent
68                .spawn((
69                    Node {
70                        flex_direction: FlexDirection::Column,
71                        align_items: AlignItems::End,
72                        row_gap: px(10.),
73                        ..default()
74                    },
75                    TabGroup::default(),
76                ))
77                .with_children(|parent| {
78                    parent
79                        .spawn(Node {
80                            display: Display::Grid,
81                            grid_template_columns: vec![
82                                RepeatedGridTrack::auto(1),
83                                RepeatedGridTrack::auto(1),
84                            ],
85                            column_gap: px(4.),
86                            ..default()
87                        })
88                        .with_children(|parent| {
89                            parent
90                                .spawn((
91                                    Node {
92                                        width: px(450.),
93                                        border: px(2.).all(),
94                                        padding: px(8.).all(),
95                                        ..default()
96                                    },
97                                    TextInput,
98                                    EditableText {
99                                        visible_lines: Some(8.),
100                                        allow_newlines: true,
101                                        ..default()
102                                    },
103                                    TextLayout {
104                                        linebreak: LineBreak::WordOrCharacter,
105                                        ..default()
106                                    },
107                                    TextCursorStyle {
108                                        color: Color::WHITE,
109                                        selected_text_color: Some(Color::BLACK),
110                                        ..default()
111                                    },
112                                    TextFont {
113                                        font: asset_server.load("fonts/FiraMono-Medium.ttf").into(),
114                                        font_size: FontSize::Px(30.),
115                                        ..default()
116                                    },
117                                    BackgroundColor(DARK_SLATE_GRAY.into()),
118                                    BorderColor::all(SLATE_300),
119                                    MultilineInput,
120                                    TabIndex(0),
121                                    AutoFocus,
122                                ))
123                                .observe(
124                                    |on: On<FocusedInput<KeyboardInput>>,
125                                     keys: Res<ButtonInput<Key>>,
126                                     input_query: Query<&EditableText, With<MultilineInput>>| {
127                                        if !(on.input.state.is_pressed()
128                                            && on.input.logical_key == Key::Enter
129                                            && keys.pressed(Key::Control))
130                                        {
131                                            return;
132                                        }
133                                        let Ok(input) = input_query.get(on.focused_entity) else {
134                                            return;
135                                        };
136
137                                        let mut output = String::new();
138                                        output
139                                            .reserve(input.value().into_iter().map(str::len).sum());
140                                        for sub_str in input.value() {
141                                            output.push_str(sub_str);
142                                        }
143
144                                        info!("{output}");
145                                    },
146                                );
147
148                            // Vertical scrollbar for the multiline input above. Not part of the
149                            // input's tab group and has no `TabIndex`, so it's unreachable via
150                            // Tab navigation and can't take input focus.
151                            parent
152                                .spawn((
153                                    Node {
154                                        min_width: px(10.),
155                                        ..default()
156                                    },
157                                    BackgroundColor(DARK_SLATE_GRAY.into()),
158                                ))
159                                .with_children(|parent| {
160                                    parent
161                                        .spawn((
162                                            Node {
163                                                position_type: PositionType::Absolute,
164                                                width: percent(100.),
165                                                left: px(0.),
166                                                border_radius: BorderRadius::all(px(4.)),
167                                                ..default()
168                                            },
169                                            BackgroundColor(SLATE_300.into()),
170                                            Visibility::Hidden,
171                                            InputScrollThumb,
172                                            InputScrollDragState::default(),
173                                        ))
174                                        .observe(on_thumb_drag_start)
175                                        .observe(on_thumb_drag)
176                                        .observe(on_thumb_drag_end);
177                                });
178                        });
179
180                    parent
181                        .spawn((
182                            Node {
183                                flex_direction: FlexDirection::Row,
184                                column_gap: px(10.),
185                                ..default()
186                            },
187                            children![
188                                (
189                                    Text::new("visible lines:"),
190                                    TextFont {
191                                        font: asset_server.load("fonts/FiraMono-Medium.ttf").into(),
192                                        font_size: FontSize::Px(30.),
193                                        ..default()
194                                    },
195                                ),
196                                (
197                                    Node {
198                                        width: px(100.),
199                                        border: px(2.).all(),
200                                        ..default()
201                                    },
202                                    TextFont {
203                                        font: asset_server.load("fonts/FiraMono-Medium.ttf").into(),
204                                        font_size: FontSize::Px(30.),
205                                        ..default()
206                                    },
207                                    TextLayout {
208                                        justify: Justify::End,
209                                        ..default()
210                                    },
211                                    BackgroundColor(DARK_SLATE_GRAY.into()),
212                                    BorderColor::all(SLATE_300),
213                                    TextInput,
214                                    EditableText::new("8"),
215                                    EditableTextFilter::new(|c| c.is_ascii_digit() || c == '.'),
216                                    TextCursorStyle {
217                                        color: Color::WHITE,
218                                        selected_text_color: Some(Color::BLACK),
219                                        unfocused_selection_color: Color::NONE,
220                                        ..default()
221                                    },
222                                    SelectAllOnFocus,
223                                    VisibleLinesInput,
224                                    TabIndex(1),
225                                )
226                            ],
227                        ))
228                        .observe(
229                            |on: On<FocusedInput<KeyboardInput>>,
230                             mut query_set: ParamSet<(
231                                Query<&EditableText, With<VisibleLinesInput>>,
232                                Query<&mut EditableText, With<MultilineInput>>,
233                            )>| {
234                                if !(on.input.state.is_pressed()
235                                    && on.input.logical_key == Key::Enter)
236                                {
237                                    return;
238                                }
239
240                                let visible_lines_query = query_set.p0();
241                                let Ok(input) = visible_lines_query.get(on.original_event_target())
242                                else {
243                                    return;
244                                };
245
246                                let mut output = String::new();
247                                output.reserve(input.value().into_iter().map(str::len).sum());
248                                for sub_str in input.value() {
249                                    output.push_str(sub_str);
250                                }
251
252                                let Ok(lines) = output.parse::<f32>() else {
253                                    return;
254                                };
255
256                                let mut multiline_query = query_set.p1();
257                                let Ok(mut multiline_input) = multiline_query.single_mut() else {
258                                    return;
259                                };
260
261                                multiline_input.visible_lines = Some(lines.clamp(1., 10.));
262                            },
263                        );
264
265                    parent
266                        .spawn((
267                            Node {
268                                flex_direction: FlexDirection::Row,
269                                column_gap: px(10.),
270                                ..default()
271                            },
272                            children![
273                                (
274                                    Text::new("font size:"),
275                                    TextFont {
276                                        font: asset_server.load("fonts/FiraMono-Medium.ttf").into(),
277                                        font_size: FontSize::Px(30.),
278                                        ..default()
279                                    },
280                                ),
281                                (
282                                    Node {
283                                        width: px(100.),
284                                        border: px(2.).all(),
285                                        ..default()
286                                    },
287                                    TextFont {
288                                        font: asset_server.load("fonts/FiraMono-Medium.ttf").into(),
289                                        font_size: FontSize::Px(30.),
290                                        ..default()
291                                    },
292                                    TextLayout {
293                                        justify: Justify::End,
294                                        ..default()
295                                    },
296                                    BackgroundColor(DARK_SLATE_GRAY.into()),
297                                    BorderColor::all(SLATE_300),
298                                    TextInput,
299                                    EditableText::new("30"),
300                                    EditableTextFilter::new(|c| c.is_ascii_digit()),
301                                    TextCursorStyle {
302                                        color: Color::WHITE,
303                                        selected_text_color: Some(Color::BLACK),
304                                        unfocused_selection_color: Color::NONE,
305                                        ..default()
306                                    },
307                                    SelectAllOnFocus,
308                                    FontSizeInput,
309                                    TabIndex(2),
310                                )
311                            ],
312                        ))
313                        .observe(
314                            |on: On<FocusedInput<KeyboardInput>>,
315                             font_size_input_query: Query<&EditableText, With<FontSizeInput>>,
316                             mut multiline_input_font: Single<
317                                &mut TextFont,
318                                With<MultilineInput>,
319                            >| {
320                                if !(on.input.state.is_pressed()
321                                    && on.input.logical_key == Key::Enter)
322                                {
323                                    return;
324                                }
325
326                                let Ok(input) =
327                                    font_size_input_query.get(on.original_event_target())
328                                else {
329                                    return;
330                                };
331
332                                let mut output = String::new();
333                                output.reserve(input.value().into_iter().map(str::len).sum());
334                                for sub_str in input.value() {
335                                    output.push_str(sub_str);
336                                }
337
338                                let Ok(font_size) = output.parse::<f32>() else {
339                                    return;
340                                };
341
342                                multiline_input_font.font_size =
343                                    FontSize::Px(font_size.clamp(5., 50.));
344                            },
345                        );
346
347                    parent
348                        .spawn((
349                            Node {
350                                flex_direction: FlexDirection::Row,
351                                column_gap: px(10.),
352                                ..default()
353                            },
354                            children![
355                                (
356                                    Text::new("corner radius:"),
357                                    TextFont {
358                                        font: asset_server.load("fonts/FiraMono-Medium.ttf").into(),
359                                        font_size: FontSize::Px(30.),
360                                        ..default()
361                                    },
362                                ),
363                                (
364                                    Node {
365                                        width: px(100.),
366                                        border: px(2.).all(),
367                                        ..default()
368                                    },
369                                    TextFont {
370                                        font: asset_server.load("fonts/FiraMono-Medium.ttf").into(),
371                                        font_size: FontSize::Px(30.),
372                                        ..default()
373                                    },
374                                    TextLayout {
375                                        justify: Justify::End,
376                                        ..default()
377                                    },
378                                    BackgroundColor(DARK_SLATE_GRAY.into()),
379                                    BorderColor::all(SLATE_300),
380                                    TextInput,
381                                    EditableText::new("0"),
382                                    EditableTextFilter::new(|c| c.is_ascii_digit() || c == '.'),
383                                    TextCursorStyle {
384                                        color: Color::WHITE,
385                                        selected_text_color: Some(Color::BLACK),
386                                        ..default()
387                                    },
388                                    SelectionRadiusInput,
389                                    TabIndex(2),
390                                )
391                            ],
392                        ))
393                        .observe(
394                            |on: On<FocusedInput<KeyboardInput>>,
395                             radius_input_query: Query<
396                                &EditableText,
397                                With<SelectionRadiusInput>,
398                            >,
399                             mut cursor_style: Single<
400                                &mut TextCursorStyle,
401                                With<MultilineInput>,
402                            >| {
403                                if !(on.input.state.is_pressed()
404                                    && on.input.logical_key == Key::Enter)
405                                {
406                                    return;
407                                }
408
409                                let Ok(input) = radius_input_query.get(on.original_event_target())
410                                else {
411                                    return;
412                                };
413
414                                let mut output = String::new();
415                                output.reserve(input.value().into_iter().map(str::len).sum());
416                                for sub_str in input.value() {
417                                    output.push_str(sub_str);
418                                }
419
420                                let Ok(radius) = output.parse::<f32>() else {
421                                    return;
422                                };
423
424                                cursor_style.selection_radius = radius.clamp(0., 0.5);
425                            },
426                        );
427
428                    parent
429                        .spawn(Node::default())
430                        .observe(
431                            |on: On<MenuEvent>,
432                             mut popup: Single<
433                                (&mut Node, &mut MenuFocusState),
434                                With<MenuPopup>,
435                            >,
436                             button: Single<Entity, With<MenuButton>>,
437                             mut focus: ResMut<InputFocus>| {
438                                match on.action {
439                                    MenuAction::Open(direction) => {
440                                        popup.0.display = Display::Flex;
441                                        *popup.1 = MenuFocusState::Opening(direction);
442                                    }
443                                    MenuAction::Toggle => {
444                                        if popup.0.display == Display::None {
445                                            popup.0.display = Display::Flex;
446                                            *popup.1 = MenuFocusState::Opening(
447                                                bevy::input_focus::tab_navigation::NavAction::First,
448                                            );
449                                        } else {
450                                            popup.0.display = Display::None;
451                                        }
452                                    }
453                                    MenuAction::CloseAll => {
454                                        popup.0.display = Display::None;
455                                    }
456                                    MenuAction::FocusRoot => {
457                                        focus.set(*button, FocusCause::Navigated);
458                                    }
459                                }
460                            },
461                        )
462                        .with_children(|parent| {
463                            parent.spawn((
464                                Node {
465                                    border: px(2.).all(),
466                                    padding: px(8.).horizontal(),
467                                    ..default()
468                                },
469                                Button,
470                                MenuButton,
471                                TabIndex(4),
472                                BackgroundColor(DARK_SLATE_GRAY.into()),
473                                BorderColor::all(SLATE_300),
474                                children![(
475                                    Text::new("Justify::Left"),
476                                    TextFont {
477                                        font: asset_server.load("fonts/FiraMono-Medium.ttf").into(),
478                                        font_size: FontSize::Px(24.),
479                                        ..default()
480                                    },
481                                    JustifyLabel,
482                                )],
483                            ));
484
485                            parent
486                                .spawn((
487                                    Node {
488                                        display: Display::None,
489                                        flex_direction: FlexDirection::Column,
490                                        min_width: percent(100.),
491                                        border: px(2.).all(),
492                                        position_type: PositionType::Absolute,
493                                        ..default()
494                                    },
495                                    MenuPopup::default(),
496                                    Popover {
497                                        positions: vec![PopoverPlacement {
498                                            side: PopoverSide::Top,
499                                            align: PopoverAlign::End,
500                                            gap: 2.,
501                                        }],
502                                        ..default()
503                                    },
504                                    GlobalZIndex(1),
505                                    BackgroundColor(DARK_SLATE_GRAY.into()),
506                                    BorderColor::all(SLATE_300),
507                                ))
508                                .with_children(|parent| {
509                                    for (label, justify) in [
510                                        ("Justify::Left", Justify::Left),
511                                        ("Justify::Center", Justify::Center),
512                                        ("Justify::Right", Justify::Right),
513                                        ("Justify::Justified", Justify::Justified),
514                                        ("Justify::Start", Justify::Start),
515                                        ("Justify::End", Justify::End),
516                                    ] {
517                                        parent
518                                            .spawn((
519                                                Node {
520                                                    padding: px(8.).horizontal(),
521                                                    ..default()
522                                                },
523                                                MenuItem,
524                                                TabIndex(0),
525                                                children![(
526                                                    Text::new(label),
527                                                    TextFont {
528                                                        font: asset_server
529                                                            .load("fonts/FiraMono-Medium.ttf",)
530                                                            .into(),
531                                                        font_size: FontSize::Px(24.),
532                                                        ..default()
533                                                    },
534                                                )],
535                                            ))
536                                            .observe(
537                                                move |_: On<Activate>,
538                                                      mut layout: Single<
539                                                    &mut TextLayout,
540                                                    With<MultilineInput>,
541                                                >,
542                                                      mut selected: Single<
543                                                    &mut Text,
544                                                    With<JustifyLabel>,
545                                                >| {
546                                                    layout.justify = justify;
547                                                    selected.0 = label.into();
548                                                },
549                                            );
550                                    }
551                                });
552                        });
553                });
554        });
555}
Source§

impl<'w, 's, P0, P1, P2> ParamSet<'w, 's, (P0, P1, P2)>
where P0: SystemParam, P1: SystemParam, P2: SystemParam,

Source

pub fn p0<'a>(&'a mut self) -> <P0 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 0 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p1<'a>(&'a mut self) -> <P1 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 1 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p2<'a>(&'a mut self) -> <P2 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 2 in this ParamSet. No other parameters may be accessed while this one is active.

Source§

impl<'w, 's, P0, P1, P2, P3> ParamSet<'w, 's, (P0, P1, P2, P3)>

Source

pub fn p0<'a>(&'a mut self) -> <P0 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 0 in this ParamSet. No other parameters may be accessed while this one is active.

Examples found in repository?
examples/3d/shadow_caster_receiver.rs (line 144)
132fn toggle_shadows(
133    mut commands: Commands,
134    input: Res<ButtonInput<KeyCode>>,
135    mut queries: ParamSet<(
136        Query<Entity, (With<Mesh3d>, With<NotShadowCaster>)>,
137        Query<Entity, (With<Mesh3d>, With<NotShadowReceiver>)>,
138        Query<Entity, (With<Mesh3d>, Without<NotShadowCaster>)>,
139        Query<Entity, (With<Mesh3d>, Without<NotShadowReceiver>)>,
140    )>,
141) {
142    if input.just_pressed(KeyCode::KeyC) {
143        println!("Toggling casters");
144        for entity in queries.p0().iter() {
145            commands.entity(entity).remove::<NotShadowCaster>();
146        }
147        for entity in queries.p2().iter() {
148            commands.entity(entity).insert(NotShadowCaster);
149        }
150    }
151    if input.just_pressed(KeyCode::KeyR) {
152        println!("Toggling receivers");
153        for entity in queries.p1().iter() {
154            commands.entity(entity).remove::<NotShadowReceiver>();
155        }
156        for entity in queries.p3().iter() {
157            commands.entity(entity).insert(NotShadowReceiver);
158        }
159    }
160}
Source

pub fn p1<'a>(&'a mut self) -> <P1 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 1 in this ParamSet. No other parameters may be accessed while this one is active.

Examples found in repository?
examples/3d/shadow_caster_receiver.rs (line 153)
132fn toggle_shadows(
133    mut commands: Commands,
134    input: Res<ButtonInput<KeyCode>>,
135    mut queries: ParamSet<(
136        Query<Entity, (With<Mesh3d>, With<NotShadowCaster>)>,
137        Query<Entity, (With<Mesh3d>, With<NotShadowReceiver>)>,
138        Query<Entity, (With<Mesh3d>, Without<NotShadowCaster>)>,
139        Query<Entity, (With<Mesh3d>, Without<NotShadowReceiver>)>,
140    )>,
141) {
142    if input.just_pressed(KeyCode::KeyC) {
143        println!("Toggling casters");
144        for entity in queries.p0().iter() {
145            commands.entity(entity).remove::<NotShadowCaster>();
146        }
147        for entity in queries.p2().iter() {
148            commands.entity(entity).insert(NotShadowCaster);
149        }
150    }
151    if input.just_pressed(KeyCode::KeyR) {
152        println!("Toggling receivers");
153        for entity in queries.p1().iter() {
154            commands.entity(entity).remove::<NotShadowReceiver>();
155        }
156        for entity in queries.p3().iter() {
157            commands.entity(entity).insert(NotShadowReceiver);
158        }
159    }
160}
Source

pub fn p2<'a>(&'a mut self) -> <P2 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 2 in this ParamSet. No other parameters may be accessed while this one is active.

Examples found in repository?
examples/3d/shadow_caster_receiver.rs (line 147)
132fn toggle_shadows(
133    mut commands: Commands,
134    input: Res<ButtonInput<KeyCode>>,
135    mut queries: ParamSet<(
136        Query<Entity, (With<Mesh3d>, With<NotShadowCaster>)>,
137        Query<Entity, (With<Mesh3d>, With<NotShadowReceiver>)>,
138        Query<Entity, (With<Mesh3d>, Without<NotShadowCaster>)>,
139        Query<Entity, (With<Mesh3d>, Without<NotShadowReceiver>)>,
140    )>,
141) {
142    if input.just_pressed(KeyCode::KeyC) {
143        println!("Toggling casters");
144        for entity in queries.p0().iter() {
145            commands.entity(entity).remove::<NotShadowCaster>();
146        }
147        for entity in queries.p2().iter() {
148            commands.entity(entity).insert(NotShadowCaster);
149        }
150    }
151    if input.just_pressed(KeyCode::KeyR) {
152        println!("Toggling receivers");
153        for entity in queries.p1().iter() {
154            commands.entity(entity).remove::<NotShadowReceiver>();
155        }
156        for entity in queries.p3().iter() {
157            commands.entity(entity).insert(NotShadowReceiver);
158        }
159    }
160}
Source

pub fn p3<'a>(&'a mut self) -> <P3 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 3 in this ParamSet. No other parameters may be accessed while this one is active.

Examples found in repository?
examples/3d/shadow_caster_receiver.rs (line 156)
132fn toggle_shadows(
133    mut commands: Commands,
134    input: Res<ButtonInput<KeyCode>>,
135    mut queries: ParamSet<(
136        Query<Entity, (With<Mesh3d>, With<NotShadowCaster>)>,
137        Query<Entity, (With<Mesh3d>, With<NotShadowReceiver>)>,
138        Query<Entity, (With<Mesh3d>, Without<NotShadowCaster>)>,
139        Query<Entity, (With<Mesh3d>, Without<NotShadowReceiver>)>,
140    )>,
141) {
142    if input.just_pressed(KeyCode::KeyC) {
143        println!("Toggling casters");
144        for entity in queries.p0().iter() {
145            commands.entity(entity).remove::<NotShadowCaster>();
146        }
147        for entity in queries.p2().iter() {
148            commands.entity(entity).insert(NotShadowCaster);
149        }
150    }
151    if input.just_pressed(KeyCode::KeyR) {
152        println!("Toggling receivers");
153        for entity in queries.p1().iter() {
154            commands.entity(entity).remove::<NotShadowReceiver>();
155        }
156        for entity in queries.p3().iter() {
157            commands.entity(entity).insert(NotShadowReceiver);
158        }
159    }
160}
Source§

impl<'w, 's, P0, P1, P2, P3, P4> ParamSet<'w, 's, (P0, P1, P2, P3, P4)>

Source

pub fn p0<'a>(&'a mut self) -> <P0 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 0 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p1<'a>(&'a mut self) -> <P1 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 1 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p2<'a>(&'a mut self) -> <P2 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 2 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p3<'a>(&'a mut self) -> <P3 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 3 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p4<'a>(&'a mut self) -> <P4 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 4 in this ParamSet. No other parameters may be accessed while this one is active.

Source§

impl<'w, 's, P0, P1, P2, P3, P4, P5> ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5)>

Source

pub fn p0<'a>(&'a mut self) -> <P0 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 0 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p1<'a>(&'a mut self) -> <P1 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 1 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p2<'a>(&'a mut self) -> <P2 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 2 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p3<'a>(&'a mut self) -> <P3 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 3 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p4<'a>(&'a mut self) -> <P4 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 4 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p5<'a>(&'a mut self) -> <P5 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 5 in this ParamSet. No other parameters may be accessed while this one is active.

Source§

impl<'w, 's, P0, P1, P2, P3, P4, P5, P6> ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6)>

Source

pub fn p0<'a>(&'a mut self) -> <P0 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 0 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p1<'a>(&'a mut self) -> <P1 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 1 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p2<'a>(&'a mut self) -> <P2 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 2 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p3<'a>(&'a mut self) -> <P3 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 3 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p4<'a>(&'a mut self) -> <P4 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 4 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p5<'a>(&'a mut self) -> <P5 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 5 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p6<'a>(&'a mut self) -> <P6 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 6 in this ParamSet. No other parameters may be accessed while this one is active.

Source§

impl<'w, 's, P0, P1, P2, P3, P4, P5, P6, P7> ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6, P7)>

Source

pub fn p0<'a>(&'a mut self) -> <P0 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 0 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p1<'a>(&'a mut self) -> <P1 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 1 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p2<'a>(&'a mut self) -> <P2 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 2 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p3<'a>(&'a mut self) -> <P3 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 3 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p4<'a>(&'a mut self) -> <P4 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 4 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p5<'a>(&'a mut self) -> <P5 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 5 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p6<'a>(&'a mut self) -> <P6 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 6 in this ParamSet. No other parameters may be accessed while this one is active.

Source

pub fn p7<'a>(&'a mut self) -> <P7 as SystemParam>::Item<'a, 'a>

Gets exclusive access to the parameter at index 7 in this ParamSet. No other parameters may be accessed while this one is active.

Source§

impl<T> ParamSet<'_, '_, Vec<T>>
where T: SystemParam,

Source

pub fn get_mut(&mut self, index: usize) -> <T as SystemParam>::Item<'_, '_>

Accesses the parameter at the given index. No other parameters may be accessed while this one is active.

Source

pub fn for_each(&mut self, f: impl FnMut(<T as SystemParam>::Item<'_, '_>))

Calls a closure for each parameter in the set.

Trait Implementations§

Source§

impl<'w, 's, P0> ReadOnlySystemParam for ParamSet<'w, 's, (P0,)>

Source§

impl<'w, 's, P0, P1> ReadOnlySystemParam for ParamSet<'w, 's, (P0, P1)>

Source§

impl<'w, 's, P0, P1, P2> ReadOnlySystemParam for ParamSet<'w, 's, (P0, P1, P2)>

Source§

impl<'w, 's, P0, P1, P2, P3> ReadOnlySystemParam for ParamSet<'w, 's, (P0, P1, P2, P3)>

Source§

impl<'w, 's, P0, P1, P2, P3, P4> ReadOnlySystemParam for ParamSet<'w, 's, (P0, P1, P2, P3, P4)>

Source§

impl<'w, 's, P0, P1, P2, P3, P4, P5> ReadOnlySystemParam for ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5)>

Source§

impl<'w, 's, P0, P1, P2, P3, P4, P5, P6> ReadOnlySystemParam for ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6)>

Source§

impl<'w, 's, P0, P1, P2, P3, P4, P5, P6, P7> ReadOnlySystemParam for ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6, P7)>

Source§

impl<'_w, '_s, P0> SystemParam for ParamSet<'_w, '_s, (P0,)>
where P0: SystemParam,

Source§

type State = (<P0 as SystemParam>::State,)

Used to store data which persists across invocations of a system.
Source§

type Item<'w, 's> = ParamSet<'w, 's, (P0,)>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes. Read more
Source§

fn init_state( world: &mut World, ) -> <ParamSet<'_w, '_s, (P0,)> as SystemParam>::State

Creates a new instance of this param’s State.
Source§

fn init_access( state: &<ParamSet<'_w, '_s, (P0,)> as SystemParam>::State, system_meta: &mut SystemMeta, system_access: &mut SystemAccess, world: &mut World, )

Registers any World access used by this SystemParam. Read more
Source§

fn apply( state: &mut <ParamSet<'_w, '_s, (P0,)> as SystemParam>::State, system_meta: &SystemMeta, world: &mut World, )

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during ApplyDeferred.
Source§

fn queue( state: &mut <ParamSet<'_w, '_s, (P0,)> as SystemParam>::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.
Source§

unsafe fn get_param<'w, 's>( state: &'s mut <ParamSet<'_w, '_s, (P0,)> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Result<<ParamSet<'_w, '_s, (P0,)> as SystemParam>::Item<'w, 's>, SystemParamValidationError>

Creates a parameter to be passed into a SystemParamFunction. Read more
Source§

impl<'_w, '_s, P0, P1> SystemParam for ParamSet<'_w, '_s, (P0, P1)>
where P0: SystemParam, P1: SystemParam,

Source§

type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State)

Used to store data which persists across invocations of a system.
Source§

type Item<'w, 's> = ParamSet<'w, 's, (P0, P1)>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes. Read more
Source§

fn init_state( world: &mut World, ) -> <ParamSet<'_w, '_s, (P0, P1)> as SystemParam>::State

Creates a new instance of this param’s State.
Source§

fn init_access( state: &<ParamSet<'_w, '_s, (P0, P1)> as SystemParam>::State, system_meta: &mut SystemMeta, system_access: &mut SystemAccess, world: &mut World, )

Registers any World access used by this SystemParam. Read more
Source§

fn apply( state: &mut <ParamSet<'_w, '_s, (P0, P1)> as SystemParam>::State, system_meta: &SystemMeta, world: &mut World, )

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during ApplyDeferred.
Source§

fn queue( state: &mut <ParamSet<'_w, '_s, (P0, P1)> as SystemParam>::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.
Source§

unsafe fn get_param<'w, 's>( state: &'s mut <ParamSet<'_w, '_s, (P0, P1)> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Result<<ParamSet<'_w, '_s, (P0, P1)> as SystemParam>::Item<'w, 's>, SystemParamValidationError>

Creates a parameter to be passed into a SystemParamFunction. Read more
Source§

impl<'_w, '_s, P0, P1, P2> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2)>
where P0: SystemParam, P1: SystemParam, P2: SystemParam,

Source§

type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State)

Used to store data which persists across invocations of a system.
Source§

type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2)>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes. Read more
Source§

fn init_state( world: &mut World, ) -> <ParamSet<'_w, '_s, (P0, P1, P2)> as SystemParam>::State

Creates a new instance of this param’s State.
Source§

fn init_access( state: &<ParamSet<'_w, '_s, (P0, P1, P2)> as SystemParam>::State, system_meta: &mut SystemMeta, system_access: &mut SystemAccess, world: &mut World, )

Registers any World access used by this SystemParam. Read more
Source§

fn apply( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2)> as SystemParam>::State, system_meta: &SystemMeta, world: &mut World, )

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during ApplyDeferred.
Source§

fn queue( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2)> as SystemParam>::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.
Source§

unsafe fn get_param<'w, 's>( state: &'s mut <ParamSet<'_w, '_s, (P0, P1, P2)> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Result<<ParamSet<'_w, '_s, (P0, P1, P2)> as SystemParam>::Item<'w, 's>, SystemParamValidationError>

Creates a parameter to be passed into a SystemParamFunction. Read more
Source§

impl<'_w, '_s, P0, P1, P2, P3> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3)>

Source§

type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State, <P3 as SystemParam>::State)

Used to store data which persists across invocations of a system.
Source§

type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2, P3)>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes. Read more
Source§

fn init_state( world: &mut World, ) -> <ParamSet<'_w, '_s, (P0, P1, P2, P3)> as SystemParam>::State

Creates a new instance of this param’s State.
Source§

fn init_access( state: &<ParamSet<'_w, '_s, (P0, P1, P2, P3)> as SystemParam>::State, system_meta: &mut SystemMeta, system_access: &mut SystemAccess, world: &mut World, )

Registers any World access used by this SystemParam. Read more
Source§

fn apply( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3)> as SystemParam>::State, system_meta: &SystemMeta, world: &mut World, )

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during ApplyDeferred.
Source§

fn queue( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3)> as SystemParam>::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.
Source§

unsafe fn get_param<'w, 's>( state: &'s mut <ParamSet<'_w, '_s, (P0, P1, P2, P3)> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Result<<ParamSet<'_w, '_s, (P0, P1, P2, P3)> as SystemParam>::Item<'w, 's>, SystemParamValidationError>

Creates a parameter to be passed into a SystemParamFunction. Read more
Source§

impl<'_w, '_s, P0, P1, P2, P3, P4> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3, P4)>

Source§

type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State, <P3 as SystemParam>::State, <P4 as SystemParam>::State)

Used to store data which persists across invocations of a system.
Source§

type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2, P3, P4)>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes. Read more
Source§

fn init_state( world: &mut World, ) -> <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4)> as SystemParam>::State

Creates a new instance of this param’s State.
Source§

fn init_access( state: &<ParamSet<'_w, '_s, (P0, P1, P2, P3, P4)> as SystemParam>::State, system_meta: &mut SystemMeta, system_access: &mut SystemAccess, world: &mut World, )

Registers any World access used by this SystemParam. Read more
Source§

fn apply( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4)> as SystemParam>::State, system_meta: &SystemMeta, world: &mut World, )

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during ApplyDeferred.
Source§

fn queue( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4)> as SystemParam>::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.
Source§

unsafe fn get_param<'w, 's>( state: &'s mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4)> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Result<<ParamSet<'_w, '_s, (P0, P1, P2, P3, P4)> as SystemParam>::Item<'w, 's>, SystemParamValidationError>

Creates a parameter to be passed into a SystemParamFunction. Read more
Source§

impl<'_w, '_s, P0, P1, P2, P3, P4, P5> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5)>

Source§

type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State, <P3 as SystemParam>::State, <P4 as SystemParam>::State, <P5 as SystemParam>::State)

Used to store data which persists across invocations of a system.
Source§

type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5)>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes. Read more
Source§

fn init_state( world: &mut World, ) -> <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5)> as SystemParam>::State

Creates a new instance of this param’s State.
Source§

fn init_access( state: &<ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5)> as SystemParam>::State, system_meta: &mut SystemMeta, system_access: &mut SystemAccess, world: &mut World, )

Registers any World access used by this SystemParam. Read more
Source§

fn apply( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5)> as SystemParam>::State, system_meta: &SystemMeta, world: &mut World, )

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during ApplyDeferred.
Source§

fn queue( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5)> as SystemParam>::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.
Source§

unsafe fn get_param<'w, 's>( state: &'s mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5)> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Result<<ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5)> as SystemParam>::Item<'w, 's>, SystemParamValidationError>

Creates a parameter to be passed into a SystemParamFunction. Read more
Source§

impl<'_w, '_s, P0, P1, P2, P3, P4, P5, P6> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6)>

Source§

type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State, <P3 as SystemParam>::State, <P4 as SystemParam>::State, <P5 as SystemParam>::State, <P6 as SystemParam>::State)

Used to store data which persists across invocations of a system.
Source§

type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6)>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes. Read more
Source§

fn init_state( world: &mut World, ) -> <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6)> as SystemParam>::State

Creates a new instance of this param’s State.
Source§

fn init_access( state: &<ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6)> as SystemParam>::State, system_meta: &mut SystemMeta, system_access: &mut SystemAccess, world: &mut World, )

Registers any World access used by this SystemParam. Read more
Source§

fn apply( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6)> as SystemParam>::State, system_meta: &SystemMeta, world: &mut World, )

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during ApplyDeferred.
Source§

fn queue( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6)> as SystemParam>::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.
Source§

unsafe fn get_param<'w, 's>( state: &'s mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6)> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Result<<ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6)> as SystemParam>::Item<'w, 's>, SystemParamValidationError>

Creates a parameter to be passed into a SystemParamFunction. Read more
Source§

impl<'_w, '_s, P0, P1, P2, P3, P4, P5, P6, P7> SystemParam for ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6, P7)>

Source§

type State = (<P0 as SystemParam>::State, <P1 as SystemParam>::State, <P2 as SystemParam>::State, <P3 as SystemParam>::State, <P4 as SystemParam>::State, <P5 as SystemParam>::State, <P6 as SystemParam>::State, <P7 as SystemParam>::State)

Used to store data which persists across invocations of a system.
Source§

type Item<'w, 's> = ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6, P7)>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes. Read more
Source§

fn init_state( world: &mut World, ) -> <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6, P7)> as SystemParam>::State

Creates a new instance of this param’s State.
Source§

fn init_access( state: &<ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6, P7)> as SystemParam>::State, system_meta: &mut SystemMeta, system_access: &mut SystemAccess, world: &mut World, )

Registers any World access used by this SystemParam. Read more
Source§

fn apply( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6, P7)> as SystemParam>::State, system_meta: &SystemMeta, world: &mut World, )

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during ApplyDeferred.
Source§

fn queue( state: &mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6, P7)> as SystemParam>::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.
Source§

unsafe fn get_param<'w, 's>( state: &'s mut <ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6, P7)> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Result<<ParamSet<'_w, '_s, (P0, P1, P2, P3, P4, P5, P6, P7)> as SystemParam>::Item<'w, 's>, SystemParamValidationError>

Creates a parameter to be passed into a SystemParamFunction. Read more
Source§

impl<T> SystemParam for ParamSet<'_, '_, Vec<T>>
where T: SystemParam,

Source§

type State = Vec<<T as SystemParam>::State>

Used to store data which persists across invocations of a system.
Source§

type Item<'world, 'state> = ParamSet<'world, 'state, Vec<T>>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes. Read more
Source§

fn init_state( _world: &mut World, ) -> <ParamSet<'_, '_, Vec<T>> as SystemParam>::State

Creates a new instance of this param’s State.
Source§

fn init_access( state: &<ParamSet<'_, '_, Vec<T>> as SystemParam>::State, system_meta: &mut SystemMeta, system_access: &mut SystemAccess, world: &mut World, )

Registers any World access used by this SystemParam. Read more
Source§

unsafe fn get_param<'world, 'state>( state: &'state mut <ParamSet<'_, '_, Vec<T>> as SystemParam>::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'world>, change_tick: Tick, ) -> Result<<ParamSet<'_, '_, Vec<T>> as SystemParam>::Item<'world, 'state>, SystemParamValidationError>

Creates a parameter to be passed into a SystemParamFunction. Read more
Source§

fn apply( state: &mut <ParamSet<'_, '_, Vec<T>> as SystemParam>::State, system_meta: &SystemMeta, world: &mut World, )

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during ApplyDeferred.
Source§

fn queue( state: &mut <ParamSet<'_, '_, Vec<T>> as SystemParam>::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.
Source§

impl<'w, 's, P0, P1, B0, B1> SystemParamBuilder<ParamSet<'w, 's, (P0, P1)>> for ParamSetBuilder<(B0, B1)>

Source§

fn build(self, world: &mut World) -> <(P0, P1) as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.
Source§

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.
Source§

fn build_system<Marker, In, Out, Func>( self, func: Func, ) -> IntoBuilderSystem<Marker, In, Out, Func, Self>
where Self: 'static, Func: SystemParamFunction<Marker, Param = P>,

Create a System from a SystemParamBuilder directly. Read more
Source§

impl<'w, 's, P0, P1, P2, B0, B1, B2> SystemParamBuilder<ParamSet<'w, 's, (P0, P1, P2)>> for ParamSetBuilder<(B0, B1, B2)>

Source§

fn build(self, world: &mut World) -> <(P0, P1, P2) as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.
Source§

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.
Source§

fn build_system<Marker, In, Out, Func>( self, func: Func, ) -> IntoBuilderSystem<Marker, In, Out, Func, Self>
where Self: 'static, Func: SystemParamFunction<Marker, Param = P>,

Create a System from a SystemParamBuilder directly. Read more
Source§

impl<'w, 's, P0, P1, P2, P3, B0, B1, B2, B3> SystemParamBuilder<ParamSet<'w, 's, (P0, P1, P2, P3)>> for ParamSetBuilder<(B0, B1, B2, B3)>

Source§

fn build(self, world: &mut World) -> <(P0, P1, P2, P3) as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.
Source§

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.
Source§

fn build_system<Marker, In, Out, Func>( self, func: Func, ) -> IntoBuilderSystem<Marker, In, Out, Func, Self>
where Self: 'static, Func: SystemParamFunction<Marker, Param = P>,

Create a System from a SystemParamBuilder directly. Read more
Source§

impl<'w, 's, P0, P1, P2, P3, P4, B0, B1, B2, B3, B4> SystemParamBuilder<ParamSet<'w, 's, (P0, P1, P2, P3, P4)>> for ParamSetBuilder<(B0, B1, B2, B3, B4)>

Source§

fn build( self, world: &mut World, ) -> <(P0, P1, P2, P3, P4) as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.
Source§

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.
Source§

fn build_system<Marker, In, Out, Func>( self, func: Func, ) -> IntoBuilderSystem<Marker, In, Out, Func, Self>
where Self: 'static, Func: SystemParamFunction<Marker, Param = P>,

Create a System from a SystemParamBuilder directly. Read more
Source§

impl<'w, 's, P0, P1, P2, P3, P4, P5, B0, B1, B2, B3, B4, B5> SystemParamBuilder<ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5)>> for ParamSetBuilder<(B0, B1, B2, B3, B4, B5)>

Source§

fn build( self, world: &mut World, ) -> <(P0, P1, P2, P3, P4, P5) as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.
Source§

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.
Source§

fn build_system<Marker, In, Out, Func>( self, func: Func, ) -> IntoBuilderSystem<Marker, In, Out, Func, Self>
where Self: 'static, Func: SystemParamFunction<Marker, Param = P>,

Create a System from a SystemParamBuilder directly. Read more
Source§

impl<'w, 's, P0, P1, P2, P3, P4, P5, P6, B0, B1, B2, B3, B4, B5, B6> SystemParamBuilder<ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6)>> for ParamSetBuilder<(B0, B1, B2, B3, B4, B5, B6)>

Source§

fn build( self, world: &mut World, ) -> <(P0, P1, P2, P3, P4, P5, P6) as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.
Source§

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.
Source§

fn build_system<Marker, In, Out, Func>( self, func: Func, ) -> IntoBuilderSystem<Marker, In, Out, Func, Self>
where Self: 'static, Func: SystemParamFunction<Marker, Param = P>,

Create a System from a SystemParamBuilder directly. Read more
Source§

impl<'w, 's, P0, P1, P2, P3, P4, P5, P6, P7, B0, B1, B2, B3, B4, B5, B6, B7> SystemParamBuilder<ParamSet<'w, 's, (P0, P1, P2, P3, P4, P5, P6, P7)>> for ParamSetBuilder<(B0, B1, B2, B3, B4, B5, B6, B7)>

Source§

fn build( self, world: &mut World, ) -> <(P0, P1, P2, P3, P4, P5, P6, P7) as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.
Source§

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.
Source§

fn build_system<Marker, In, Out, Func>( self, func: Func, ) -> IntoBuilderSystem<Marker, In, Out, Func, Self>
where Self: 'static, Func: SystemParamFunction<Marker, Param = P>,

Create a System from a SystemParamBuilder directly. Read more
Source§

impl<'w, 's, P0, B0> SystemParamBuilder<ParamSet<'w, 's, (P0,)>> for ParamSetBuilder<(B0,)>
where P0: SystemParam, B0: SystemParamBuilder<P0>,

Source§

fn build(self, world: &mut World) -> <(P0,) as SystemParam>::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.
Source§

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.
Source§

fn build_system<Marker, In, Out, Func>( self, func: Func, ) -> IntoBuilderSystem<Marker, In, Out, Func, Self>
where Self: 'static, Func: SystemParamFunction<Marker, Param = P>,

Create a System from a SystemParamBuilder directly. Read more
Source§

impl<'w, 's, P, B> SystemParamBuilder<ParamSet<'w, 's, Vec<P>>> for ParamSetBuilder<Vec<B>>

Source§

fn build(self, world: &mut World) -> <Vec<P> as SystemParam>::State ⓘ

Registers any World access used by this SystemParam and creates a new instance of this param’s State.
Source§

fn build_state(self, world: &mut World) -> SystemState<P>

Create a SystemState from a SystemParamBuilder. To create a system, call SystemState::build_system on the result.
Source§

fn build_system<Marker, In, Out, Func>( self, func: Func, ) -> IntoBuilderSystem<Marker, In, Out, Func, Self>
where Self: 'static, Func: SystemParamFunction<Marker, Param = P>,

Create a System from a SystemParamBuilder directly. Read more

Auto Trait Implementations§

§

impl<'w, 's, T> !RefUnwindSafe for ParamSet<'w, 's, T>

§

impl<'w, 's, T> !UnwindSafe for ParamSet<'w, 's, T>

§

impl<'w, 's, T> Freeze for ParamSet<'w, 's, T>
where &'s mut <T as SystemParam>::State: Freeze,

§

impl<'w, 's, T> Send for ParamSet<'w, 's, T>
where &'s mut <T as SystemParam>::State: Send,

§

impl<'w, 's, T> Sync for ParamSet<'w, 's, T>
where &'s mut <T as SystemParam>::State: Sync,

§

impl<'w, 's, T> Unpin for ParamSet<'w, 's, T>
where &'s mut <T as SystemParam>::State: Unpin,

§

impl<'w, 's, T> UnsafeUnpin for ParamSet<'w, 's, T>
where &'s mut <T as SystemParam>::State: UnsafeUnpin,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

Source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

impl<T> Identity for T
where T: ?Sized,

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T> InitializeFromFunction<T> for T

Source§

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Settings for T
where T: 'static + Send + Sync,

Source§

impl<Ret> SpawnIfAsync<(), Ret> for Ret

Source§

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block
Source§

impl<T, O> SuperFrom<T> for O
where O: From<T>,

Source§

fn super_from(input: T) -> O

Convert from a type to another type.
Source§

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

Source§

fn super_into(self) -> O

Convert from a type to another type.
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more