Ellpeck/TinyLifeWeb
1
0
Fork 0
mirror of https://github.com/Ellpeck/TinyLifeWeb.git synced 2024-11-29 22:08:34 +01:00
Code Issues Projects Releases Wiki Activity
TinyLifeWeb/docs/api/TinyLife.Uis.Menus.yml
Ell bb8b07bc34 0.19.1
2022-01-08 12:41:09 +01:00

529 lines
16 KiB
YAML
Raw Blame History

### YamlMime:ManagedReference
items:
- uid: TinyLife.Uis.Menus
commentId: T:TinyLife.Uis.Menus
id: Menus
parent: TinyLife.Uis
children:
- TinyLife.Uis.Menus.Transition(System.Action,System.Action,TinyLife.Uis.Menus.TransitionType,TinyLife.Uis.Menus.TransitionType,System.Single,System.Single,System.Single,System.Nullable{Microsoft.Xna.Framework.Color})
langs:
- csharp
- vb
name: Menus
nameWithType: Menus
fullName: TinyLife.Uis.Menus
type: Class
source:
remote:
path: TinyLife/Uis/Menus.cs
branch: master
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Menus
path: Uis/Menus.cs
startLine: 36
assemblies:
- Tiny Life
namespace: TinyLife.Uis
summary: "\nA set of static methods to deal with <xref href=\"MLEM.Ui\" data-throw-if-not-resolved=\"false\"></xref> and in-game menus\n"
example: []
syntax:
content: public static class Menus
content.vb: Public Module Menus
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
modifiers.csharp:
- public
- static
- class
modifiers.vb:
- Public
- Module
- uid: TinyLife.Uis.Menus.Transition(System.Action,System.Action,TinyLife.Uis.Menus.TransitionType,TinyLife.Uis.Menus.TransitionType,System.Single,System.Single,System.Single,System.Nullable{Microsoft.Xna.Framework.Color})
commentId: M:TinyLife.Uis.Menus.Transition(System.Action,System.Action,TinyLife.Uis.Menus.TransitionType,TinyLife.Uis.Menus.TransitionType,System.Single,System.Single,System.Single,System.Nullable{Microsoft.Xna.Framework.Color})
id: Transition(System.Action,System.Action,TinyLife.Uis.Menus.TransitionType,TinyLife.Uis.Menus.TransitionType,System.Single,System.Single,System.Single,System.Nullable{Microsoft.Xna.Framework.Color})
parent: TinyLife.Uis.Menus
langs:
- csharp
- vb
name: Transition(Action, Action, Menus.TransitionType, Menus.TransitionType, Single, Single, Single, Nullable<Color>)
nameWithType: Menus.Transition(Action, Action, Menus.TransitionType, Menus.TransitionType, Single, Single, Single, Nullable<Color>)
fullName: TinyLife.Uis.Menus.Transition(System.Action, System.Action, TinyLife.Uis.Menus.TransitionType, TinyLife.Uis.Menus.TransitionType, System.Single, System.Single, System.Single, System.Nullable<Microsoft.Xna.Framework.Color>)
type: Method
source:
remote:
path: TinyLife/Uis/Menus.cs
branch: master
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Transition
path: Uis/Menus.cs
startLine: 58
assemblies:
- Tiny Life
namespace: TinyLife.Uis
summary: "\nDisplays a screen transition that includes a fade out, an <code data-dev-comment-type=\"paramref\" class=\"paramref\">inbetween</code> action, followed by a fade back in and an <code data-dev-comment-type=\"paramref\" class=\"paramref\">after</code> action.\n"
example: []
syntax:
content: public static void Transition(Action inbetween = null, Action after = null, Menus.TransitionType outType = Menus.TransitionType.Swipe, Menus.TransitionType inType = Menus.TransitionType.Swipe, float outSpeed = 0.05F, float inSpeed = 0.05F, float waitInbetween = 0.15F, Color? color = null)
parameters:
- id: inbetween
type: System.Action
description: The action that is invoked while the screen is faded out, or null to invoke no action.
- id: after
type: System.Action
description: The action that is invoked after the full fade routine completes, or null to invoke no action.
- id: outType
type: TinyLife.Uis.Menus.TransitionType
description: The <xref href="TinyLife.Uis.Menus.TransitionType" data-throw-if-not-resolved="false"></xref> used for fading out.
- id: inType
type: TinyLife.Uis.Menus.TransitionType
description: The <xref href="TinyLife.Uis.Menus.TransitionType" data-throw-if-not-resolved="false"></xref> used for fading in.
- id: outSpeed
type: System.Single
description: The speed with which <code data-dev-comment-type="paramref" class="paramref">outType</code> is displayed per frame.
- id: inSpeed
type: System.Single
description: The speed with which <code data-dev-comment-type="paramref" class="paramref">inType</code> is displayed per frame.
- id: waitInbetween
type: System.Single
description: The amount of time to wait while the screen is faded out.
- id: color
type: System.Nullable{Microsoft.Xna.Framework.Color}
description: The color that the fade should have, or null to use black.
content.vb: Public Shared Sub Transition(inbetween As Action = Nothing, after As Action = Nothing, outType As Menus.TransitionType = Menus.TransitionType.Swipe, inType As Menus.TransitionType = Menus.TransitionType.Swipe, outSpeed As Single = 0.05F, inSpeed As Single = 0.05F, waitInbetween As Single = 0.15F, color As Color? = Nothing)
overload: TinyLife.Uis.Menus.Transition*
exceptions:
- type: System.InvalidOperationException
commentId: T:System.InvalidOperationException
description: Thrown when a fade is already happening when this method is called.
nameWithType.vb: Menus.Transition(Action, Action, Menus.TransitionType, Menus.TransitionType, Single, Single, Single, Nullable(Of Color))
modifiers.csharp:
- public
- static
modifiers.vb:
- Public
- Shared
fullName.vb: TinyLife.Uis.Menus.Transition(System.Action, System.Action, TinyLife.Uis.Menus.TransitionType, TinyLife.Uis.Menus.TransitionType, System.Single, System.Single, System.Single, System.Nullable(Of Microsoft.Xna.Framework.Color))
name.vb: Transition(Action, Action, Menus.TransitionType, Menus.TransitionType, Single, Single, Single, Nullable(Of Color))
references:
- uid: MLEM.Ui
commentId: N:MLEM.Ui
isExternal: true
name: MLEM.Ui
nameWithType: MLEM.Ui
fullName: MLEM.Ui
- uid: TinyLife.Uis
commentId: N:TinyLife.Uis
name: TinyLife.Uis
nameWithType: TinyLife.Uis
fullName: TinyLife.Uis
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
name: Object
nameWithType: Object
fullName: System.Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
name: Equals(Object)
nameWithType: Object.Equals(Object)
fullName: System.Object.Equals(System.Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
nameWithType: Object.Equals
fullName: System.Object.Equals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
nameWithType: Object.Equals
fullName: System.Object.Equals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
name: Equals(Object, Object)
nameWithType: Object.Equals(Object, Object)
fullName: System.Object.Equals(System.Object, System.Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
nameWithType: Object.Equals
fullName: System.Object.Equals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: ', '
nameWithType: ', '
fullName: ', '
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
nameWithType: Object.Equals
fullName: System.Object.Equals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: ', '
nameWithType: ', '
fullName: ', '
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
name: GetHashCode()
nameWithType: Object.GetHashCode()
fullName: System.Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
nameWithType: Object.GetHashCode
fullName: System.Object.GetHashCode
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
nameWithType: Object.GetHashCode
fullName: System.Object.GetHashCode
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
name: GetType()
nameWithType: Object.GetType()
fullName: System.Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
nameWithType: Object.GetType
fullName: System.Object.GetType
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.Object.GetType
name: GetType
nameWithType: Object.GetType
fullName: System.Object.GetType
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
name: MemberwiseClone()
nameWithType: Object.MemberwiseClone()
fullName: System.Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
nameWithType: Object.MemberwiseClone
fullName: System.Object.MemberwiseClone
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
nameWithType: Object.MemberwiseClone
fullName: System.Object.MemberwiseClone
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
name: ReferenceEquals(Object, Object)
nameWithType: Object.ReferenceEquals(Object, Object)
fullName: System.Object.ReferenceEquals(System.Object, System.Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
nameWithType: Object.ReferenceEquals
fullName: System.Object.ReferenceEquals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: ', '
nameWithType: ', '
fullName: ', '
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
nameWithType: Object.ReferenceEquals
fullName: System.Object.ReferenceEquals
isExternal: true
- name: (
nameWithType: (
fullName: (
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: ', '
nameWithType: ', '
fullName: ', '
- uid: System.Object
name: Object
nameWithType: Object
fullName: System.Object
isExternal: true
- name: )
nameWithType: )
fullName: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
name: ToString()
nameWithType: Object.ToString()
fullName: System.Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
nameWithType: Object.ToString
fullName: System.Object.ToString
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: System.Object.ToString
name: ToString
nameWithType: Object.ToString
fullName: System.Object.ToString
isExternal: true
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
- uid: System
commentId: N:System
isExternal: true
name: System
nameWithType: System
fullName: System
- uid: TinyLife.Uis.Menus.TransitionType
commentId: T:TinyLife.Uis.Menus.TransitionType
parent: TinyLife.Uis
name: Menus.TransitionType
nameWithType: Menus.TransitionType
fullName: TinyLife.Uis.Menus.TransitionType
- uid: System.InvalidOperationException
commentId: T:System.InvalidOperationException
isExternal: true
- uid: TinyLife.Uis.Menus.Transition*
commentId: Overload:TinyLife.Uis.Menus.Transition
name: Transition
nameWithType: Menus.Transition
fullName: TinyLife.Uis.Menus.Transition
- uid: System.Action
commentId: T:System.Action
parent: System
isExternal: true
name: Action
nameWithType: Action
fullName: System.Action
- uid: System.Single
commentId: T:System.Single
parent: System
isExternal: true
name: Single
nameWithType: Single
fullName: System.Single
- uid: System.Nullable{Microsoft.Xna.Framework.Color}
commentId: T:System.Nullable{Microsoft.Xna.Framework.Color}
parent: System
definition: System.Nullable`1
name: Nullable<Color>
nameWithType: Nullable<Color>
fullName: System.Nullable<Microsoft.Xna.Framework.Color>
nameWithType.vb: Nullable(Of Color)
fullName.vb: System.Nullable(Of Microsoft.Xna.Framework.Color)
name.vb: Nullable(Of Color)
spec.csharp:
- uid: System.Nullable`1
name: Nullable
nameWithType: Nullable
fullName: System.Nullable
isExternal: true
- name: <
nameWithType: <
fullName: <
- uid: Microsoft.Xna.Framework.Color
name: Color
nameWithType: Color
fullName: Microsoft.Xna.Framework.Color
isExternal: true
- name: '>'
nameWithType: '>'
fullName: '>'
spec.vb:
- uid: System.Nullable`1
name: Nullable
nameWithType: Nullable
fullName: System.Nullable
isExternal: true
- name: '(Of '
nameWithType: '(Of '
fullName: '(Of '
- uid: Microsoft.Xna.Framework.Color
name: Color
nameWithType: Color
fullName: Microsoft.Xna.Framework.Color
isExternal: true
- name: )
nameWithType: )
fullName: )
- uid: System.Nullable`1
commentId: T:System.Nullable`1
isExternal: true
name: Nullable<T>
nameWithType: Nullable<T>
fullName: System.Nullable<T>
nameWithType.vb: Nullable(Of T)
fullName.vb: System.Nullable(Of T)
name.vb: Nullable(Of T)
spec.csharp:
- uid: System.Nullable`1
name: Nullable
nameWithType: Nullable
fullName: System.Nullable
isExternal: true
- name: <
nameWithType: <
fullName: <
- name: T
nameWithType: T
fullName: T
- name: '>'
nameWithType: '>'
fullName: '>'
spec.vb:
- uid: System.Nullable`1
name: Nullable
nameWithType: Nullable
fullName: System.Nullable
isExternal: true
- name: '(Of '
nameWithType: '(Of '
fullName: '(Of '
- name: T
nameWithType: T
fullName: T
- name: )
nameWithType: )
fullName: )
Reference in a new issue View git blame Copy permalink