Bevy TrenchBroom

https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/
Admin
Bevy TrenchBroom is a Rust library that integrates TrenchBroom level editor support into the Bevy...
Tokens:994,324
Snippets:6,393
Trust Score:9.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Example Usage

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/prelude/struct.MaterialProperty.html?search=u32+-%3E+bool

An example demonstrating how to use MaterialProperty with a trait and Bevy's App.

```APIDOC
## Examples

```rust
use bevy::prelude::App;
use bevy_trenchbroom::prelude::*;

pub trait MyMaterialProperties {
    const MY_PROPERTY: MaterialProperty<f32> = MaterialProperty::new("my_property");
}

impl MyMaterialProperties for GenericMaterial {}

fn example_main() {
    App::new()
        .register_material_property(GenericMaterial::MY_PROPERTY)
        // ...
        .run();
}
```
```

--------------------------------

### MaterialProperty Usage Example

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/prelude/struct.MaterialProperty.html

Example demonstrating how to define and register a custom material property.

```APIDOC
## Examples

### Defining a Custom Material Property
```rust
use bevy_trenchbroom::prelude::MaterialProperty;
use bevy::app::App;
use bevy::render::material::StandardMaterial;

// Assuming GenericMaterial is a type that can be used with material properties
struct GenericMaterial;

pub trait MyMaterialProperties {
    const MY_PROPERTY: MaterialProperty<f32> = MaterialProperty::new("my_property");
}

impl MyMaterialProperties for GenericMaterial {}

fn example_main() {
    App::new()
        .register_material_property(GenericMaterial::MY_PROPERTY)
        // ... other app setup
        ;
}
```
```

--------------------------------

### Material Type Configuration

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/prelude/trait.MaterializeAppExt.html

Examples showing the transformation of a long type name into a shorthand in configuration.

```toml
type = "YourOldReallyLongNameOhMyGoshItsSoLong"
```

```toml
type = "ShortName"
```

--------------------------------

### Define Material Configuration

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/index.html

Example of a TOML material file structure for simple textures.

```toml
[material]
base_color_texture = "example.png"
```

--------------------------------

### DefaultTrenchBroomUserdataDirError Enum

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/config/enum.DefaultTrenchBroomUserdataDirError.html?search=u32+-%3E+bool

Errors that can occur when getting the default TrenchBroom game config path. Such errors typically occur when TrenchBroom is not installed or installed in a non-standard location.

```APIDOC
## Enum DefaultTrenchBroomUserdataDirError

### Description
Errors that can occur when getting the default TrenchBroom game config path. Such errors typically occur when TrenchBroom is not installed or installed in a non-standard location.

### Variants
*   `UnsupportedOs(String)`
*   `HomeDirNotFound`
*   `UserDataNotFound(PathBuf)`

### Trait Implementations
*   `Debug`
*   `Display`
*   `Error`
    *   `source()`
    *   `description()` (Deprecated)
    *   `cause()` (Deprecated)
    *   `provide()` (Nightly-only experimental API)

### Auto Trait Implementations
*   `Freeze`
*   `RefUnwindSafe`
*   `Send`
*   `Sync`
*   `Unpin`
*   `UnsafeUnpin`
*   `UnwindSafe

### Blanket Implementations
*   `Any`
*   `AsBindGroupShaderType<U>`
*   `Borrow<T>`
*   `BorrowMut<T>`
*   `Downcast`
*   `DowncastSend`
*   `From<T>`
*   `HasTypeWitness<W>`
*   `Identity`
*   `Instrument
```

--------------------------------

### Plugin Ready Method

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/fix_default_sampler/struct.RepeatDefaultSamplerPlugin.html?search=std%3A%3Avec

The `ready` method checks if the plugin has finished its setup. This is useful for plugins that depend on asynchronous operations, like renderer initialization.

```rust
fn ready(&self, _app: &App) -> bool
```

--------------------------------

### DefaultTrenchBroomUserdataDirError Enum

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/config/enum.DefaultTrenchBroomUserdataDirError.html?search=std%3A%3Avec

Errors that can occur when getting the default TrenchBroom game config path. Such errors typically occur when TrenchBroom is not installed or installed in a non-standard location.

```APIDOC
## Enum DefaultTrenchBroomUserdataDirError

### Description
Errors that can occur when getting the default TrenchBroom game config path. Such errors typically occur when TrenchBroom is not installed or installed in a non-standard location.

### Variants
*   **UnsupportedOs(String)**: Indicates that the operating system is not supported.
*   **HomeDirNotFound**: Indicates that the user's home directory could not be found.
*   **UserDataNotFound(PathBuf)**: Indicates that the TrenchBroom user data directory was not found at the specified path.
```

--------------------------------

### Iterate Over Exact Slice Chunks from End

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/qmap/struct.QuakeMapEntities.html

Use `rchunks_exact` to get an iterator over mutable slices of exactly `chunk_size`, starting from the end. Elements that do not form a full chunk are omitted. Panics if `chunk_size` is zero.

```rust
let slice = ['l', 'o', 'r', 'e', 'm'];
let mut iter = slice.rchunks_exact(2);
assert_eq!(iter.next().unwrap(), &['e', 'm']);
assert_eq!(iter.next().unwrap(), &['o', 'r']);
assert!(iter.next().is_none());

// The remainder can be retrieved using the `remainder` method on the iterator
```

--------------------------------

### POST /config/write

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/config/struct.TrenchBroomConfig.html?search=u32+-%3E+bool

Writes the game configuration to the filesystem.

