TinyLifeWeb/docs/api/TinyLife.Uis.InGameUi.yml
2023-12-16 12:54:23 +01:00

704 lines
21 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: TinyLife.Uis.InGameUi
commentId: T:TinyLife.Uis.InGameUi
id: InGameUi
parent: TinyLife.Uis
children:
- TinyLife.Uis.InGameUi.BuildContent
- TinyLife.Uis.InGameUi.BuildZoom
- TinyLife.Uis.InGameUi.Main
- TinyLife.Uis.InGameUi.OnInitialized
- TinyLife.Uis.InGameUi.OnModesPanelInitialized
- TinyLife.Uis.InGameUi.OnTopRightInitialized
langs:
- csharp
- vb
name: InGameUi
nameWithType: InGameUi
fullName: TinyLife.Uis.InGameUi
type: Class
source:
remote:
path: TinyLife/Uis/InGameUi.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: InGameUi
path: ../TinyLife/Uis/InGameUi.cs
startLine: 21
assemblies:
- Tiny Life
namespace: TinyLife.Uis
summary: "\nThis class holds a set of ways to interact with the game's in-game ui.\n"
example: []
syntax:
content: public static class InGameUi
content.vb: Public Module InGameUi
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.Uis.InGameUi.OnModesPanelInitialized
commentId: E:TinyLife.Uis.InGameUi.OnModesPanelInitialized
id: OnModesPanelInitialized
parent: TinyLife.Uis.InGameUi
langs:
- csharp
- vb
name: OnModesPanelInitialized
nameWithType: InGameUi.OnModesPanelInitialized
fullName: TinyLife.Uis.InGameUi.OnModesPanelInitialized
type: Event
source:
remote:
path: TinyLife/Uis/InGameUi.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: OnModesPanelInitialized
path: ../TinyLife/Uis/InGameUi.cs
startLine: 29
assemblies:
- Tiny Life
namespace: TinyLife.Uis
summary: "\nAn event that is invoked when the in-game ui's modes panel is initialized.\nThe modes panel is situated in the top right, and contains buttons for build mode, opening notifications, switching the viewed map, and so on.\n"
example: []
syntax:
content: public static event Action<Panel> OnModesPanelInitialized
return:
type: System.Action{MLEM.Ui.Elements.Panel}
content.vb: Public Shared Event OnModesPanelInitialized As Action(Of Panel)
- uid: TinyLife.Uis.InGameUi.OnTopRightInitialized
commentId: E:TinyLife.Uis.InGameUi.OnTopRightInitialized
id: OnTopRightInitialized
parent: TinyLife.Uis.InGameUi
langs:
- csharp
- vb
name: OnTopRightInitialized
nameWithType: InGameUi.OnTopRightInitialized
fullName: TinyLife.Uis.InGameUi.OnTopRightInitialized
type: Event
source:
remote:
path: TinyLife/Uis/InGameUi.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: OnTopRightInitialized
path: ../TinyLife/Uis/InGameUi.cs
startLine: 34
assemblies:
- Tiny Life
namespace: TinyLife.Uis
summary: "\nAn event that is invoked when the in-game ui&apos;s top right panel is initialized.\nThe top-right panel contains the game&apos;s current time and day, money amount, as well as the panel received in <xref href=\"TinyLife.Uis.InGameUi.OnModesPanelInitialized\" data-throw-if-not-resolved=\"false\"></xref>.\n"
example: []
syntax:
content: public static event Action<Group> OnTopRightInitialized
return:
type: System.Action{MLEM.Ui.Elements.Group}
content.vb: Public Shared Event OnTopRightInitialized As Action(Of Group)
- uid: TinyLife.Uis.InGameUi.OnInitialized
commentId: E:TinyLife.Uis.InGameUi.OnInitialized
id: OnInitialized
parent: TinyLife.Uis.InGameUi
langs:
- csharp
- vb
name: OnInitialized
nameWithType: InGameUi.OnInitialized
fullName: TinyLife.Uis.InGameUi.OnInitialized
type: Event
source:
remote:
path: TinyLife/Uis/InGameUi.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: OnInitialized
path: ../TinyLife/Uis/InGameUi.cs
startLine: 38
assemblies:
- Tiny Life
namespace: TinyLife.Uis
summary: "\nAn event that is invoked when the in-game ui is initialized after entering a save.\n"
example: []
syntax:
content: public static event Action OnInitialized
return:
type: System.Action
content.vb: Public Shared Event OnInitialized As Action
- uid: TinyLife.Uis.InGameUi.Main
commentId: P:TinyLife.Uis.InGameUi.Main
id: Main
parent: TinyLife.Uis.InGameUi
langs:
- csharp
- vb
name: Main
nameWithType: InGameUi.Main
fullName: TinyLife.Uis.InGameUi.Main
type: Property
source:
remote:
path: TinyLife/Uis/InGameUi.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Main
path: ../TinyLife/Uis/InGameUi.cs
startLine: 43
assemblies:
- Tiny Life
namespace: TinyLife.Uis
summary: "\nThe main element that all other in-game ui elements are added to.\n"
example: []
syntax:
content: public static Group Main { get; }
parameters: []
return:
type: MLEM.Ui.Elements.Group
content.vb: Public Shared Property Main As Group
overload: TinyLife.Uis.InGameUi.Main*
- uid: TinyLife.Uis.InGameUi.BuildContent
commentId: P:TinyLife.Uis.InGameUi.BuildContent
id: BuildContent
parent: TinyLife.Uis.InGameUi
langs:
- csharp
- vb
name: BuildContent
nameWithType: InGameUi.BuildContent
fullName: TinyLife.Uis.InGameUi.BuildContent
type: Property
source:
remote:
path: TinyLife/Uis/InGameUi.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: BuildContent
path: ../TinyLife/Uis/InGameUi.cs
startLine: 47
assemblies:
- Tiny Life
namespace: TinyLife.Uis
summary: "\nThe build content panel that is passed into <xref href=\"TinyLife.Tools.Tool.InitBuildModeUi(MLEM.Ui.Elements.Panel%2cMLEM.Ui.Elements.Panel)\" data-throw-if-not-resolved=\"false\"></xref>.\n"
example: []
syntax:
content: public static Panel BuildContent { get; }
parameters: []
return:
type: MLEM.Ui.Elements.Panel
content.vb: Public Shared Property BuildContent As Panel
overload: TinyLife.Uis.InGameUi.BuildContent*
- uid: TinyLife.Uis.InGameUi.BuildZoom
commentId: P:TinyLife.Uis.InGameUi.BuildZoom
id: BuildZoom
parent: TinyLife.Uis.InGameUi
langs:
- csharp
- vb
name: BuildZoom
nameWithType: InGameUi.BuildZoom
fullName: TinyLife.Uis.InGameUi.BuildZoom
type: Property
source:
remote:
path: TinyLife/Uis/InGameUi.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: BuildZoom
path: ../TinyLife/Uis/InGameUi.cs
startLine: 51
assemblies:
- Tiny Life
namespace: TinyLife.Uis
summary: "\nThe build zoom panel that is passed into <xref href=\"TinyLife.Tools.Tool.InitBuildModeUi(MLEM.Ui.Elements.Panel%2cMLEM.Ui.Elements.Panel)\" data-throw-if-not-resolved=\"false\"></xref>.\n"
example: []
syntax:
content: public static Panel BuildZoom { get; }
parameters: []
return:
type: MLEM.Ui.Elements.Panel
content.vb: Public Shared Property BuildZoom As Panel
overload: TinyLife.Uis.InGameUi.BuildZoom*
references:
- uid: TinyLife.Uis
commentId: N:TinyLife.Uis
name: TinyLife.Uis
nameWithType: TinyLife.Uis
fullName: TinyLife.Uis
spec.csharp:
- uid: TinyLife
name: TinyLife
- name: .
- uid: TinyLife.Uis
name: Uis
spec.vb:
- uid: TinyLife
name: TinyLife
- name: .
- uid: TinyLife.Uis
name: Uis
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
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)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
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)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
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)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: System.Action{MLEM.Ui.Elements.Panel}
commentId: T:System.Action{MLEM.Ui.Elements.Panel}
parent: System
definition: System.Action`1
href: https://learn.microsoft.com/dotnet/api/system.action-1
name: Action<Panel>
nameWithType: Action<Panel>
fullName: System.Action<MLEM.Ui.Elements.Panel>
nameWithType.vb: Action(Of Panel)
fullName.vb: System.Action(Of MLEM.Ui.Elements.Panel)
name.vb: Action(Of Panel)
spec.csharp:
- uid: System.Action`1
name: Action
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-1
- name: <
- uid: MLEM.Ui.Elements.Panel
name: Panel
isExternal: true
- name: '>'
spec.vb:
- uid: System.Action`1
name: Action
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-1
- name: (
- name: Of
- name: " "
- uid: MLEM.Ui.Elements.Panel
name: Panel
isExternal: true
- name: )
- uid: System.Action`1
commentId: T:System.Action`1
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-1
name: Action<T>
nameWithType: Action<T>
fullName: System.Action<T>
nameWithType.vb: Action(Of T)
fullName.vb: System.Action(Of T)
name.vb: Action(Of T)
spec.csharp:
- uid: System.Action`1
name: Action
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-1
- name: <
- name: T
- name: '>'
spec.vb:
- uid: System.Action`1
name: Action
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-1
- name: (
- name: Of
- name: " "
- name: T
- name: )
- uid: TinyLife.Uis.InGameUi.OnModesPanelInitialized
commentId: E:TinyLife.Uis.InGameUi.OnModesPanelInitialized
name: OnModesPanelInitialized
nameWithType: InGameUi.OnModesPanelInitialized
fullName: TinyLife.Uis.InGameUi.OnModesPanelInitialized
- uid: System.Action{MLEM.Ui.Elements.Group}
commentId: T:System.Action{MLEM.Ui.Elements.Group}
parent: System
definition: System.Action`1
href: https://learn.microsoft.com/dotnet/api/system.action-1
name: Action<Group>
nameWithType: Action<Group>
fullName: System.Action<MLEM.Ui.Elements.Group>
nameWithType.vb: Action(Of Group)
fullName.vb: System.Action(Of MLEM.Ui.Elements.Group)
name.vb: Action(Of Group)
spec.csharp:
- uid: System.Action`1
name: Action
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-1
- name: <
- uid: MLEM.Ui.Elements.Group
name: Group
isExternal: true
- name: '>'
spec.vb:
- uid: System.Action`1
name: Action
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-1
- name: (
- name: Of
- name: " "
- uid: MLEM.Ui.Elements.Group
name: Group
isExternal: true
- name: )
- uid: System.Action
commentId: T:System.Action
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action
name: Action
nameWithType: Action
fullName: System.Action
- uid: TinyLife.Uis.InGameUi.Main*
commentId: Overload:TinyLife.Uis.InGameUi.Main
name: Main
nameWithType: InGameUi.Main
fullName: TinyLife.Uis.InGameUi.Main
- uid: MLEM.Ui.Elements.Group
commentId: T:MLEM.Ui.Elements.Group
parent: MLEM.Ui.Elements
isExternal: true
name: Group
nameWithType: Group
fullName: MLEM.Ui.Elements.Group
- uid: MLEM.Ui.Elements
commentId: N:MLEM.Ui.Elements
isExternal: true
name: MLEM.Ui.Elements
nameWithType: MLEM.Ui.Elements
fullName: MLEM.Ui.Elements
spec.csharp:
- uid: MLEM
name: MLEM
isExternal: true
- name: .
- uid: MLEM.Ui
name: Ui
isExternal: true
- name: .
- uid: MLEM.Ui.Elements
name: Elements
isExternal: true
spec.vb:
- uid: MLEM
name: MLEM
isExternal: true
- name: .
- uid: MLEM.Ui
name: Ui
isExternal: true
- name: .
- uid: MLEM.Ui.Elements
name: Elements
isExternal: true
- uid: TinyLife.Tools.Tool.InitBuildModeUi(MLEM.Ui.Elements.Panel,MLEM.Ui.Elements.Panel)
commentId: M:TinyLife.Tools.Tool.InitBuildModeUi(MLEM.Ui.Elements.Panel,MLEM.Ui.Elements.Panel)
parent: TinyLife.Tools.Tool
isExternal: true
name: InitBuildModeUi(Panel, Panel)
nameWithType: Tool.InitBuildModeUi(Panel, Panel)
fullName: TinyLife.Tools.Tool.InitBuildModeUi(MLEM.Ui.Elements.Panel, MLEM.Ui.Elements.Panel)
spec.csharp:
- uid: TinyLife.Tools.Tool.InitBuildModeUi(MLEM.Ui.Elements.Panel,MLEM.Ui.Elements.Panel)
name: InitBuildModeUi
- name: (
- uid: MLEM.Ui.Elements.Panel
name: Panel
isExternal: true
- name: ','
- name: " "
- uid: MLEM.Ui.Elements.Panel
name: Panel
isExternal: true
- name: )
spec.vb:
- uid: TinyLife.Tools.Tool.InitBuildModeUi(MLEM.Ui.Elements.Panel,MLEM.Ui.Elements.Panel)
name: InitBuildModeUi
- name: (
- uid: MLEM.Ui.Elements.Panel
name: Panel
isExternal: true
- name: ','
- name: " "
- uid: MLEM.Ui.Elements.Panel
name: Panel
isExternal: true
- name: )
- uid: TinyLife.Uis.InGameUi.BuildContent*
commentId: Overload:TinyLife.Uis.InGameUi.BuildContent
name: BuildContent
nameWithType: InGameUi.BuildContent
fullName: TinyLife.Uis.InGameUi.BuildContent
- uid: MLEM.Ui.Elements.Panel
commentId: T:MLEM.Ui.Elements.Panel
parent: MLEM.Ui.Elements
isExternal: true
name: Panel
nameWithType: Panel
fullName: MLEM.Ui.Elements.Panel
- uid: TinyLife.Tools.Tool
commentId: T:TinyLife.Tools.Tool
parent: TinyLife.Tools
name: Tool
nameWithType: Tool
fullName: TinyLife.Tools.Tool
- uid: TinyLife.Tools
commentId: N:TinyLife.Tools
name: TinyLife.Tools
nameWithType: TinyLife.Tools
fullName: TinyLife.Tools
spec.csharp:
- uid: TinyLife
name: TinyLife
- name: .
- uid: TinyLife.Tools
name: Tools
spec.vb:
- uid: TinyLife
name: TinyLife
- name: .
- uid: TinyLife.Tools
name: Tools
- uid: TinyLife.Uis.InGameUi.BuildZoom*
commentId: Overload:TinyLife.Uis.InGameUi.BuildZoom
name: BuildZoom
nameWithType: InGameUi.BuildZoom
fullName: TinyLife.Uis.InGameUi.BuildZoom