TinyLifeWeb/docs/api/TinyLife.Mods.ModLoader.yml

464 lines
15 KiB
YAML
Raw Normal View History

2021-08-04 06:51:12 +02:00
### YamlMime:ManagedReference
items:
- uid: TinyLife.Mods.ModLoader
commentId: T:TinyLife.Mods.ModLoader
id: ModLoader
parent: TinyLife.Mods
children:
- TinyLife.Mods.ModLoader.GetModsFolder
- TinyLife.Mods.ModLoader.TryGetModInfo(System.String,TinyLife.Mods.ModInfo@)
langs:
- csharp
- vb
name: ModLoader
nameWithType: ModLoader
fullName: TinyLife.Mods.ModLoader
type: Class
source:
remote:
path: TinyLife/Mods/ModLoader.cs
2023-03-30 18:07:55 +02:00
branch: main
2021-11-26 23:42:22 +01:00
repo: https://git.ellpeck.de/Ellpeck/TinyLife
2021-08-04 06:51:12 +02:00
id: ModLoader
2022-03-09 16:13:05 +01:00
path: ../TinyLife/Mods/ModLoader.cs
2022-09-17 12:33:21 +02:00
startLine: 24
2021-08-04 06:51:12 +02:00
assemblies:
- Tiny Life
namespace: TinyLife.Mods
summary: "\nThe mod loader loads <xref href=\"TinyLife.Mods.Mod\" data-throw-if-not-resolved=\"false\"></xref> instances from the <xref href=\"TinyLife.Mods.ModLoader.GetModsFolder\" data-throw-if-not-resolved=\"false\"></xref>.\n"
example: []
syntax:
content: public static class ModLoader
content.vb: Public Module ModLoader
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
- uid: TinyLife.Mods.ModLoader.TryGetModInfo(System.String,TinyLife.Mods.ModInfo@)
commentId: M:TinyLife.Mods.ModLoader.TryGetModInfo(System.String,TinyLife.Mods.ModInfo@)
id: TryGetModInfo(System.String,TinyLife.Mods.ModInfo@)
parent: TinyLife.Mods.ModLoader
langs:
- csharp
- vb
2023-03-30 18:07:55 +02:00
name: TryGetModInfo(string, out ModInfo)
nameWithType: ModLoader.TryGetModInfo(string, out ModInfo)
fullName: TinyLife.Mods.ModLoader.TryGetModInfo(string, out TinyLife.Mods.ModInfo)
2021-08-04 06:51:12 +02:00
type: Method
source:
remote:
path: TinyLife/Mods/ModLoader.cs
2023-03-30 18:07:55 +02:00
branch: main
2021-11-26 23:42:22 +01:00
repo: https://git.ellpeck.de/Ellpeck/TinyLife
2021-08-04 06:51:12 +02:00
id: TryGetModInfo
2022-03-09 16:13:05 +01:00
path: ../TinyLife/Mods/ModLoader.cs
2022-09-17 12:33:21 +02:00
startLine: 36
2021-08-04 06:51:12 +02:00
assemblies:
- Tiny Life
namespace: TinyLife.Mods
summary: "\nThis method can be used to gather a <xref href=\"TinyLife.Mods.ModInfo\" data-throw-if-not-resolved=\"false\"></xref> for a mod that is currently loaded with the given id.\nIf no mod with that id is currently loaded, this method returns false and assigns null to <xref href=\"TinyLife.Mods.ModInfo\" data-throw-if-not-resolved=\"false\"></xref>.\n"
example: []
syntax:
content: public static bool TryGetModInfo(string id, out ModInfo info)
parameters:
- id: id
type: System.String
description: The id of the mod to get
- id: info
type: TinyLife.Mods.ModInfo
description: The info that will be returned about the mod
return:
type: System.Boolean
description: Whether or not the mod was found to be loaded
2023-03-30 18:07:55 +02:00
content.vb: Public Shared Function TryGetModInfo(id As String, info As ModInfo) As Boolean
2021-08-04 06:51:12 +02:00
overload: TinyLife.Mods.ModLoader.TryGetModInfo*
2023-03-30 18:07:55 +02:00
nameWithType.vb: ModLoader.TryGetModInfo(String, ModInfo)
fullName.vb: TinyLife.Mods.ModLoader.TryGetModInfo(String, TinyLife.Mods.ModInfo)
name.vb: TryGetModInfo(String, ModInfo)
2021-08-04 06:51:12 +02:00
- uid: TinyLife.Mods.ModLoader.GetModsFolder
commentId: M:TinyLife.Mods.ModLoader.GetModsFolder
id: GetModsFolder
parent: TinyLife.Mods.ModLoader
langs:
- csharp
- vb
name: GetModsFolder()
nameWithType: ModLoader.GetModsFolder()
fullName: TinyLife.Mods.ModLoader.GetModsFolder()
type: Method
source:
remote:
path: TinyLife/Mods/ModLoader.cs
2023-03-30 18:07:55 +02:00
branch: main
2021-11-26 23:42:22 +01:00
repo: https://git.ellpeck.de/Ellpeck/TinyLife
2021-08-04 06:51:12 +02:00
id: GetModsFolder
2022-03-09 16:13:05 +01:00
path: ../TinyLife/Mods/ModLoader.cs
2022-09-17 12:33:21 +02:00
startLine: 44
2021-08-04 06:51:12 +02:00
assemblies:
- Tiny Life
namespace: TinyLife.Mods
summary: "\nReturns a <xref href=\"System.IO.DirectoryInfo\" data-throw-if-not-resolved=\"false\"></xref> pointing to the directory that mods should be put into and loaded from\n"
example: []
syntax:
content: public static DirectoryInfo GetModsFolder()
return:
type: System.IO.DirectoryInfo
description: The mod directory
2023-03-30 18:07:55 +02:00
content.vb: Public Shared Function GetModsFolder() As DirectoryInfo
2021-08-04 06:51:12 +02:00
overload: TinyLife.Mods.ModLoader.GetModsFolder*
references:
- uid: TinyLife.Mods.Mod
commentId: T:TinyLife.Mods.Mod
parent: TinyLife.Mods
name: Mod
nameWithType: Mod
fullName: TinyLife.Mods.Mod
- uid: TinyLife.Mods.ModLoader.GetModsFolder
commentId: M:TinyLife.Mods.ModLoader.GetModsFolder
2023-03-30 18:07:55 +02:00
name: GetModsFolder()
nameWithType: ModLoader.GetModsFolder()
fullName: TinyLife.Mods.ModLoader.GetModsFolder()
spec.csharp:
- uid: TinyLife.Mods.ModLoader.GetModsFolder
name: GetModsFolder
- name: (
- name: )
spec.vb:
- uid: TinyLife.Mods.ModLoader.GetModsFolder
name: GetModsFolder
- name: (
- name: )
2021-08-04 06:51:12 +02:00
- uid: TinyLife.Mods
commentId: N:TinyLife.Mods
name: TinyLife.Mods
nameWithType: TinyLife.Mods
fullName: TinyLife.Mods
2023-03-30 18:07:55 +02:00
spec.csharp:
- uid: TinyLife
name: TinyLife
- name: .
- uid: TinyLife.Mods
name: Mods
spec.vb:
- uid: TinyLife
name: TinyLife
- name: .
- uid: TinyLife.Mods
name: Mods
2021-08-04 06:51:12 +02:00
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
2021-08-04 06:51:12 +02:00
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
2021-08-04 06:51:12 +02:00
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
2021-08-04 06:51:12 +02:00
- name: (
- uid: System.Object
2023-03-30 18:07:55 +02:00
name: object
2021-08-04 06:51:12 +02:00
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
2021-08-04 06:51:12 +02:00
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
2021-08-04 06:51:12 +02:00
- name: (
- uid: System.Object
name: Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
2021-08-04 06:51:12 +02:00
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
2021-08-04 06:51:12 +02:00
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
2021-08-04 06:51:12 +02:00
- name: (
- uid: System.Object
2023-03-30 18:07:55 +02:00
name: object
2021-08-04 06:51:12 +02:00
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
2021-08-04 06:51:12 +02:00
- uid: System.Object
2023-03-30 18:07:55 +02:00
name: object
2021-08-04 06:51:12 +02:00
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
2021-08-04 06:51:12 +02:00
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
2021-08-04 06:51:12 +02:00
- name: (
- uid: System.Object
name: Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
2021-08-04 06:51:12 +02:00
- uid: System.Object
name: Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
2021-08-04 06:51:12 +02:00
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
2021-08-04 06:51:12 +02:00
name: GetHashCode()
2023-03-30 18:07:55 +02:00
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
2021-08-04 06:51:12 +02:00
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
2021-08-04 06:51:12 +02:00
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
2021-08-04 06:51:12 +02:00
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
2021-08-04 06:51:12 +02:00
name: GetType()
2023-03-30 18:07:55 +02:00
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
2021-08-04 06:51:12 +02:00
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
2021-08-04 06:51:12 +02:00
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
2021-08-04 06:51:12 +02:00
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
2021-08-04 06:51:12 +02:00
name: MemberwiseClone()
2023-03-30 18:07:55 +02:00
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
2021-08-04 06:51:12 +02:00
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
2021-08-04 06:51:12 +02:00
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
2021-08-04 06:51:12 +02:00
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
2021-08-04 06:51:12 +02:00
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
2021-08-04 06:51:12 +02:00
- name: (
- uid: System.Object
2023-03-30 18:07:55 +02:00
name: object
2021-08-04 06:51:12 +02:00
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
2021-08-04 06:51:12 +02:00
- uid: System.Object
2023-03-30 18:07:55 +02:00
name: object
2021-08-04 06:51:12 +02:00
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
2021-08-04 06:51:12 +02:00
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
2021-08-04 06:51:12 +02:00
- name: (
- uid: System.Object
name: Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
2021-08-04 06:51:12 +02:00
- uid: System.Object
name: Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object
2021-08-04 06:51:12 +02:00
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
2021-08-04 06:51:12 +02:00
name: ToString()
2023-03-30 18:07:55 +02:00
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
2021-08-04 06:51:12 +02:00
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
2021-08-04 06:51:12 +02:00
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
2021-08-04 06:51:12 +02:00
- name: (
- name: )
- uid: System
commentId: N:System
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system
2021-08-04 06:51:12 +02:00
name: System
nameWithType: System
fullName: System
- uid: TinyLife.Mods.ModInfo
commentId: T:TinyLife.Mods.ModInfo
parent: TinyLife.Mods
name: ModInfo
nameWithType: ModInfo
fullName: TinyLife.Mods.ModInfo
- uid: TinyLife.Mods.ModLoader.TryGetModInfo*
commentId: Overload:TinyLife.Mods.ModLoader.TryGetModInfo
name: TryGetModInfo
nameWithType: ModLoader.TryGetModInfo
fullName: TinyLife.Mods.ModLoader.TryGetModInfo
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
2021-08-04 06:51:12 +02:00
- uid: System.Boolean
commentId: T:System.Boolean
parent: System
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.boolean
name: bool
nameWithType: bool
fullName: bool
nameWithType.vb: Boolean
fullName.vb: Boolean
name.vb: Boolean
2021-08-04 06:51:12 +02:00
- uid: System.IO.DirectoryInfo
commentId: T:System.IO.DirectoryInfo
parent: System.IO
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.io.directoryinfo
2021-08-04 06:51:12 +02:00
name: DirectoryInfo
nameWithType: DirectoryInfo
fullName: System.IO.DirectoryInfo
- uid: TinyLife.Mods.ModLoader.GetModsFolder*
commentId: Overload:TinyLife.Mods.ModLoader.GetModsFolder
name: GetModsFolder
nameWithType: ModLoader.GetModsFolder
fullName: TinyLife.Mods.ModLoader.GetModsFolder
- uid: System.IO
commentId: N:System.IO
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system
2021-08-04 06:51:12 +02:00
name: System.IO
nameWithType: System.IO
fullName: System.IO
2023-03-30 18:07:55 +02:00
spec.csharp:
- uid: System
name: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
- name: .
- uid: System.IO
name: IO
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.io
spec.vb:
- uid: System
name: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
- name: .
- uid: System.IO
name: IO
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.io