```APIDOC
## write_game_config

### Description
Writes the game configuration into a specified directory.

### Parameters
- **directory** (impl AsRef<Path>) - Required - The target directory for the config.
- **type_registry** (TypeRegistry) - Required - The Bevy type registry.

### Response
#### Success Response (200)
- **Result** (()) - Returns Ok on success.
```

--------------------------------

### Iterate Over Mutable Slice Chunks from End

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/qmap/struct.QuakeMapEntities.html

Use `rchunks_mut` to get an iterator over mutable slices of a specified `chunk_size`, starting from the end of the slice. The last chunk may be smaller if the slice length is not perfectly divisible by `chunk_size`. Panics if `chunk_size` is zero.

```rust
let v = &mut [0, 0, 0, 0, 0];
let mut count = 1;

for chunk in v.rchunks_mut(2) {
    for elem in chunk.iter_mut() {
        *elem += count;
    }
    count += 1;
}
assert_eq!(v, &[3, 2, 2, 1, 1]);
```

--------------------------------

### Example Searches

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/geometry/enum.Brushes.html?search=

Provides examples of search queries that can be used within the system.

```APIDOC
## Example Searches

### Description
This section provides examples of search queries that can be used to find specific items or patterns within the system. These examples demonstrate various search syntaxes.

### Method
Search

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```
Example searches:
  * std::vec
  * u32 -> bool
  * Option<T>, (T -> U) -> Option<U>
```

### Response
#### Success Response (200)
Search results (format depends on the specific search query).

#### Response Example
None
```

--------------------------------

### Recommended Worldspawn Lighting Keys

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/manual/index.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Add these keys to your worldspawn entity or as command-line arguments to the 'light' compiler for enhanced baked lighting effects like bounce lighting and ambient occlusion.

```bash
-bounce 8 -bouncecolorscale 1 -bouncestyled 1 -dirt 1 -phong 1
```

--------------------------------

### QuakeClass Implementation

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/class/builtin/struct.DynamicSpotLight.html

Methods for handling Quake class registration and spawning logic for DynamicSpotLight.

```APIDOC
## QuakeClass Implementation

### Description
Provides functionality for spawning DynamicSpotLight entities into the scene world when a map is loaded and managing class metadata.

### Methods
- **class_spawn(view: &mut QuakeClassSpawnView<'_, '_, '_>) -> Result<()>**: Spawns the entity into the scene world.

### Constants
- **CLASS_INFO**: QuakeClassInfo
- **ERASED_CLASS**: &ErasedQuakeClass
```

--------------------------------

### Setup Animated Lighting Animators in Bevy

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/manual/index.html

Use this system on startup to define custom lighting animations. Reserve style 0 for static lighting. Interpolation values between 0 and 1 control the blending between animation frames.

```rust
fn setup_lighting_animators(
	mut animators: ResMut<LightingAnimators>,
) {
	// A soft flickering, could be used for a candle.
	animators.values.insert(
		LightmapStyle(1),
		LightingAnimator::new(6., 0.7, [0.8, 0.75, 1., 0.7, 0.8, 0.7, 0.9, 0.7, 0.6, 0.7, 0.9, 1., 0.7].map(Vec3::splat)),
	);
	// Fades from 0 to 1 and back looping with an interval of 2 seconds.
	animators.values.insert(
		LightmapStyle(2),
		LightingAnimator::new(0.5, 1., [0., 1.].map(Vec3::splat)),
	);
}
```

--------------------------------

### Get Underlying Array Reference

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/qmap/struct.QuakeMapEntities.html

Attempts to get a reference to the underlying array if the specified size `N` matches the slice length.

```rust
pub fn as_array<const N: usize>(&self) -> Option<&[T; N]> {
    if N == self.len() {
        Some(unsafe { &*(self as *const [T] as *const [T; N]) })
    } else {
        None
    }
}
```

--------------------------------

### Compile Map with qbsp Arguments

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/manual/index.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Use these recommended arguments with the qbsp compiler to optimize BSP generation for Bevy, supporting expanded limits and avoiding unnecessary subdivisions.

```bash
qbsp -qbism -nosubdivide -nosoftware -path assets -notex
```

--------------------------------

### Get Mutable Underlying Array Reference

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/qmap/struct.QuakeMapEntities.html

Attempts to get a mutable reference to the underlying array if the specified size `N` matches the slice length.

```rust
pub fn as_mut_array<const N: usize>(&mut self) -> Option<&mut [T; N]> {
    if N == self.len() {
        Some(unsafe { &mut *(self as *mut [T] as *mut [T; N]) })
    } else {
        None
    }
}
```

--------------------------------

### DynamicSpotLight QuakeClass Implementations

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/class/builtin/struct.DynamicSpotLight.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Details the QuakeClass methods for DynamicSpotLight, including class information and spawning.

```APIDOC
## DynamicSpotLight QuakeClass Implementations

### Description
This section details the `QuakeClass` trait implementation for `DynamicSpotLight`, including its class information and spawning behavior.

### Methods

#### `CLASS_INFO`
- **Description**: Static information about the `QuakeClass`.
- **Signature**: `const CLASS_INFO: QuakeClassInfo

#### `class_spawn`
- **Description**: Spawns the `DynamicSpotLight` into the scene world when the map is loaded.
- **Signature**: `fn class_spawn(view: &mut QuakeClassSpawnView<'_, '_, '_>) -> Result<()>

#### `ERASED_CLASS`
- **Description**: A global `ErasedQuakeClass` of this type, used for base classes and registration.
- **Signature**: `const ERASED_CLASS: &ErasedQuakeClass = _
```

--------------------------------

### Remove and Get Last Element of Slice

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/qmap/struct.QuakeMapEntities.html

Use `split_off_last` to remove the last element from an immutable slice and get a reference to it. Returns `None` if the slice is empty.

```rust
let mut slice: &[_] = &['a', 'b', 'c'];
let last = slice.split_off_last().unwrap();

