TinyLifeWeb/docs/api/TinyLife.Actions.ResultType.yml

250 lines
8.2 KiB
YAML
Raw Normal View History

2022-05-24 13:36:05 +02:00
### YamlMime:ManagedReference
items:
2022-07-04 16:50:43 +02:00
- uid: TinyLife.Actions.ResultType
commentId: T:TinyLife.Actions.ResultType
id: ResultType
2022-05-24 13:36:05 +02:00
parent: TinyLife.Actions
children:
2022-07-04 16:50:43 +02:00
- TinyLife.Actions.ResultType.Hidden
- TinyLife.Actions.ResultType.Invalid
- TinyLife.Actions.ResultType.Valid
2022-05-24 13:36:05 +02:00
langs:
- csharp
- vb
2022-07-04 16:50:43 +02:00
name: ResultType
nameWithType: ResultType
fullName: TinyLife.Actions.ResultType
2022-05-24 13:36:05 +02:00
type: Enum
source:
remote:
path: TinyLife/Actions/CanExecuteResult.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: ResultType
path: ../TinyLife/Actions/CanExecuteResult.cs
2022-07-04 16:50:43 +02:00
startLine: 29
2022-05-24 13:36:05 +02:00
assemblies:
- Tiny Life
namespace: TinyLife.Actions
2022-07-04 16:50:43 +02:00
summary: "\nA type of result that a <xref href=\"TinyLife.Actions.CanExecuteResult\" data-throw-if-not-resolved=\"false\"></xref> can have.\nIn general, custom <xref href=\"TinyLife.Actions.CanExecuteResult\" data-throw-if-not-resolved=\"false\"></xref> instances will have the <xref href=\"TinyLife.Actions.ResultType.Invalid\" data-throw-if-not-resolved=\"false\"></xref> result type, as <xref href=\"TinyLife.Actions.ResultType.Valid\" data-throw-if-not-resolved=\"false\"></xref> and <xref href=\"TinyLife.Actions.ResultType.Hidden\" data-throw-if-not-resolved=\"false\"></xref> are already covered by their respective <xref href=\"TinyLife.Actions.CanExecuteResult\" data-throw-if-not-resolved=\"false\"></xref> counterparts.\n"
2022-05-24 13:36:05 +02:00
example: []
syntax:
content: public enum ResultType
content.vb: Public Enum ResultType
extensionMethods:
2022-07-04 16:50:43 +02:00
- TinyLife.Actions.ResultType.TinyLife.Utilities.Extensions.JsonCopy``1
2022-05-24 13:36:05 +02:00
modifiers.csharp:
- public
- enum
modifiers.vb:
- Public
- Enum
2022-07-04 16:50:43 +02:00
- uid: TinyLife.Actions.ResultType.Valid
commentId: F:TinyLife.Actions.ResultType.Valid
2022-05-24 13:36:05 +02:00
id: Valid
2022-07-04 16:50:43 +02:00
parent: TinyLife.Actions.ResultType
2022-05-24 13:36:05 +02:00
langs:
- csharp
- vb
name: Valid
2022-07-04 16:50:43 +02:00
nameWithType: ResultType.Valid
fullName: TinyLife.Actions.ResultType.Valid
2022-05-24 13:36:05 +02:00
type: Field
source:
remote:
path: TinyLife/Actions/CanExecuteResult.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Valid
path: ../TinyLife/Actions/CanExecuteResult.cs
2022-07-04 16:50:43 +02:00
startLine: 35
2022-05-24 13:36:05 +02:00
assemblies:
- Tiny Life
namespace: TinyLife.Actions
2022-07-04 16:50:43 +02:00
summary: "\nA valid <xref href=\"TinyLife.Actions.ResultType\" data-throw-if-not-resolved=\"false\"></xref> indicates that the action can be executed.\n<xref href=\"TinyLife.Actions.CanExecuteResult\" data-throw-if-not-resolved=\"false\"></xref> instances with this type usually don&apos;t display their name to the player.\n"
2022-05-24 13:36:05 +02:00
example: []
syntax:
content: Valid = 0
return:
2022-07-04 16:50:43 +02:00
type: TinyLife.Actions.ResultType
2022-05-24 13:36:05 +02:00
modifiers.csharp:
- public
- const
modifiers.vb:
- Public
- Const
2022-07-04 16:50:43 +02:00
- uid: TinyLife.Actions.ResultType.Invalid
commentId: F:TinyLife.Actions.ResultType.Invalid
2022-05-24 13:36:05 +02:00
id: Invalid
2022-07-04 16:50:43 +02:00
parent: TinyLife.Actions.ResultType
2022-05-24 13:36:05 +02:00
langs:
- csharp
- vb
name: Invalid
2022-07-04 16:50:43 +02:00
nameWithType: ResultType.Invalid
fullName: TinyLife.Actions.ResultType.Invalid
2022-05-24 13:36:05 +02:00
type: Field
source:
remote:
path: TinyLife/Actions/CanExecuteResult.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Invalid
path: ../TinyLife/Actions/CanExecuteResult.cs
2022-07-04 16:50:43 +02:00
startLine: 39
2022-05-24 13:36:05 +02:00
assemblies:
- Tiny Life
namespace: TinyLife.Actions
2022-07-04 16:50:43 +02:00
summary: "\nAn invalid <xref href=\"TinyLife.Actions.ResultType\" data-throw-if-not-resolved=\"false\"></xref> signifies that the action cannot be executed for some reason.\n"
2022-05-24 13:36:05 +02:00
example: []
syntax:
content: Invalid = 1
return:
2022-07-04 16:50:43 +02:00
type: TinyLife.Actions.ResultType
2022-05-24 13:36:05 +02:00
modifiers.csharp:
- public
- const
modifiers.vb:
- Public
- Const
2022-07-04 16:50:43 +02:00
- uid: TinyLife.Actions.ResultType.Hidden
commentId: F:TinyLife.Actions.ResultType.Hidden
2022-05-24 13:36:05 +02:00
id: Hidden
2022-07-04 16:50:43 +02:00
parent: TinyLife.Actions.ResultType
2022-05-24 13:36:05 +02:00
langs:
- csharp
- vb
name: Hidden
2022-07-04 16:50:43 +02:00
nameWithType: ResultType.Hidden
fullName: TinyLife.Actions.ResultType.Hidden
2022-05-24 13:36:05 +02:00
type: Field
source:
remote:
path: TinyLife/Actions/CanExecuteResult.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Hidden
path: ../TinyLife/Actions/CanExecuteResult.cs
2022-07-04 16:50:43 +02:00
startLine: 44
2022-05-24 13:36:05 +02:00
assemblies:
- Tiny Life
namespace: TinyLife.Actions
2022-07-04 16:50:43 +02:00
summary: "\nA hidden <xref href=\"TinyLife.Actions.ResultType\" data-throw-if-not-resolved=\"false\"></xref> indicates that the action cannot be executed, and shouldn&apos;t be displayed as a disallowed option to the player.\n<xref href=\"TinyLife.Actions.CanExecuteResult\" data-throw-if-not-resolved=\"false\"></xref> instances with this type usually don&apos;t display their name to the player.\n"
2022-05-24 13:36:05 +02:00
example: []
syntax:
content: Hidden = 2
return:
2022-07-04 16:50:43 +02:00
type: TinyLife.Actions.ResultType
2022-05-24 13:36:05 +02:00
modifiers.csharp:
- public
- const
modifiers.vb:
- Public
- Const
references:
- uid: TinyLife.Actions.CanExecuteResult
commentId: T:TinyLife.Actions.CanExecuteResult
parent: TinyLife.Actions
name: CanExecuteResult
nameWithType: CanExecuteResult
fullName: TinyLife.Actions.CanExecuteResult
2022-07-04 16:50:43 +02:00
- uid: TinyLife.Actions.ResultType.Invalid
commentId: F:TinyLife.Actions.ResultType.Invalid
2022-05-24 13:36:05 +02:00
isExternal: true
2022-07-04 16:50:43 +02:00
- uid: TinyLife.Actions.ResultType.Valid
commentId: F:TinyLife.Actions.ResultType.Valid
2022-05-24 13:36:05 +02:00
isExternal: true
2022-07-04 16:50:43 +02:00
- uid: TinyLife.Actions.ResultType.Hidden
commentId: F:TinyLife.Actions.ResultType.Hidden
2022-05-24 13:36:05 +02:00
isExternal: true
- uid: TinyLife.Actions
commentId: N:TinyLife.Actions
name: TinyLife.Actions
nameWithType: TinyLife.Actions
fullName: TinyLife.Actions
2022-07-04 16:50:43 +02:00
- uid: TinyLife.Actions.ResultType.TinyLife.Utilities.Extensions.JsonCopy``1
2022-05-24 13:36:05 +02:00
commentId: M:TinyLife.Utilities.Extensions.JsonCopy``1(``0)
parent: TinyLife.Utilities.Extensions
definition: TinyLife.Utilities.Extensions.JsonCopy``1(``0)
2022-07-04 16:50:43 +02:00
name: JsonCopy<ResultType>()
nameWithType: Extensions.JsonCopy<ResultType>()
fullName: TinyLife.Utilities.Extensions.JsonCopy<TinyLife.Actions.ResultType>()
nameWithType.vb: Extensions.JsonCopy(Of ResultType)()
fullName.vb: TinyLife.Utilities.Extensions.JsonCopy(Of TinyLife.Actions.ResultType)()
name.vb: JsonCopy(Of ResultType)()
2022-05-24 13:36:05 +02:00
spec.csharp:
- uid: TinyLife.Utilities.Extensions.JsonCopy``1
2022-07-04 16:50:43 +02:00
name: JsonCopy<ResultType>
nameWithType: Extensions.JsonCopy<ResultType>
fullName: TinyLife.Utilities.Extensions.JsonCopy<TinyLife.Actions.ResultType>
2022-05-24 13:36:05 +02:00
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: TinyLife.Utilities.Extensions.JsonCopy``1
2022-07-04 16:50:43 +02:00
name: JsonCopy(Of ResultType)
nameWithType: Extensions.JsonCopy(Of ResultType)
fullName: TinyLife.Utilities.Extensions.JsonCopy(Of TinyLife.Actions.ResultType)
2022-05-24 13:36:05 +02:00
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
- uid: TinyLife.Utilities.Extensions.JsonCopy``1(``0)
commentId: M:TinyLife.Utilities.Extensions.JsonCopy``1(``0)
name: JsonCopy<T>(T)
nameWithType: Extensions.JsonCopy<T>(T)
fullName: TinyLife.Utilities.Extensions.JsonCopy<T>(T)
nameWithType.vb: Extensions.JsonCopy(Of T)(T)
fullName.vb: TinyLife.Utilities.Extensions.JsonCopy(Of T)(T)
name.vb: JsonCopy(Of T)(T)
spec.csharp:
- uid: TinyLife.Utilities.Extensions.JsonCopy``1(``0)
name: JsonCopy<T>
nameWithType: Extensions.JsonCopy<T>
fullName: TinyLife.Utilities.Extensions.JsonCopy<T>
- name: (
nameWithType: (
fullName: (
- name: T
nameWithType: T
fullName: T
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: TinyLife.Utilities.Extensions.JsonCopy``1(``0)
name: JsonCopy(Of T)
nameWithType: Extensions.JsonCopy(Of T)
fullName: TinyLife.Utilities.Extensions.JsonCopy(Of T)
- name: (
nameWithType: (
fullName: (
- name: T
nameWithType: T
fullName: T
- name: )
nameWithType: )
fullName: )
- uid: TinyLife.Utilities.Extensions
commentId: T:TinyLife.Utilities.Extensions
parent: TinyLife.Utilities
name: Extensions
nameWithType: Extensions
fullName: TinyLife.Utilities.Extensions
- uid: TinyLife.Utilities
commentId: N:TinyLife.Utilities
name: TinyLife.Utilities
nameWithType: TinyLife.Utilities
fullName: TinyLife.Utilities
2022-07-04 16:50:43 +02:00
- uid: TinyLife.Actions.ResultType
commentId: T:TinyLife.Actions.ResultType
2022-05-24 13:36:05 +02:00
parent: TinyLife.Actions
2022-07-04 16:50:43 +02:00
name: ResultType
nameWithType: ResultType
fullName: TinyLife.Actions.ResultType