forked from nxrighthere/UnrealCLR
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b87ef8b
commit 81efbb3
Showing
27 changed files
with
512 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
### [UnrealEngine.Framework](./UnrealEngine-Framework.md 'UnrealEngine.Framework').[Asset](./Asset.md 'UnrealEngine.Framework.Asset') | ||
## Asset.Equals(UnrealEngine.Framework.Asset) Method | ||
Indicates equality of objects | ||
```csharp | ||
public bool Equals(UnrealEngine.Framework.Asset other); | ||
``` | ||
#### Parameters | ||
<a name='UnrealEngine-Framework-Asset-Equals(UnrealEngine-Framework-Asset)-other'></a> | ||
`other` [Asset](./Asset.md 'UnrealEngine.Framework.Asset') | ||
|
||
#### Returns | ||
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
### [UnrealEngine.Framework](./UnrealEngine-Framework.md 'UnrealEngine.Framework').[Asset](./Asset.md 'UnrealEngine.Framework.Asset') | ||
## Asset.Equals(object) Method | ||
Indicates equality of objects | ||
```csharp | ||
public override bool Equals(object value); | ||
``` | ||
#### Parameters | ||
<a name='UnrealEngine-Framework-Asset-Equals(object)-value'></a> | ||
`value` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') | ||
|
||
#### Returns | ||
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
### [UnrealEngine.Framework](./UnrealEngine-Framework.md 'UnrealEngine.Framework').[Asset](./Asset.md 'UnrealEngine.Framework.Asset') | ||
## Asset.GetHashCode() Method | ||
Returns a hash code for the object | ||
```csharp | ||
public override int GetHashCode(); | ||
``` | ||
#### Returns | ||
[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
### [UnrealEngine.Framework](./UnrealEngine-Framework.md 'UnrealEngine.Framework').[Asset](./Asset.md 'UnrealEngine.Framework.Asset') | ||
## Asset.IsCreated Property | ||
Returns `true` if the object is created | ||
```csharp | ||
public bool IsCreated { get; } | ||
``` | ||
#### Property Value | ||
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
### [UnrealEngine.Framework](./UnrealEngine-Framework.md 'UnrealEngine.Framework').[Asset](./Asset.md 'UnrealEngine.Framework.Asset') | ||
## Asset.Name Property | ||
Returns the name of the asset | ||
```csharp | ||
public string Name { get; } | ||
``` | ||
#### Property Value | ||
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
### [UnrealEngine.Framework](./UnrealEngine-Framework.md 'UnrealEngine.Framework').[Asset](./Asset.md 'UnrealEngine.Framework.Asset') | ||
## Asset.Path Property | ||
Returns the path to the asset | ||
```csharp | ||
public string Path { get; } | ||
``` | ||
#### Property Value | ||
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
### [UnrealEngine.Framework](./UnrealEngine-Framework.md 'UnrealEngine.Framework').[Asset](./Asset.md 'UnrealEngine.Framework.Asset') | ||
## Asset.operator ==(UnrealEngine.Framework.Asset, UnrealEngine.Framework.Asset) Operator | ||
Tests for equality between two objects | ||
```csharp | ||
public static bool operator ==(UnrealEngine.Framework.Asset left, UnrealEngine.Framework.Asset right); | ||
``` | ||
#### Parameters | ||
<a name='UnrealEngine-Framework-Asset-op_Equality(UnrealEngine-Framework-Asset_UnrealEngine-Framework-Asset)-left'></a> | ||
`left` [Asset](./Asset.md 'UnrealEngine.Framework.Asset') | ||
|
||
<a name='UnrealEngine-Framework-Asset-op_Equality(UnrealEngine-Framework-Asset_UnrealEngine-Framework-Asset)-right'></a> | ||
`right` [Asset](./Asset.md 'UnrealEngine.Framework.Asset') | ||
|
||
#### Returns | ||
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
### [UnrealEngine.Framework](./UnrealEngine-Framework.md 'UnrealEngine.Framework').[Asset](./Asset.md 'UnrealEngine.Framework.Asset') | ||
## Asset.operator !=(UnrealEngine.Framework.Asset, UnrealEngine.Framework.Asset) Operator | ||
Tests for inequality between two objects | ||
```csharp | ||
public static bool operator !=(UnrealEngine.Framework.Asset left, UnrealEngine.Framework.Asset right); | ||
``` | ||
#### Parameters | ||
<a name='UnrealEngine-Framework-Asset-op_Inequality(UnrealEngine-Framework-Asset_UnrealEngine-Framework-Asset)-left'></a> | ||
`left` [Asset](./Asset.md 'UnrealEngine.Framework.Asset') | ||
|
||
<a name='UnrealEngine-Framework-Asset-op_Inequality(UnrealEngine-Framework-Asset_UnrealEngine-Framework-Asset)-right'></a> | ||
`right` [Asset](./Asset.md 'UnrealEngine.Framework.Asset') | ||
|
||
#### Returns | ||
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
### [UnrealEngine.Framework](./UnrealEngine-Framework.md 'UnrealEngine.Framework') | ||
## Asset Struct | ||
A representation of the asset | ||
```csharp | ||
public struct Asset : | ||
IEquatable<Asset> | ||
``` | ||
Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[Asset](./Asset.md 'UnrealEngine.Framework.Asset')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') | ||
### Properties | ||
- [IsCreated](./Asset-IsCreated.md 'UnrealEngine.Framework.Asset.IsCreated') | ||
- [Name](./Asset-Name.md 'UnrealEngine.Framework.Asset.Name') | ||
- [Path](./Asset-Path.md 'UnrealEngine.Framework.Asset.Path') | ||
### Methods | ||
- [Equals(object)](./Asset-Equals(object).md 'UnrealEngine.Framework.Asset.Equals(object)') | ||
- [Equals(UnrealEngine.Framework.Asset)](./Asset-Equals(Asset).md 'UnrealEngine.Framework.Asset.Equals(UnrealEngine.Framework.Asset)') | ||
- [GetHashCode()](./Asset-GetHashCode().md 'UnrealEngine.Framework.Asset.GetHashCode()') | ||
### Operators | ||
- [operator ==(UnrealEngine.Framework.Asset, UnrealEngine.Framework.Asset)](./Asset-op_Equality(Asset_Asset).md 'UnrealEngine.Framework.Asset.op_Equality(UnrealEngine.Framework.Asset, UnrealEngine.Framework.Asset)') | ||
- [operator !=(UnrealEngine.Framework.Asset, UnrealEngine.Framework.Asset)](./Asset-op_Inequality(Asset_Asset).md 'UnrealEngine.Framework.Asset.op_Inequality(UnrealEngine.Framework.Asset, UnrealEngine.Framework.Asset)') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
### [UnrealEngine.Framework](./UnrealEngine-Framework.md 'UnrealEngine.Framework').[AssetRegistry](./AssetRegistry.md 'UnrealEngine.Framework.AssetRegistry') | ||
## AssetRegistry() Constructor | ||
Initializes a new instance of the asset registry | ||
```csharp | ||
public AssetRegistry(); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
### [UnrealEngine.Framework](./UnrealEngine-Framework.md 'UnrealEngine.Framework').[AssetRegistry](./AssetRegistry.md 'UnrealEngine.Framework.AssetRegistry') | ||
## AssetRegistry.Equals(UnrealEngine.Framework.AssetRegistry) Method | ||
Indicates equality of objects | ||
```csharp | ||
public bool Equals(UnrealEngine.Framework.AssetRegistry other); | ||
``` | ||
#### Parameters | ||
<a name='UnrealEngine-Framework-AssetRegistry-Equals(UnrealEngine-Framework-AssetRegistry)-other'></a> | ||
`other` [AssetRegistry](./AssetRegistry.md 'UnrealEngine.Framework.AssetRegistry') | ||
|
||
#### Returns | ||
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') |
19 changes: 19 additions & 0 deletions
19
API/AssetRegistry-ForEachAsset(Action-Asset-_string_bool_bool).md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
### [UnrealEngine.Framework](./UnrealEngine-Framework.md 'UnrealEngine.Framework').[AssetRegistry](./AssetRegistry.md 'UnrealEngine.Framework.AssetRegistry') | ||
## AssetRegistry.ForEachAsset(System.Action<UnrealEngine.Framework.Asset>, string, bool, bool) Method | ||
Performs the specified action on each asset if any | ||
```csharp | ||
public void ForEachAsset(System.Action<UnrealEngine.Framework.Asset> action, string path, bool recursive=false, bool includeOnlyOnDiskAssets=false); | ||
``` | ||
#### Parameters | ||
<a name='UnrealEngine-Framework-AssetRegistry-ForEachAsset(System-Action-UnrealEngine-Framework-Asset-_string_bool_bool)-action'></a> | ||
`action` [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[Asset](./Asset.md 'UnrealEngine.Framework.Asset')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') | ||
|
||
<a name='UnrealEngine-Framework-AssetRegistry-ForEachAsset(System-Action-UnrealEngine-Framework-Asset-_string_bool_bool)-path'></a> | ||
`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') | ||
|
||
<a name='UnrealEngine-Framework-AssetRegistry-ForEachAsset(System-Action-UnrealEngine-Framework-Asset-_string_bool_bool)-recursive'></a> | ||
`recursive` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') | ||
|
||
<a name='UnrealEngine-Framework-AssetRegistry-ForEachAsset(System-Action-UnrealEngine-Framework-Asset-_string_bool_bool)-includeOnlyOnDiskAssets'></a> | ||
`includeOnlyOnDiskAssets` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
### [UnrealEngine.Framework](./UnrealEngine-Framework.md 'UnrealEngine.Framework').[AssetRegistry](./AssetRegistry.md 'UnrealEngine.Framework.AssetRegistry') | ||
## AssetRegistry.GetHashCode() Method | ||
Returns a hash code for the object | ||
```csharp | ||
public override int GetHashCode(); | ||
``` | ||
#### Returns | ||
[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
### [UnrealEngine.Framework](./UnrealEngine-Framework.md 'UnrealEngine.Framework').[AssetRegistry](./AssetRegistry.md 'UnrealEngine.Framework.AssetRegistry') | ||
## AssetRegistry.HasAssets(string, bool) Method | ||
Checks whether the given path contain assets, optionally testing sub-paths | ||
```csharp | ||
public bool HasAssets(string path, bool recursive=false); | ||
``` | ||
#### Parameters | ||
<a name='UnrealEngine-Framework-AssetRegistry-HasAssets(string_bool)-path'></a> | ||
`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') | ||
|
||
<a name='UnrealEngine-Framework-AssetRegistry-HasAssets(string_bool)-recursive'></a> | ||
`recursive` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') | ||
|
||
#### Returns | ||
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
### [UnrealEngine.Framework](./UnrealEngine-Framework.md 'UnrealEngine.Framework').[AssetRegistry](./AssetRegistry.md 'UnrealEngine.Framework.AssetRegistry') | ||
## AssetRegistry.IsCreated Property | ||
Returns `true` if the object is created | ||
```csharp | ||
public bool IsCreated { get; } | ||
``` | ||
#### Property Value | ||
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
### [UnrealEngine.Framework](./UnrealEngine-Framework.md 'UnrealEngine.Framework') | ||
## AssetRegistry Class | ||
An asset registry | ||
```csharp | ||
public class AssetRegistry : | ||
IEquatable<AssetRegistry> | ||
``` | ||
Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 AssetRegistry | ||
|
||
Implements [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[AssetRegistry](./AssetRegistry.md 'UnrealEngine.Framework.AssetRegistry')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') | ||
### Constructors | ||
- [AssetRegistry()](./AssetRegistry-AssetRegistry().md 'UnrealEngine.Framework.AssetRegistry.AssetRegistry()') | ||
### Properties | ||
- [IsCreated](./AssetRegistry-IsCreated.md 'UnrealEngine.Framework.AssetRegistry.IsCreated') | ||
### Methods | ||
- [Equals(UnrealEngine.Framework.AssetRegistry)](./AssetRegistry-Equals(AssetRegistry).md 'UnrealEngine.Framework.AssetRegistry.Equals(UnrealEngine.Framework.AssetRegistry)') | ||
- [ForEachAsset(System.Action<UnrealEngine.Framework.Asset>, string, bool, bool)](./AssetRegistry-ForEachAsset(Action-Asset-_string_bool_bool).md 'UnrealEngine.Framework.AssetRegistry.ForEachAsset(System.Action<UnrealEngine.Framework.Asset>, string, bool, bool)') | ||
- [GetHashCode()](./AssetRegistry-GetHashCode().md 'UnrealEngine.Framework.AssetRegistry.GetHashCode()') | ||
- [HasAssets(string, bool)](./AssetRegistry-HasAssets(string_bool).md 'UnrealEngine.Framework.AssetRegistry.HasAssets(string, bool)') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.