assert_eq!(slice, &['a', 'b']);
assert_eq!(last, &'c');
```

--------------------------------

### Macros

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/prelude/index.html

Documentation for the `manifest` macro.

```APIDOC
## Macros

### manifest

Generates a manifest accounting the structure of a folder at compile time. Use like `manifest!("folder path from project root")`.
```

--------------------------------

### Implement Plugin for CorePlugin

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/struct.CorePlugin.html?search=

Provides the `build` method for the CorePlugin, which configures the Bevy App by inserting necessary components and systems. Other methods like `ready`, `finish`, `cleanup`, `name`, and `is_unique` are also defined for plugin lifecycle management.

```rust
fn build(&self, app: &mut App)

```

```rust
fn ready(&self, _app: &App) -> bool

```

```rust
fn finish(&self, _app: &mut App)

```

```rust
fn cleanup(&self, _app: &mut App)

```

```rust
fn name(&self) -> &str

```

```rust
fn is_unique(&self) -> bool

```

--------------------------------

### Remove and Get First Element of Slice

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/qmap/struct.QuakeMapEntities.html

Use `split_off_first` to remove the first element from an immutable slice and get a reference to it. Returns `None` if the slice is empty.

```rust
let mut slice: &[_] = &['a', 'b', 'c'];
let first = slice.split_off_first().unwrap();

assert_eq!(slice, &['b', 'c']);
assert_eq!(first, &'a');
```

--------------------------------

### Get Path from Reflect

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/fgd/struct.TargetDestination.html?search=std%3A%3Avec

Provides methods to get a reference or mutable reference to a value at a specified path within a `Reflect` type. Handles potential `ReflectPathError`.

```rust
impl<T> GetPath for T
where T: Reflect + ?Sized,
Source§
#### fn reflect_path<'p>( &self, path: impl ReflectPath<'p>, ) -> Result<&(dyn PartialReflect + 'static), ReflectPathError<'p>>
Returns a reference to the value specified by `path`. Read more
```

```rust
#### fn reflect_path_mut<'p>( &mut self, path: impl ReflectPath<'p>, ) -> Result<&mut (dyn PartialReflect + 'static), ReflectPathError<'p>>
Returns a mutable reference to the value specified by `path`. Read more
```

```rust
#### fn path<'p, T>( &self, path: impl ReflectPath<'p>, ) -> Result<&T, ReflectPathError<'p>>
where T: Reflect,
Returns a statically typed reference to the value specified by `path`. Read more
```

```rust
#### fn path_mut<'p, T>( &mut self, path: impl ReflectPath<'p>, ) -> Result<&mut T, ReflectPathError<'p>>
where T: Reflect,
Returns a statically typed mutable reference to the value specified by `path`. Read more
```

--------------------------------

### QuakeClass Implementation

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/class/builtin/struct.DynamicOnlyPointLight.html?search=u32+-%3E+bool

Methods for handling Quake class registration and spawning logic for DynamicOnlyPointLight.

```APIDOC
## QuakeClass::class_spawn

### Description
Spawns the entity into the scene world when the map is loaded.

### Parameters
#### Request Body
- **view** (QuakeClassSpawnView) - Required - The spawn view context for the scene world.

### Response
#### Success Response (200)
- **Result** (()) - Returns Ok if the spawn was successful.
```

--------------------------------

### Manifest::new

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/config/struct.Manifest.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Constructs a new Manifest instance from a given ManifestEntry.

```APIDOC
## `impl Manifest`

### `pub fn new(entry: ManifestEntry) -> Self`

#### Description
Creates a new `Manifest` from a `ManifestEntry`.

#### Method
`POST` (Conceptual - Rust function call)

#### Endpoint
N/A (Rust function)

#### Parameters
##### Path Parameters
None

##### Query Parameters
None

##### Request Body
- **entry** (`ManifestEntry`) - Required - The entry point for the manifest.

### Request Example
```rust
let manifest_entry = ManifestEntry::new("path/to/root");
let manifest = Manifest::new(manifest_entry);
```

### Response
#### Success Response (200)
- **Self** (`Manifest`) - The newly created Manifest instance.

#### Response Example
```rust
// Manifest instance is returned directly
```
```

--------------------------------

### Get the byte length of a String slice in Rust

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/fgd/struct.TargetDestination.html?search=

Use `len` to get the length of a string slice in bytes. Note that this is not the number of characters or graphemes, and can differ for multi-byte UTF-8 characters.

```rust
let len = "foo".len();
assert_eq!(3, len);

assert_eq!("ƒoo".len(), 4); // fancy f!
assert_eq!("ƒoo".chars().count(), 3);
```

--------------------------------

### Rotate subslice left

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/qmap/struct.QuakeMapEntities.html?search=u32+-%3E+bool

Rotates a portion of the slice in-place. The rotation is applied to the elements within the specified range `[start..end)`. The `mid` value is relative to the start of the subslice.

```rust
let mut a = ['a', 'b', 'c', 'd', 'e', 'f'];
a[1..5].rotate_left(1);
assert_eq!(a, ['a', 'c', 'd', 'e', 'b', 'f']);

