Represents a read-only collection of Bexel.Api.Materials. More...
Public Member Functions | |
| Material | GetMaterialByID (MaterialID id) |
| Retrieves the material with the specified ID. More... | |
| Material | GetMaterialByID (int internalID) |
| Retrieves the material with the specified internal ID. More... | |
| Material | GetMaterialByName (string name) |
| Retrieves the material with the specified name. More... | |
| IEnumerable< Material > | GetMaterialsByName (string name) |
| Retrieves the materials with the specified name. More... | |
| bool | ContainsKey (MaterialID id) |
| Determines whether the collection contains the material with the specified ID. More... | |
| bool | ContainsKey (int internalID) |
| Determines whether the collection contains the material with the specified internal ID. More... | |
Properties | |
| Material | this[MaterialID id] [get] |
| Retrieves the material with the specified ID. More... | |
| Material | this[int internalID] [get] |
| Retrieves the material with the specified internal ID. More... | |
Detailed Description
Represents a read-only collection of Bexel.Api.Materials.
Member Function Documentation
◆ ContainsKey() [1/2]
| bool Bexel.Api.IReadOnlyMaterialCollection.ContainsKey | ( | MaterialID | id | ) |
Determines whether the collection contains the material with the specified ID.
- Parameters
-
id ID of the material.
- Returns
- True if material with the specified ID exists, False otherwise.
Implemented in Bexel.Api.ReadOnlyMaterialCollection.
◆ ContainsKey() [2/2]
| bool Bexel.Api.IReadOnlyMaterialCollection.ContainsKey | ( | int | internalID | ) |
Determines whether the collection contains the material with the specified internal ID.
- Parameters
-
internalID Internal ID of the material.
- Returns
- True if material with the specified internal ID exists, False otherwise.
Implemented in Bexel.Api.ReadOnlyMaterialCollection.
◆ GetMaterialByID() [1/2]
| Material Bexel.Api.IReadOnlyMaterialCollection.GetMaterialByID | ( | MaterialID | id | ) |
Retrieves the material with the specified ID.
- Parameters
-
id ID of the material.
- Returns
- A material with the specified ID, null if no such material exists within the collection.
Implemented in Bexel.Api.ReadOnlyMaterialCollection.
◆ GetMaterialByID() [2/2]
| Material Bexel.Api.IReadOnlyMaterialCollection.GetMaterialByID | ( | int | internalID | ) |
Retrieves the material with the specified internal ID.
- Parameters
-
internalID Internal ID of the material.
- Returns
- A material with the specified internal ID, null if no such material exists within the collection.
Implemented in Bexel.Api.ReadOnlyMaterialCollection.
◆ GetMaterialByName()
| Material Bexel.Api.IReadOnlyMaterialCollection.GetMaterialByName | ( | string | name | ) |
Retrieves the material with the specified name.
- Parameters
-
name Name of the material.
- Returns
- A material with the specified name, null if no such material exists within the collection.
Implemented in Bexel.Api.ReadOnlyMaterialCollection.
◆ GetMaterialsByName()
| IEnumerable<Material> Bexel.Api.IReadOnlyMaterialCollection.GetMaterialsByName | ( | string | name | ) |
Retrieves the materials with the specified name.
- Parameters
-
name Name of the material.
- Returns
- All materials with the specified name, empty collection if no such materials exist within the collection.
Implemented in Bexel.Api.ReadOnlyMaterialCollection.
Property Documentation
◆ this[int internalID]
|
get |
Retrieves the material with the specified internal ID.
- Parameters
-
internalID Internal ID of the material.
- Returns
- A material with the specified internal ID.
- Exceptions
-
System.Collections.Generic.KeyNotFoundException No material with the specified internal ID exists within the collection.
◆ this[MaterialID id]
|
get |
Retrieves the material with the specified ID.
- Parameters
-
id ID of the material.
- Returns
- A material with the specified ID.
- Exceptions
-
System.Collections.Generic.KeyNotFoundException No material with the specified ID exists within the collection.
