Skip to main content

ConsoleConfig

Struct ConsoleConfig 

Source
pub struct ConsoleConfig {
Show 26 fields pub font_path: Option<String>, pub font_size: f32, pub history_font_size: f32, pub dropdown_font_size: f32, pub history_height_vh: f32, pub history_bg: Color, pub history_padding: f32, pub history_text_color: Color, pub input_bg: Color, pub input_padding_h: f32, pub input_padding_v: f32, pub input_border_width: f32, pub input_border_color: Color, pub input_text_color: Color, pub input_ghost_color: Color, pub input_prefix: String, pub dropdown_bg: Color, pub dropdown_border_color: Color, pub dropdown_item_divider_color: Color, pub dropdown_padding_h: f32, pub dropdown_padding_v: f32, pub dropdown_text_color: Color, pub dropdown_highlight_bg: Color, pub dropdown_highlight_text_color: Color, pub toggle_key: KeyCode, pub history_file: Option<PathBuf>,
}
Expand description

All visual and behavioral settings for the developer console.

Use ConsoleConfig::default() for the built-in dark/gold look, or set any field to customise every visual element before passing it to the plugin:

app.add_plugins(ChillConsole {
    config: ConsoleConfig {
        input_border_color: Color::srgb(0.2, 0.8, 0.4),
        toggle_key: KeyCode::F1,
        ..default()
    },
});

Fields§

§font_path: Option<String>

Path to a font asset (e.g. "fonts/UbuntuMono-R.ttf"). None uses Bevy’s built-in default font.

§font_size: f32

Font size for the input bar text.

§history_font_size: f32

Font size for history lines.

§dropdown_font_size: f32

Font size for dropdown suggestion items.

§history_height_vh: f32

Height of the history panel as a percentage of viewport height.

§history_bg: Color

Background color of the history panel.

§history_padding: f32

Padding (px) inside the history panel on all sides.

§history_text_color: Color

Text color for history lines.

§input_bg: Color

Background color of the input bar.

§input_padding_h: f32

Horizontal padding (px) inside the input bar.

§input_padding_v: f32

Vertical padding (px) inside the input bar.

§input_border_width: f32

Width (px) of the divider border drawn above the input bar.

§input_border_color: Color

Color of the divider line above the input bar.

§input_text_color: Color

Color of the main input text.

§input_ghost_color: Color

Color of the ghost / autocomplete hint suffix.

§input_prefix: String

Prefix symbol shown before the cursor (e.g. "▶ ").

§dropdown_bg: Color

Background color of the autocomplete dropdown.

§dropdown_border_color: Color

Color of the bottom border of the dropdown container.

§dropdown_item_divider_color: Color

Color of the hairline dividers between dropdown items.

§dropdown_padding_h: f32

Horizontal padding (px) inside each dropdown item.

§dropdown_padding_v: f32

Vertical padding (px) inside each dropdown item.

§dropdown_text_color: Color

Text color for unselected dropdown items.

§dropdown_highlight_bg: Color

Background color for the currently highlighted dropdown item.

§dropdown_highlight_text_color: Color

Text color for the currently highlighted dropdown item.

§toggle_key: KeyCode

The key that toggles the console open and closed. Defaults to backtick.

§history_file: Option<PathBuf>

Path to a plain-text file used to persist the console’s display history (commands and their outputs) between runs. The file is read once at startup and rewritten whenever the history changes. Defaults to "console_history.txt" in the current working directory; set to None to disable persistence even with the feature enabled. Has no effect on web/wasm targets.

Implementations§

Source§

impl ConsoleConfig

Source

pub fn chillgames() -> Self

Icy blue — the Chillgames look.

Source

pub fn simple() -> Self

Clean black and white. No color accents.

Source

pub fn matrix() -> Self

Black background with green phosphor text.

Source

pub fn source() -> Self

Muted blue-gray inspired by the Source engine developer console.

Trait Implementations§

Source§

impl Clone for ConsoleConfig

Source§

fn clone(&self) -> ConsoleConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for ConsoleConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Resource for ConsoleConfig
where Self: Send + Sync + 'static,

Auto Trait Implementations§

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using default().

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> 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<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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<T> TypeData for T
where T: 'static + Send + Sync + Clone,

Source§

fn clone_type_data(&self) -> Box<dyn TypeData>

Creates a type-erased clone of this value.
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
Source§

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

Source§

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

Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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