```

--------------------------------

### Plugin Build Method

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/fix_default_sampler/struct.RepeatDefaultSamplerPlugin.html?search=std%3A%3Avec

The `build` method configures the `App` to which this plugin is added. It's the primary entry point for plugin logic during app setup.

```rust
fn build(&self, app: &mut App)
```

--------------------------------

### QuakeClass Implementation for DynamicOnlySpotLight

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/class/builtin/struct.DynamicOnlySpotLight.html?search=u32+-%3E+bool

Details the `QuakeClass` implementation for `DynamicOnlySpotLight`, including class information and spawning behavior.

```APIDOC
## QuakeClass for DynamicOnlySpotLight

### Description
Details the `QuakeClass` implementation for `DynamicOnlySpotLight`, including class information and spawning behavior.

### Constants

- `CLASS_INFO: QuakeClassInfo`: Information about the Quake class.
- `ERASED_CLASS: &ErasedQuakeClass`: A global `ErasedQuakeClass` of this type, used for registration.

### Methods

- `class_spawn(view: &mut QuakeClassSpawnView<'_, '_, '_>) -> Result<()>`: Spawns into the scene world when the map is loaded.
```

--------------------------------

### Unchecked Get Element or Subslice from BrushesAsset

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/geometry/struct.BrushesAsset.html?search=

Returns a reference to an element or subslice without bounds checking. Use with caution as out-of-bounds access is undefined behavior. For safe alternative, use `get`.

```rust
let x = &[1, 2, 4];

unsafe {
    assert_eq!(x.get_unchecked(1), &2);
}
```

--------------------------------

### Example of Registering Material Shorthand - bevy_trenchbroom

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/prelude/trait.MaterializeAppExt.html?search=u32+-%3E+bool

Demonstrates how to register a shorthand for a long material type name and how to use it in configuration.

```rust
.register_generic_material_shorthand::<YourOldReallyLongNameOhMyGoshItsSoLong>("ShortName")
```

```toml
type = "ShortName"
```

--------------------------------

### Remove and Get Last Mutable Element of Slice

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/qmap/struct.QuakeMapEntities.html

Use `split_off_last_mut` to remove the last element from a mutable slice and get a mutable reference to it. Allows modification of the removed element. Returns `None` if the slice is empty.

```rust
let mut slice: &mut [_] = &mut ['a', 'b', 'c'];
let last = slice.split_off_last_mut().unwrap();
*last = 'd';

assert_eq!(slice, &['a', 'b']);
assert_eq!(last, &'d');
```

--------------------------------

### QuakeClass Implementation

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/class/builtin/struct.DynamicOnlySpotLight.html?search=std%3A%3Avec

Methods for managing the Quake class lifecycle and metadata for DynamicOnlySpotLight.

```APIDOC
## QuakeClass Implementation

### Description
Provides functionality for spawning the entity into the scene world when a map is loaded and accessing class metadata.

### Methods
- **class_spawn(view: &mut QuakeClassSpawnView)**: Spawns the entity into the scene world.
- **CLASS_INFO**: Constant containing Quake class information.
- **ERASED_CLASS**: Global erased class reference for registration.
```

--------------------------------

### Remove and Get First Mutable Element of Slice

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/qmap/struct.QuakeMapEntities.html

Use `split_off_first_mut` to remove the first element from a mutable slice and get a mutable reference to it. Allows modification of the removed element. Returns `None` if the slice is empty.

```rust
let mut slice: &mut [_] = &mut ['a', 'b', 'c'];
let first = slice.split_off_first_mut().unwrap();
*first = 'd';

assert_eq!(slice, &['b', 'c']);
assert_eq!(first, &'d');
```

--------------------------------

### DynamicSpotLight QuakeClass Implementation

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/class/builtin/struct.DynamicSpotLight.html?search=std%3A%3Avec

Details the QuakeClass specific functionalities for DynamicSpotLight, including class information and spawning.

```APIDOC
## DynamicSpotLight QuakeClass Implementation

### Description
Implements QuakeClass functionalities for DynamicSpotLight, enabling it to be spawned into the scene world.

### Constants and Methods

- `CLASS_INFO: QuakeClassInfo`: Static information about the Quake class.
- `class_spawn(view: &mut QuakeClassSpawnView<'_, '_, '_>) -> Result<()>`: Spawns the class into the scene world when the map is loaded.
- `ERASED_CLASS: &ErasedQuakeClass`: A global `ErasedQuakeClass` for registration and base class usage.
```

--------------------------------

### Check for character boundaries in a String slice in Rust

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/fgd/struct.TargetDestination.html?search=

Use `is_char_boundary` to determine if a given byte index is the start of a UTF-8 code point or the end of the string. The start and end of the string are always considered boundaries.

```rust
let s = "Löwe 老虎 Léopard";
assert!(s.is_char_boundary(0));
// start of `老`
assert!(s.is_char_boundary(6));
assert!(s.is_char_boundary(s.len()));

// second byte of `ö`
assert!(!s.is_char_boundary(2));

// third byte of `老`
assert!(!s.is_char_boundary(8));
```

--------------------------------

### MaterializePlugin Initialization Methods

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/prelude/struct.MaterializePlugin.html?search=u32+-%3E+bool

Methods for creating and configuring a new MaterializePlugin instance.

```rust
pub fn new(deserializer: D) -> MaterializePlugin<D, AssetLoadingProcessor<()>>
```

```rust
pub fn new_with_processor( deserializer: D, processor: P, ) -> MaterializePlugin<D, P>
```

```rust
pub fn with_simple_loader( self, loader: SimpleGenericMaterialLoader, ) -> MaterializePlugin<D, P>
```

```rust
pub fn with_text_replacements(self, value: bool) -> MaterializePlugin<D, P>
```

```rust
pub fn with_animated_materials(self, value: bool) -> MaterializePlugin<D, P>
```

```rust
pub fn with_standard_material_color_space_fix( self, value: bool, ) -> MaterializePlugin<D, P>
```

```rust
pub fn with_processor<NewP>( self, f: impl FnOnce(P) -> NewP, ) -> MaterializePlugin<D, NewP>
where NewP: MaterialProcessor,
```

--------------------------------

### as_array

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/qmap/struct.QuakeMapEntities.html?search=

Gets a reference to the underlying array.

```APIDOC
## as_array<const N: usize>

### Description
Gets a reference to the underlying array. Returns None if N is not equal to the length of the slice.
```

--------------------------------

### GET /string/is_empty

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/fgd/struct.TargetSource.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Checks if the string has a length of zero.

```APIDOC
## GET /string/is_empty

### Description
Returns `true` if this `String` has a length of zero, and `false` otherwise.

### Method
GET

### Response
#### Success Response (200)
- **is_empty** (bool) - True if the string is empty.
```

--------------------------------

### Initialize TrenchBroomPlugins

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/index.html

Add the required plugins to your Bevy App using the builder syntax for configuration.

```rust
use bevy::prelude::*;
use bevy_trenchbroom::prelude::*;

fn main() {
    App::new()
        // ...
        .add_plugins(TrenchBroomPlugins(TrenchBroomConfig::new("your_game_name")))
        // ...
    ;
}
```

--------------------------------

### GET /is_empty

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/fgd/struct.TargetSource.html

Checks if the string has a length of zero.

```APIDOC
## GET /is_empty

### Description
Returns `true` if this `String` has a length of zero, and `false` otherwise.

### Method
GET

### Response
#### Success Response (200)
- **is_empty** (bool) - True if empty, false otherwise.
```

--------------------------------

### World Initialization

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/brush/struct.Brush.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for initializing types from the Bevy world.

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

### Description
Creates `Self` using `default()`.

### Method
POST

### Endpoint
N/A (Method on type)

### Parameters
- **_world** (&mut World) - Required - A mutable reference to the Bevy world.

### Request Body
None

### Response
#### Success Response (200)
- **T** (T) - The created instance of the type.

### Response Example
```json
{
  "created_instance": "instance_representation"
}
```
```

--------------------------------

### GET /len

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/fgd/struct.TargetSource.html

Returns the length of the string in bytes.

```APIDOC
## GET /len

### Description
Returns the length of this `String`, in bytes.

### Method
GET

### Response
#### Success Response (200)
- **length** (usize) - The length of the string in bytes.
```

--------------------------------

### QuakeClass Implementation for DynamicPointLight

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/class/builtin/struct.DynamicPointLight.html?search=std%3A%3Avec

Methods for handling Quake class metadata and spawning logic.

```APIDOC
## QuakeClass Methods

### Description
Provides functionality for Quake class identification and scene spawning.

### Methods
- **CLASS_INFO** (QuakeClassInfo) - Constant metadata for the class.
- **class_spawn(view: &mut QuakeClassSpawnView)** (Result<()>) - Spawns the entity into the scene world when the map is loaded.
- **ERASED_CLASS** (&ErasedQuakeClass) - Global erased class reference for registration.
```

--------------------------------

### GET /string/len

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/fgd/struct.TargetSource.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Returns the length of the string in bytes.

```APIDOC
## GET /string/len

### Description
Returns the length of this `String`, in bytes, not `char`s or graphemes.

### Method
GET

### Response
#### Success Response (200)
- **length** (usize) - The length of the string in bytes.
```

--------------------------------

### Any Type ID Function

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/qmap/loader/struct.QuakeMapLoader.html?search=std%3A%3Avec

Gets the TypeId of the implementing type.

```rust
fn type_id(&self) -> TypeId;
```

--------------------------------

### DynamicSpotLight Reflect Implementations

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/class/builtin/struct.DynamicSpotLight.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Details the core reflection methods for DynamicSpotLight, including casting and value setting.

```APIDOC
## DynamicSpotLight Reflect Implementations

### Description
This section covers the fundamental `Reflect` trait implementations for `DynamicSpotLight`, enabling casting to `Any` and `Reflect`, as well as value assignment.

### Methods

#### `into_any`
- **Description**: Returns the value as a `Box<dyn Any>`.
- **Signature**: `fn into_any(self: Box<Self>) -> Box<dyn Any>

#### `as_any`
- **Description**: Returns the value as a `&dyn Any`.
- **Signature**: `fn as_any(&self) -> &dyn Any

#### `as_any_mut`
- **Description**: Returns the value as a `&mut dyn Any`.
- **Signature**: `fn as_any_mut(&mut self) -> &mut dyn Any

#### `into_reflect`
- **Description**: Casts this type to a boxed, fully-reflected value.
- **Signature**: `fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

#### `as_reflect`
- **Description**: Casts this type to a fully-reflected value.
- **Signature**: `fn as_reflect(&self) -> &dyn Reflect

#### `as_reflect_mut`
- **Description**: Casts this type to a mutable, fully-reflected value.
- **Signature**: `fn as_reflect_mut(&mut self) -> &mut dyn Reflect

#### `set`
- **Description**: Performs a type-checked assignment of a reflected value to this value.
- **Signature**: `fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
```

--------------------------------

### GetField Trait

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/class/builtin/struct.DynamicSpotLight.html?search=

Allows getting field values from a struct.

```APIDOC
## fn get_field<T>(&self, name: &str) -> Option<&T>

### Description
Returns a reference to the value of the field named `name`, downcast to `T`.

### Method
GET

### Endpoint
N/A (Method on an object)

### Parameters
- **name** (&str) - The name of the field.

### Request Body
None

### Response
#### Success Response (200)
- **Option<&T>** (Option<&T>) - An optional reference to the field value.
```

```APIDOC
## fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T>

### Description
Returns a mutable reference to the value of the field named `name`, downcast to `T`.

### Method
GET

### Endpoint
N/A (Method on an object)

### Parameters
- **name** (&str) - The name of the field.

### Request Body
None

### Response
#### Success Response (200)
- **Option<&mut T>** (Option<&mut T>) - An optional mutable reference to the field value.
```

--------------------------------

### TrenchBroomServer::new

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/struct.TrenchBroomServer.html?search=

Creates a new instance of the TrenchBroomServer.

```APIDOC
## pub fn new(config: TrenchBroomConfig, asset_server: &AssetServer) -> Self

### Description
Creates a new TrenchBroomServer instance using the provided configuration and a reference to the Bevy AssetServer.

### Parameters
- **config** (TrenchBroomConfig) - Required - The configuration settings for the server.
- **asset_server** (&AssetServer) - Required - A reference to the Bevy AssetServer for asset management.

### Response
- **Self** (TrenchBroomServer) - The initialized server instance.
```

--------------------------------

### GetField

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/brush/struct.BrushSurface.html?search=std%3A%3Avec

Provides methods to get field values by name.

```APIDOC
## fn get_field<T>(&self, name: &str) -> Option<&T>

### Description
Returns a reference to the value of the field named `name`, downcast to `T`.

### Method
`fn`

### Endpoint
N/A (Implementation detail)

### Parameters
* **name** (&str) - The name of the field.

### Request Example
None

### Response
#### Success Response (200)
`Option<&T>` - An optional reference to the field value.

#### Response Example
None
```

```APIDOC
## fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T>

### Description
Returns a mutable reference to the value of the field named `name`, downcast to `T`.

### Method
`fn`

### Endpoint
N/A (Implementation detail)

### Parameters
* **name** (&str) - The name of the field.

### Request Example
None

### Response
#### Success Response (200)
`Option<&mut T>` - An optional mutable reference to the field value.

#### Response Example
None
```

--------------------------------

### QuakeClass Implementation

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/class/builtin/struct.Target.html?search=u32+-%3E+bool

Details the implementation of `QuakeClass` for `Target`, including class information and spawning logic.

```APIDOC
### `impl QuakeClass for Target`

#### `const CLASS_INFO: QuakeClassInfo`
Provides information about the `Target` class.

#### `fn class_spawn(view: &mut QuakeClassSpawnView<'_, '_, '_>) -> Result<()>`
Spawns into the scene world when the map is loaded.

#### `const ERASED_CLASS: &ErasedQuakeClass = _`
A global `ErasedQuakeClass` of this type, used for base classes and registration.
```

--------------------------------

### starts_with

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/fgd/struct.TargetDestination.html?search=

Checks if a string slice starts with a given pattern.

```APIDOC
## starts_with

### Description
Returns `true` if the given pattern matches a prefix of this string slice. Returns `false` if it does not. The pattern can be a `&str`, `char`, a slice of `char`s, or a function or closure that determines if a character matches.

### Method
`starts_with`

### Endpoint
N/A (Method on string slices)

### Parameters
- **pat** (Pattern) - Required - The pattern to check against the prefix.

### Request Example
```rust
let bananas = "bananas";
assert!(bananas.starts_with("bana"));
```

### Response
- **bool** (bool) - `true` if the string slice starts with the pattern, `false` otherwise.
```

--------------------------------

### DynamicPointLight QuakeClass Implementation

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/class/builtin/struct.DynamicPointLight.html?search=

Defines class information and spawning behavior for DynamicPointLight within the QuakeClass system.

```APIDOC
## DynamicPointLight QuakeClass Implementation

### Description
Defines class information and spawning behavior for DynamicPointLight within the QuakeClass system.

### Constants

#### `CLASS_INFO: QuakeClassInfo`
Provides information about the Quake class.

#### `ERASED_CLASS: &ErasedQuakeClass`
A global `ErasedQuakeClass` of this type. Used for base classes and registration.

### Methods

#### `class_spawn(view: &mut QuakeClassSpawnView<'_, '_, '_>) -> Result<()>`
Spawns into the scene world when the map is loaded.
```

--------------------------------

### App Implementation of QuakeClassAppExt

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/class/trait.QuakeClassAppExt.html?search=u32+-%3E+bool

Demonstrates how the App type implements the QuakeClassAppExt trait.

```APIDOC
### impl QuakeClassAppExt for App

This block shows the implementation of `QuakeClassAppExt` methods for the `App` type.

#### `fn disable_class<T: QuakeClass>(&mut self) -> &mut Self`

##### Description
Implementation of `disable_class` for `App`.

#### `fn override_class<T: QuakeClass>(&mut self) -> &mut Self`

##### Description
Implementation of `override_class` for `App`.
```

--------------------------------

### strip_prefix

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/geometry/struct.BrushesAsset.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Returns a subslice with the prefix removed. If the slice starts with `prefix`, returns the subslice after the prefix, wrapped in `Some`. If `prefix` is empty, simply returns the original slice. If `prefix` is equal to the original slice, returns an empty slice. If the slice does not start with `prefix`, returns `None`.

```APIDOC
## strip_prefix

### Description
Returns a subslice with the prefix removed. If the slice starts with `prefix`, returns the subslice after the prefix, wrapped in `Some`. If `prefix` is empty, simply returns the original slice. If `prefix` is equal to the original slice, returns an empty slice. If the slice does not start with `prefix`, returns `None`.

### Method
N/A (This is a method on slices, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
- **prefix** (&P) - Required - The prefix to remove. `P` must implement `SlicePattern<Item = T>` and `?Sized`, and `T` must implement `PartialEq`.

### Request Example
N/A

### Response
- **Option<&[T]>** - The subslice with the prefix removed, or `None` if the slice does not start with the prefix.

### Response Example
N/A
```

--------------------------------

### Compile Lighting with light Arguments

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/manual/index.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

These arguments for the 'light' compiler generate irradiance volumes for baked lighting and improve shadow smoothness. Ensure '-path assets' matches your texture path.

```bash
light -wrnormals -extra4 -lightgrid -path assets
```

--------------------------------

### as_mut_array

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/qmap/struct.QuakeMapEntities.html?search=

Gets a mutable reference to the slice’s underlying array.

```APIDOC
## as_mut_array<const N: usize>

### Description
Gets a mutable reference to the slice’s underlying array. Returns None if N is not equal to the length of the slice.
```

--------------------------------

### QuakeMapEntity Implementations

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/qmap/struct.QuakeMapEntity.html

Details on the implementations for the QuakeMapEntity struct.

```APIDOC
### Trait Implementations for QuakeMapEntity

#### `Clone`
- **Description**: Provides methods for creating copies of `QuakeMapEntity` instances.
- **Methods**:
  - `clone(&self) -> QuakeMapEntity`: Returns a duplicate of the value.
  - `clone_from(&mut self, source: &Self)`: Performs copy-assignment from a source.

#### `Debug`
- **Description**: Allows `QuakeMapEntity` instances to be formatted for debugging.
- **Methods**:
  - `fmt(&self, f: &mut Formatter<'_>) -> Result`: Formats the value using the given formatter.

#### `Default`
- **Description**: Provides a default value for `QuakeMapEntity`.
- **Methods**:
  - `default() -> QuakeMapEntity`: Returns the default value for the type.

#### `Deserialize` (from Serde)
- **Description**: Enables deserialization of `QuakeMapEntity` from a Serde deserializer.
- **Methods**:
  - `deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>`: Deserializes this value from the given Serde deserializer.

#### `FromReflect`
- **Description**: Allows constructing `QuakeMapEntity` from reflected values.
- **Methods**:
  - `from_reflect(reflect: &dyn PartialReflect) -> Option<Self>`: Constructs a concrete instance of `Self` from a reflected value.
  - `take_from_reflect(reflect: Box<dyn PartialReflect>) -> Result<Self, Box<dyn PartialReflect>>`: Attempts to downcast and construct `Self` from a boxed reflected value.

#### `GetTypeRegistration`
- **Description**: Provides type registration information for `QuakeMapEntity` within a Bevy ECS context.
- **Methods**:
  - `get_type_registration() -> TypeRegistration`: Returns the default `TypeRegistration` for this type.
  - `register_type_dependencies(registry: &mut TypeRegistry)`: Registers other types needed by this type.

#### `PartialReflect`
- **Description**: Enables reflection capabilities for `QuakeMapEntity`.
- **Methods**:
  - `get_represented_type_info(&self) -> Option<&'static TypeInfo>`: Returns the `TypeInfo` of the type represented by this value.
  - `try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>`: Tries to apply a reflected value to this value.
  - `reflect_kind(&self) -> ReflectKind`: Returns an enumeration of the "kinds" of type.
  - `reflect_ref(&self) -> ReflectRef<'_>`: Returns an immutable enumeration of the "kinds" of type.
  - `reflect_mut(&mut self) -> ReflectMut<'_>`: Returns a mutable enumeration of the "kinds" of type.
  - `reflect_owned(self: Box<Self>) -> ReflectOwned`: Returns an owned enumeration of the "kinds" of type.
  - `try_into_reflect(self: Box<Self>) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>`: Attempts to cast this type to a boxed, fully-reflected value.
  - `try_as_reflect(&self) -> Option<&dyn Reflect>`: Attempts to cast this type to a fully-reflected value.
  - `try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>`: Attempts to cast this type to a mutable, fully-reflected value.
  - `into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>`: Casts this type to a boxed, reflected value.
  - `as_partial_reflect(&self) -> &dyn PartialReflect`: Casts this type to a reflected value.
  - `as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect`: Casts this type to a mutable, reflected value.
  - `reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>`: Returns a "partial equality" comparison result.
  - `reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>`: Attempts to clone `Self` using reflection.
  - `apply(&mut self, value: &(dyn PartialReflect + 'static))`: Applies a reflected value to this value.
  - `to_dynamic(&self) -> Box<dyn PartialReflect>`: Converts this reflected value into its dynamic representation based on its kind.
```

--------------------------------

### GetTupleStructField Implementation

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/class/scene_hooks/struct.PreloadedAssets.html?search=

Provides methods to get fields from a tuple struct.

```APIDOC
## impl<S> GetTupleStructField for S
where S: TupleStruct

### get_field<T>(&self, index: usize) -> Option<&T>

Returns a reference to the value of the field with index `index`, downcast to `T`.

### get_field_mut<T>(&mut self, index: usize) -> Option<&mut T>

Returns a mutable reference to the value of the field with index `index`, downcast to `T`.
```

--------------------------------

### Struct Field Access

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/class/builtin/struct.DynamicSpotLight.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for getting struct fields by name.

```APIDOC
## fn get_field<T>(&self, name: &str) -> Option<&T>

### Description
Returns a reference to the value of the field named `name`, downcast to `T`.

### Method
GET

### Endpoint
N/A (Method within a trait implementation)

### Parameters
- **name** (&str) - The name of the field.

### Request Body
None

### Response
- **Option<&T>** (Option<&T>) - An optional reference to the field value.
```

```APIDOC
## fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T>

### Description
Returns a mutable reference to the value of the field named `name`, downcast to `T`.

### Method
GET

### Endpoint
N/A (Method within a trait implementation)

### Parameters
- **name** (&str) - The name of the field.

### Request Body
None

### Response
- **Option<&mut T>** (Option<&mut T>) - An optional mutable reference to the field value.
```

--------------------------------

### DynamicSpotLight Reflection Methods

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/class/builtin/struct.DynamicSpotLight.html?search=std%3A%3Avec

Provides methods for inspecting and manipulating DynamicSpotLight objects using reflection.

```APIDOC
## DynamicSpotLight Reflection Methods

### Description
Methods for partial equality comparison, cloning, applying reflected values, converting to dynamic representation, and hashing.

### Methods

- `reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>`: Returns a partial equality comparison result.
- `reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>`: Attempts to clone `Self` using reflection.
- `apply(&mut self, value: &(dyn PartialReflect + 'static))`: Applies a reflected value to this value.
- `to_dynamic(&self) -> Box<dyn PartialReflect>`: Converts this reflected value into its dynamic representation.
- `reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>`: Combines `reflect_clone` and `take` for types implementing `PartialReflect`.
- `reflect_hash(&self) -> Option<u64>`: Returns a hash of the value, including the type.
- `debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>`: Debug formatter for the value.
- `is_dynamic(&self) -> bool`: Indicates whether this type is a dynamic type.
```

--------------------------------

### GetField Trait

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/class/builtin/struct.DynamicPointLight.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Allows getting and setting struct fields by name.

```APIDOC
## fn get_field<T>(&self, name: &str) -> Option<&T>

### Description
Returns a reference to the value of the field named `name`, downcast to `T`.

### Method
GET

### Endpoint
N/A (Method on a Struct)

### Parameters
- **name** (&str) - The name of the field.

### Request Example
None

### Response
#### Success Response (200)
- **Option<&T>** (Option<&T>) - An optional reference to the field value, downcast to type `T`.
```

```APIDOC
## fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T>

### Description
Returns a mutable reference to the value of the field named `name`, downcast to `T`.

### Method
GET

### Endpoint
N/A (Method on a mutable Struct)

### Parameters
- **name** (&str) - The name of the field.

### Request Example
None

### Response
#### Success Response (200)
- **Option<&mut T>** (Option<&mut T>) - An optional mutable reference to the field value, downcast to type `T`.
```

--------------------------------

### MaterializePlugin Initialization

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/prelude/struct.MaterializePlugin.html?search=

Methods for creating and configuring the MaterializePlugin instance.

```APIDOC
## MaterializePlugin::new

### Description
Creates a new MaterializePlugin with an AssetLoadingProcessor.

### Parameters
- **deserializer** (D) - Required - The material deserializer to use.

## MaterializePlugin::new_with_processor

### Description
Creates a new MaterializePlugin with a custom processor.

### Parameters
- **deserializer** (D) - Required - The material deserializer to use.
- **processor** (P) - Required - The custom material processor.

## Configuration Methods
- **with_simple_loader(loader)** - Registers a GenericMaterial loader that loads directly from images.
- **with_text_replacements(value)** - Enables or disables text pattern replacement (e.g., ${name}).
- **with_animated_materials(value)** - Enables or disables the AnimationPlugin for materials with the ANIMATION property.
- **with_standard_material_color_space_fix(value)** - Automatically sets non-sRGB maps to linear color space.
```

--------------------------------

### GetField Trait Implementations

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/special_textures/struct.QuakeSkyMaterial.html?search=u32+-%3E+bool

Provides methods for getting struct fields by name.

```APIDOC
### impl<S> GetField for S

#### fn get_field<T>(&self, name: &str) -> Option<&T>

##### Description
Returns a reference to the value of the field named `name`, downcast to `T`.

#### fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T>

##### Description
Returns a mutable reference to the value of the field named `name`, downcast to `T`.
```

--------------------------------

### Implement Plugin for UtilPlugin

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/util/struct.UtilPlugin.html?search=std%3A%3Avec

This implementation provides the core functionality for UtilPlugin as a Bevy plugin. The `build` function is crucial for configuring the Bevy App.

```rust
impl Plugin for UtilPlugin {
    fn build(&self, app: &mut App) {
        // Configuration logic here
    }

    fn ready(&self, _app: &App) -> bool {
        // Readiness check logic
        true
    }

    fn finish(&self, _app: &mut App) {
        // Post-build setup logic
    }

    fn cleanup(&self, _app: &mut App) {
        // Cleanup logic after build and finish
    }

    fn name(&self) -> &str {
        // Plugin name for debugging
        "UtilPlugin"
    }

    fn is_unique(&self) -> bool {
        // Whether the plugin can be instantiated multiple times
        true
    }
}
```

--------------------------------

### GetField Trait

Source: https://docs.rs/bevy_trenchbroom/latest/bevy_trenchbroom/special_textures/struct.LiquidMaterialExt.html?search=u32+-%3E+bool

Provides methods to get field values from a struct by name.

```APIDOC
## impl<S> GetField for S
where S: Struct

### Description
Provides methods to get field values from a struct by name.

### Methods
#### fn get_field<T>(&self, name: &str) -> Option<&T>
where T: Reflect
Returns a reference to the value of the field named `name`, downcast to `T`.

#### fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T>
where T: Reflect
Returns a mutable reference to the value of the field named `name`, downcast to `T`.
```
Tokens:
Raw