Ellpeck/TinyLifeWeb
1
0
Fork 0
mirror of https://github.com/Ellpeck/TinyLifeWeb.git synced 2024-11-05 12:29:09 +01:00
Code Issues Projects Releases Wiki Activity
TinyLifeWeb/docs/api/TinyLife.Goals.LifeGoal.yml
Ell 49c965869d 0.23.0
2022-07-04 16:50:43 +02:00

1421 lines
40 KiB
YAML
Raw Blame History

### YamlMime:ManagedReference
items:
- uid: TinyLife.Goals.LifeGoal
commentId: T:TinyLife.Goals.LifeGoal
id: LifeGoal
parent: TinyLife.Goals
children:
- TinyLife.Goals.LifeGoal.#ctor(System.String,TinyLife.PersonalityType,TinyLife.Goals.GoalSetInfo[])
- TinyLife.Goals.LifeGoal.AllowedAges
- TinyLife.Goals.LifeGoal.CapableCarpenter
- TinyLife.Goals.LifeGoal.Chef
- TinyLife.Goals.LifeGoal.ComputerAddict
- TinyLife.Goals.LifeGoal.FriendOfEveryone
- TinyLife.Goals.LifeGoal.Goals
- TinyLife.Goals.LifeGoal.GymRat
- TinyLife.Goals.LifeGoal.HouseholdHero
- TinyLife.Goals.LifeGoal.IsCompleted(TinyLife.Objects.Person)
- TinyLife.Goals.LifeGoal.Millionaire
- TinyLife.Goals.LifeGoal.Name
- TinyLife.Goals.LifeGoal.OnAdvanced
- TinyLife.Goals.LifeGoal.OnCompleted
- TinyLife.Goals.LifeGoal.Register(TinyLife.Goals.LifeGoal)
- TinyLife.Goals.LifeGoal.RewardPersonality
- TinyLife.Goals.LifeGoal.SmartKid
- TinyLife.Goals.LifeGoal.Stages
langs:
- csharp
- vb
name: LifeGoal
nameWithType: LifeGoal
fullName: TinyLife.Goals.LifeGoal
type: Class
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: LifeGoal
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 24
assemblies:
- Tiny Life
namespace: TinyLife.Goals
summary: "\nA life goal is a set of <xref href=\"TinyLife.Goals.GoalSet\" data-throw-if-not-resolved=\"false\"></xref> instances that, when completed, result in a special <xref href=\"TinyLife.PersonalityType\" data-throw-if-not-resolved=\"false\"></xref> to be unlocked.\nWhen a life goal is applied to a person, the <xref href=\"TinyLife.Goals.LifeGoal.Instance\" data-throw-if-not-resolved=\"false\"></xref> class is used.\n"
example: []
syntax:
content: >-
[JsonConverter(typeof(StaticJsonConverter<LifeGoal>), new object[]{typeof(LifeGoal), "PrivateGoals"})]
public class LifeGoal
content.vb: >-
<JsonConverter(GetType(StaticJsonConverter(Of LifeGoal)), New Object() {GetType(LifeGoal), "PrivateGoals"})>
Public Class LifeGoal
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
extensionMethods:
- TinyLife.Goals.LifeGoal.TinyLife.Utilities.Extensions.JsonCopy``1
modifiers.csharp:
- public
- class
modifiers.vb:
- Public
- Class
- uid: TinyLife.Goals.LifeGoal.Goals
commentId: F:TinyLife.Goals.LifeGoal.Goals
id: Goals
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: Goals
nameWithType: LifeGoal.Goals
fullName: TinyLife.Goals.LifeGoal.Goals
type: Field
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Goals
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 31
assemblies:
- Tiny Life
namespace: TinyLife.Goals
summary: "\nA registry for all registered life goals in the game and mods\n"
example: []
syntax:
content: public static readonly ReadOnlyDictionary<string, LifeGoal> Goals
return:
type: System.Collections.ObjectModel.ReadOnlyDictionary{System.String,TinyLife.Goals.LifeGoal}
content.vb: Public Shared ReadOnly Goals As ReadOnlyDictionary(Of String, LifeGoal)
modifiers.csharp:
- public
- static
- readonly
modifiers.vb:
- Public
- Shared
- ReadOnly
- uid: TinyLife.Goals.LifeGoal.Chef
commentId: F:TinyLife.Goals.LifeGoal.Chef
id: Chef
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: Chef
nameWithType: LifeGoal.Chef
fullName: TinyLife.Goals.LifeGoal.Chef
type: Field
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Chef
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 34
assemblies:
- Tiny Life
namespace: TinyLife.Goals
syntax:
content: public static readonly LifeGoal Chef
return:
type: TinyLife.Goals.LifeGoal
content.vb: Public Shared ReadOnly Chef As LifeGoal
modifiers.csharp:
- public
- static
- readonly
modifiers.vb:
- Public
- Shared
- ReadOnly
- uid: TinyLife.Goals.LifeGoal.SmartKid
commentId: F:TinyLife.Goals.LifeGoal.SmartKid
id: SmartKid
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: SmartKid
nameWithType: LifeGoal.SmartKid
fullName: TinyLife.Goals.LifeGoal.SmartKid
type: Field
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: SmartKid
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 46
assemblies:
- Tiny Life
namespace: TinyLife.Goals
syntax:
content: public static readonly LifeGoal SmartKid
return:
type: TinyLife.Goals.LifeGoal
content.vb: Public Shared ReadOnly SmartKid As LifeGoal
modifiers.csharp:
- public
- static
- readonly
modifiers.vb:
- Public
- Shared
- ReadOnly
- uid: TinyLife.Goals.LifeGoal.GymRat
commentId: F:TinyLife.Goals.LifeGoal.GymRat
id: GymRat
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: GymRat
nameWithType: LifeGoal.GymRat
fullName: TinyLife.Goals.LifeGoal.GymRat
type: Field
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: GymRat
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 58
assemblies:
- Tiny Life
namespace: TinyLife.Goals
syntax:
content: public static readonly LifeGoal GymRat
return:
type: TinyLife.Goals.LifeGoal
content.vb: Public Shared ReadOnly GymRat As LifeGoal
modifiers.csharp:
- public
- static
- readonly
modifiers.vb:
- Public
- Shared
- ReadOnly
- uid: TinyLife.Goals.LifeGoal.HouseholdHero
commentId: F:TinyLife.Goals.LifeGoal.HouseholdHero
id: HouseholdHero
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: HouseholdHero
nameWithType: LifeGoal.HouseholdHero
fullName: TinyLife.Goals.LifeGoal.HouseholdHero
type: Field
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: HouseholdHero
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 70
assemblies:
- Tiny Life
namespace: TinyLife.Goals
syntax:
content: public static readonly LifeGoal HouseholdHero
return:
type: TinyLife.Goals.LifeGoal
content.vb: Public Shared ReadOnly HouseholdHero As LifeGoal
modifiers.csharp:
- public
- static
- readonly
modifiers.vb:
- Public
- Shared
- ReadOnly
- uid: TinyLife.Goals.LifeGoal.ComputerAddict
commentId: F:TinyLife.Goals.LifeGoal.ComputerAddict
id: ComputerAddict
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: ComputerAddict
nameWithType: LifeGoal.ComputerAddict
fullName: TinyLife.Goals.LifeGoal.ComputerAddict
type: Field
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: ComputerAddict
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 82
assemblies:
- Tiny Life
namespace: TinyLife.Goals
syntax:
content: public static readonly LifeGoal ComputerAddict
return:
type: TinyLife.Goals.LifeGoal
content.vb: Public Shared ReadOnly ComputerAddict As LifeGoal
modifiers.csharp:
- public
- static
- readonly
modifiers.vb:
- Public
- Shared
- ReadOnly
- uid: TinyLife.Goals.LifeGoal.FriendOfEveryone
commentId: F:TinyLife.Goals.LifeGoal.FriendOfEveryone
id: FriendOfEveryone
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: FriendOfEveryone
nameWithType: LifeGoal.FriendOfEveryone
fullName: TinyLife.Goals.LifeGoal.FriendOfEveryone
type: Field
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: FriendOfEveryone
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 94
assemblies:
- Tiny Life
namespace: TinyLife.Goals
syntax:
content: public static readonly LifeGoal FriendOfEveryone
return:
type: TinyLife.Goals.LifeGoal
content.vb: Public Shared ReadOnly FriendOfEveryone As LifeGoal
modifiers.csharp:
- public
- static
- readonly
modifiers.vb:
- Public
- Shared
- ReadOnly
- uid: TinyLife.Goals.LifeGoal.Millionaire
commentId: F:TinyLife.Goals.LifeGoal.Millionaire
id: Millionaire
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: Millionaire
nameWithType: LifeGoal.Millionaire
fullName: TinyLife.Goals.LifeGoal.Millionaire
type: Field
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Millionaire
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 104
assemblies:
- Tiny Life
namespace: TinyLife.Goals
syntax:
content: public static readonly LifeGoal Millionaire
return:
type: TinyLife.Goals.LifeGoal
content.vb: Public Shared ReadOnly Millionaire As LifeGoal
modifiers.csharp:
- public
- static
- readonly
modifiers.vb:
- Public
- Shared
- ReadOnly
- uid: TinyLife.Goals.LifeGoal.CapableCarpenter
commentId: F:TinyLife.Goals.LifeGoal.CapableCarpenter
id: CapableCarpenter
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: CapableCarpenter
nameWithType: LifeGoal.CapableCarpenter
fullName: TinyLife.Goals.LifeGoal.CapableCarpenter
type: Field
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: CapableCarpenter
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 116
assemblies:
- Tiny Life
namespace: TinyLife.Goals
syntax:
content: public static readonly LifeGoal CapableCarpenter
return:
type: TinyLife.Goals.LifeGoal
content.vb: Public Shared ReadOnly CapableCarpenter As LifeGoal
modifiers.csharp:
- public
- static
- readonly
modifiers.vb:
- Public
- Shared
- ReadOnly
- uid: TinyLife.Goals.LifeGoal.OnAdvanced
commentId: E:TinyLife.Goals.LifeGoal.OnAdvanced
id: OnAdvanced
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: OnAdvanced
nameWithType: LifeGoal.OnAdvanced
fullName: TinyLife.Goals.LifeGoal.OnAdvanced
type: Event
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: OnAdvanced
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 131
assemblies:
- Tiny Life
namespace: TinyLife.Goals
summary: "\nAn event that is invoked when a life goal <xref href=\"TinyLife.Goals.LifeGoal.Instance\" data-throw-if-not-resolved=\"false\"></xref> is advanced in <xref href=\"TinyLife.Goals.LifeGoal.Instance.Advance\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax:
content: public static event Action<LifeGoal.Instance> OnAdvanced
return:
type: System.Action{TinyLife.Goals.LifeGoal.Instance}
content.vb: Public Shared Event OnAdvanced As Action(Of LifeGoal.Instance)
modifiers.csharp:
- public
- static
modifiers.vb:
- Public
- Shared
- uid: TinyLife.Goals.LifeGoal.OnCompleted
commentId: E:TinyLife.Goals.LifeGoal.OnCompleted
id: OnCompleted
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: OnCompleted
nameWithType: LifeGoal.OnCompleted
fullName: TinyLife.Goals.LifeGoal.OnCompleted
type: Event
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: OnCompleted
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 135
assemblies:
- Tiny Life
namespace: TinyLife.Goals
summary: "\nAn event that is invoked when a life goal <xref href=\"TinyLife.Goals.LifeGoal.Instance\" data-throw-if-not-resolved=\"false\"></xref> is completed in <xref href=\"TinyLife.Goals.LifeGoal.Instance.Advance\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax:
content: public static event Action<LifeGoal.Instance> OnCompleted
return:
type: System.Action{TinyLife.Goals.LifeGoal.Instance}
content.vb: Public Shared Event OnCompleted As Action(Of LifeGoal.Instance)
modifiers.csharp:
- public
- static
modifiers.vb:
- Public
- Shared
- uid: TinyLife.Goals.LifeGoal.Name
commentId: F:TinyLife.Goals.LifeGoal.Name
id: Name
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: Name
nameWithType: LifeGoal.Name
fullName: TinyLife.Goals.LifeGoal.Name
type: Field
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Name
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 140
assemblies:
- Tiny Life
namespace: TinyLife.Goals
summary: "\nThe name of this life goal, which is used to register it to the <xref href=\"TinyLife.Goals.LifeGoal.Goals\" data-throw-if-not-resolved=\"false\"></xref> registry\n"
example: []
syntax:
content: public readonly string Name
return:
type: System.String
content.vb: Public ReadOnly Name As String
modifiers.csharp:
- public
- readonly
modifiers.vb:
- Public
- ReadOnly
- uid: TinyLife.Goals.LifeGoal.Stages
commentId: F:TinyLife.Goals.LifeGoal.Stages
id: Stages
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: Stages
nameWithType: LifeGoal.Stages
fullName: TinyLife.Goals.LifeGoal.Stages
type: Field
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Stages
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 144
assemblies:
- Tiny Life
namespace: TinyLife.Goals
summary: "\nThe stages of this life goal\n"
example: []
syntax:
content: public readonly GoalSetInfo[] Stages
return:
type: TinyLife.Goals.GoalSetInfo[]
content.vb: Public ReadOnly Stages As GoalSetInfo()
modifiers.csharp:
- public
- readonly
modifiers.vb:
- Public
- ReadOnly
- uid: TinyLife.Goals.LifeGoal.RewardPersonality
commentId: F:TinyLife.Goals.LifeGoal.RewardPersonality
id: RewardPersonality
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: RewardPersonality
nameWithType: LifeGoal.RewardPersonality
fullName: TinyLife.Goals.LifeGoal.RewardPersonality
type: Field
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: RewardPersonality
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 149
assemblies:
- Tiny Life
namespace: TinyLife.Goals
summary: "\nThe reward personality that is unlocked when this life goal is completed.\nThe personality&apos;s <xref href=\"TinyLife.PersonalityType.TypeCategory\" data-throw-if-not-resolved=\"false\"></xref> should be <xref href=\"TinyLife.PersonalityType.TypeCategory.Hidden\" data-throw-if-not-resolved=\"false\"></xref> so that this is the only way to unlock the personality.\n"
example: []
syntax:
content: public readonly PersonalityType RewardPersonality
return:
type: TinyLife.PersonalityType
content.vb: Public ReadOnly RewardPersonality As PersonalityType
modifiers.csharp:
- public
- readonly
modifiers.vb:
- Public
- ReadOnly
- uid: TinyLife.Goals.LifeGoal.AllowedAges
commentId: P:TinyLife.Goals.LifeGoal.AllowedAges
id: AllowedAges
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: AllowedAges
nameWithType: LifeGoal.AllowedAges
fullName: TinyLife.Goals.LifeGoal.AllowedAges
type: Property
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: AllowedAges
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 154
assemblies:
- Tiny Life
namespace: TinyLife.Goals
summary: "\nA set of allowed age group flags for people that can start this life goal.\nThis value defaults to ~0, meaning all age groups.\n"
example: []
syntax:
content: public AgeGroup AllowedAges { get; set; }
parameters: []
return:
type: TinyLife.Objects.AgeGroup
content.vb: Public Property AllowedAges As AgeGroup
overload: TinyLife.Goals.LifeGoal.AllowedAges*
modifiers.csharp:
- public
- get
- set
modifiers.vb:
- Public
- uid: TinyLife.Goals.LifeGoal.#ctor(System.String,TinyLife.PersonalityType,TinyLife.Goals.GoalSetInfo[])
commentId: M:TinyLife.Goals.LifeGoal.#ctor(System.String,TinyLife.PersonalityType,TinyLife.Goals.GoalSetInfo[])
id: '#ctor(System.String,TinyLife.PersonalityType,TinyLife.Goals.GoalSetInfo[])'
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: LifeGoal(String, PersonalityType, GoalSetInfo[])
nameWithType: LifeGoal.LifeGoal(String, PersonalityType, GoalSetInfo[])
fullName: TinyLife.Goals.LifeGoal.LifeGoal(System.String, TinyLife.PersonalityType, TinyLife.Goals.GoalSetInfo[])
type: Constructor
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: .ctor
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 162
assemblies:
- Tiny Life
namespace: TinyLife.Goals
summary: "\nCreates a new life goal with the given settings\n"
example: []
syntax:
content: public LifeGoal(string name, PersonalityType rewardPersonality, params GoalSetInfo[] stages)
parameters:
- id: name
type: System.String
description: The life goal&apos;s name
- id: rewardPersonality
type: TinyLife.PersonalityType
description: The reward personality that is unlocked when the life goal is completed
- id: stages
type: TinyLife.Goals.GoalSetInfo[]
description: A set of goal set informations that represent the stages of this life goal
content.vb: Public Sub New(name As String, rewardPersonality As PersonalityType, ParamArray stages As GoalSetInfo())
overload: TinyLife.Goals.LifeGoal.#ctor*
nameWithType.vb: LifeGoal.LifeGoal(String, PersonalityType, GoalSetInfo())
modifiers.csharp:
- public
modifiers.vb:
- Public
fullName.vb: TinyLife.Goals.LifeGoal.LifeGoal(System.String, TinyLife.PersonalityType, TinyLife.Goals.GoalSetInfo())
name.vb: LifeGoal(String, PersonalityType, GoalSetInfo())
- uid: TinyLife.Goals.LifeGoal.IsCompleted(TinyLife.Objects.Person)
commentId: M:TinyLife.Goals.LifeGoal.IsCompleted(TinyLife.Objects.Person)
id: IsCompleted(TinyLife.Objects.Person)
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: IsCompleted(Person)
nameWithType: LifeGoal.IsCompleted(Person)
fullName: TinyLife.Goals.LifeGoal.IsCompleted(TinyLife.Objects.Person)
type: Method
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: IsCompleted
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 173
assemblies:
- Tiny Life
namespace: TinyLife.Goals
summary: "\nQueries whether the given <xref href=\"TinyLife.Objects.Person\" data-throw-if-not-resolved=\"false\"></xref> has the <xref href=\"TinyLife.Goals.LifeGoal.RewardPersonality\" data-throw-if-not-resolved=\"false\"></xref>, which indicates that they have completed this life goal\n"
example: []
syntax:
content: public bool IsCompleted(Person person)
parameters:
- id: person
type: TinyLife.Objects.Person
description: The person
return:
type: System.Boolean
description: Whether the person has completed this life goal
content.vb: Public Function IsCompleted(person As Person) As Boolean
overload: TinyLife.Goals.LifeGoal.IsCompleted*
modifiers.csharp:
- public
modifiers.vb:
- Public
- uid: TinyLife.Goals.LifeGoal.Register(TinyLife.Goals.LifeGoal)
commentId: M:TinyLife.Goals.LifeGoal.Register(TinyLife.Goals.LifeGoal)
id: Register(TinyLife.Goals.LifeGoal)
parent: TinyLife.Goals.LifeGoal
langs:
- csharp
- vb
name: Register(LifeGoal)
nameWithType: LifeGoal.Register(LifeGoal)
fullName: TinyLife.Goals.LifeGoal.Register(TinyLife.Goals.LifeGoal)
type: Method
source:
remote:
path: TinyLife/Goals/LifeGoal.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Register
path: ../TinyLife/Goals/LifeGoal.cs
startLine: 182
assemblies:
- Tiny Life
namespace: TinyLife.Goals
summary: "\nRegisters the given life goal to the <xref href=\"TinyLife.Goals.LifeGoal.Goals\" data-throw-if-not-resolved=\"false\"></xref> registry and returns it\n"
example: []
syntax:
content: public static LifeGoal Register(LifeGoal goal)
parameters:
- id: goal
type: TinyLife.Goals.LifeGoal
description: The life goal to register
return:
type: TinyLife.Goals.LifeGoal
description: The passed life goal, for chaining
content.vb: Public Shared Function Register(goal As LifeGoal) As LifeGoal
overload: TinyLife.Goals.LifeGoal.Register*
modifiers.csharp:
- public
- static
modifiers.vb:
- Public
- Shared
references:
- uid: TinyLife.Goals.GoalSet
commentId: T:TinyLife.Goals.GoalSet
parent: TinyLife.Goals
name: GoalSet
nameWithType: GoalSet
fullName: TinyLife.Goals.GoalSet
- uid: TinyLife.PersonalityType
commentId: T:TinyLife.PersonalityType
parent: TinyLife
name: PersonalityType
nameWithType: PersonalityType
fullName: TinyLife.PersonalityType
- uid: TinyLife.Goals.LifeGoal.Instance
commentId: T:TinyLife.Goals.LifeGoal.Instance
parent: TinyLife.Goals
name: LifeGoal.Instance
nameWithType: LifeGoal.Instance
fullName: TinyLife.Goals.LifeGoal.Instance
- uid: TinyLife.Goals
commentId: N:TinyLife.Goals
name: TinyLife.Goals
nameWithType: TinyLife.Goals
fullName: TinyLife.Goals
- 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: TinyLife.Goals.LifeGoal.TinyLife.Utilities.Extensions.JsonCopy``1
commentId: M:TinyLife.Utilities.Extensions.JsonCopy``1(``0)
parent: TinyLife.Utilities.Extensions
definition: TinyLife.Utilities.Extensions.JsonCopy``1(``0)
name: JsonCopy<LifeGoal>()
nameWithType: Extensions.JsonCopy<LifeGoal>()
fullName: TinyLife.Utilities.Extensions.JsonCopy<TinyLife.Goals.LifeGoal>()
nameWithType.vb: Extensions.JsonCopy(Of LifeGoal)()
fullName.vb: TinyLife.Utilities.Extensions.JsonCopy(Of TinyLife.Goals.LifeGoal)()
name.vb: JsonCopy(Of LifeGoal)()
spec.csharp:
- uid: TinyLife.Utilities.Extensions.JsonCopy``1
name: JsonCopy<LifeGoal>
nameWithType: Extensions.JsonCopy<LifeGoal>
fullName: TinyLife.Utilities.Extensions.JsonCopy<TinyLife.Goals.LifeGoal>
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: TinyLife.Utilities.Extensions.JsonCopy``1
name: JsonCopy(Of LifeGoal)
nameWithType: Extensions.JsonCopy(Of LifeGoal)
fullName: TinyLife.Utilities.Extensions.JsonCopy(Of TinyLife.Goals.LifeGoal)
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
- uid: TinyLife
commentId: N:TinyLife
name: TinyLife
nameWithType: TinyLife
fullName: TinyLife
- uid: System
commentId: N:System
isExternal: true
name: System
nameWithType: System
fullName: System
- 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
- uid: System.Collections.ObjectModel.ReadOnlyDictionary{System.String,TinyLife.Goals.LifeGoal}
commentId: T:System.Collections.ObjectModel.ReadOnlyDictionary{System.String,TinyLife.Goals.LifeGoal}
parent: System.Collections.ObjectModel
definition: System.Collections.ObjectModel.ReadOnlyDictionary`2
name: ReadOnlyDictionary<String, LifeGoal>
nameWithType: ReadOnlyDictionary<String, LifeGoal>
fullName: System.Collections.ObjectModel.ReadOnlyDictionary<System.String, TinyLife.Goals.LifeGoal>
nameWithType.vb: ReadOnlyDictionary(Of String, LifeGoal)
fullName.vb: System.Collections.ObjectModel.ReadOnlyDictionary(Of System.String, TinyLife.Goals.LifeGoal)
name.vb: ReadOnlyDictionary(Of String, LifeGoal)
spec.csharp:
- uid: System.Collections.ObjectModel.ReadOnlyDictionary`2
name: ReadOnlyDictionary
nameWithType: ReadOnlyDictionary
fullName: System.Collections.ObjectModel.ReadOnlyDictionary
isExternal: true
- name: <
nameWithType: <
fullName: <
- uid: System.String
name: String
nameWithType: String
fullName: System.String
isExternal: true
- name: ', '
nameWithType: ', '
fullName: ', '
- uid: TinyLife.Goals.LifeGoal
name: LifeGoal
nameWithType: LifeGoal
fullName: TinyLife.Goals.LifeGoal
- name: '>'
nameWithType: '>'
fullName: '>'
spec.vb:
- uid: System.Collections.ObjectModel.ReadOnlyDictionary`2
name: ReadOnlyDictionary
nameWithType: ReadOnlyDictionary
fullName: System.Collections.ObjectModel.ReadOnlyDictionary
isExternal: true
- name: '(Of '
nameWithType: '(Of '
fullName: '(Of '
- uid: System.String
name: String
nameWithType: String
fullName: System.String
isExternal: true
- name: ', '
nameWithType: ', '
fullName: ', '
- uid: TinyLife.Goals.LifeGoal
name: LifeGoal
nameWithType: LifeGoal
fullName: TinyLife.Goals.LifeGoal
- name: )
nameWithType: )
fullName: )
- uid: System.Collections.ObjectModel.ReadOnlyDictionary`2
commentId: T:System.Collections.ObjectModel.ReadOnlyDictionary`2
isExternal: true
name: ReadOnlyDictionary<TKey, TValue>
nameWithType: ReadOnlyDictionary<TKey, TValue>
fullName: System.Collections.ObjectModel.ReadOnlyDictionary<TKey, TValue>
nameWithType.vb: ReadOnlyDictionary(Of TKey, TValue)
fullName.vb: System.Collections.ObjectModel.ReadOnlyDictionary(Of TKey, TValue)
name.vb: ReadOnlyDictionary(Of TKey, TValue)
spec.csharp:
- uid: System.Collections.ObjectModel.ReadOnlyDictionary`2
name: ReadOnlyDictionary
nameWithType: ReadOnlyDictionary
fullName: System.Collections.ObjectModel.ReadOnlyDictionary
isExternal: true
- name: <
nameWithType: <
fullName: <
- name: TKey
nameWithType: TKey
fullName: TKey
- name: ', '
nameWithType: ', '
fullName: ', '
- name: TValue
nameWithType: TValue
fullName: TValue
- name: '>'
nameWithType: '>'
fullName: '>'
spec.vb:
- uid: System.Collections.ObjectModel.ReadOnlyDictionary`2
name: ReadOnlyDictionary
nameWithType: ReadOnlyDictionary
fullName: System.Collections.ObjectModel.ReadOnlyDictionary
isExternal: true
- name: '(Of '
nameWithType: '(Of '
fullName: '(Of '
- name: TKey
nameWithType: TKey
fullName: TKey
- name: ', '
nameWithType: ', '
fullName: ', '
- name: TValue
nameWithType: TValue
fullName: TValue
- name: )
nameWithType: )
fullName: )
- uid: System.Collections.ObjectModel
commentId: N:System.Collections.ObjectModel
isExternal: true
name: System.Collections.ObjectModel
nameWithType: System.Collections.ObjectModel
fullName: System.Collections.ObjectModel
- uid: TinyLife.Goals.LifeGoal
commentId: T:TinyLife.Goals.LifeGoal
parent: TinyLife.Goals
name: LifeGoal
nameWithType: LifeGoal
fullName: TinyLife.Goals.LifeGoal
- uid: TinyLife.Goals.LifeGoal.Instance.Advance
commentId: M:TinyLife.Goals.LifeGoal.Instance.Advance
isExternal: true
- uid: System.Action{TinyLife.Goals.LifeGoal.Instance}
commentId: T:System.Action{TinyLife.Goals.LifeGoal.Instance}
parent: System
definition: System.Action`1
name: Action<LifeGoal.Instance>
nameWithType: Action<LifeGoal.Instance>
fullName: System.Action<TinyLife.Goals.LifeGoal.Instance>
nameWithType.vb: Action(Of LifeGoal.Instance)
fullName.vb: System.Action(Of TinyLife.Goals.LifeGoal.Instance)
name.vb: Action(Of LifeGoal.Instance)
spec.csharp:
- uid: System.Action`1
name: Action
nameWithType: Action
fullName: System.Action
isExternal: true
- name: <
nameWithType: <
fullName: <
- uid: TinyLife.Goals.LifeGoal.Instance
name: LifeGoal.Instance
nameWithType: LifeGoal.Instance
fullName: TinyLife.Goals.LifeGoal.Instance
- name: '>'
nameWithType: '>'
fullName: '>'
spec.vb:
- uid: System.Action`1
name: Action
nameWithType: Action
fullName: System.Action
isExternal: true
- name: '(Of '
nameWithType: '(Of '
fullName: '(Of '
- uid: TinyLife.Goals.LifeGoal.Instance
name: LifeGoal.Instance
nameWithType: LifeGoal.Instance
fullName: TinyLife.Goals.LifeGoal.Instance
- name: )
nameWithType: )
fullName: )
- uid: System.Action`1
commentId: T:System.Action`1
isExternal: true
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
nameWithType: Action
fullName: System.Action
isExternal: true
- name: <
nameWithType: <
fullName: <
- name: T
nameWithType: T
fullName: T
- name: '>'
nameWithType: '>'
fullName: '>'
spec.vb:
- uid: System.Action`1
name: Action
nameWithType: Action
fullName: System.Action
isExternal: true
- name: '(Of '
nameWithType: '(Of '
fullName: '(Of '
- name: T
nameWithType: T
fullName: T
- name: )
nameWithType: )
fullName: )
- uid: TinyLife.Goals.LifeGoal.Goals
commentId: F:TinyLife.Goals.LifeGoal.Goals
isExternal: true
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
name: String
nameWithType: String
fullName: System.String
- uid: TinyLife.Goals.GoalSetInfo[]
isExternal: true
name: GoalSetInfo[]
nameWithType: GoalSetInfo[]
fullName: TinyLife.Goals.GoalSetInfo[]
nameWithType.vb: GoalSetInfo()
fullName.vb: TinyLife.Goals.GoalSetInfo()
name.vb: GoalSetInfo()
spec.csharp:
- uid: TinyLife.Goals.GoalSetInfo
name: GoalSetInfo
nameWithType: GoalSetInfo
fullName: TinyLife.Goals.GoalSetInfo
- name: '[]'
nameWithType: '[]'
fullName: '[]'
spec.vb:
- uid: TinyLife.Goals.GoalSetInfo
name: GoalSetInfo
nameWithType: GoalSetInfo
fullName: TinyLife.Goals.GoalSetInfo
- name: ()
nameWithType: ()
fullName: ()
- uid: TinyLife.PersonalityType.TypeCategory
commentId: T:TinyLife.PersonalityType.TypeCategory
parent: TinyLife
name: PersonalityType.TypeCategory
nameWithType: PersonalityType.TypeCategory
fullName: TinyLife.PersonalityType.TypeCategory
- uid: TinyLife.PersonalityType.TypeCategory.Hidden
commentId: F:TinyLife.PersonalityType.TypeCategory.Hidden
isExternal: true
- uid: TinyLife.Goals.LifeGoal.AllowedAges*
commentId: Overload:TinyLife.Goals.LifeGoal.AllowedAges
name: AllowedAges
nameWithType: LifeGoal.AllowedAges
fullName: TinyLife.Goals.LifeGoal.AllowedAges
- uid: TinyLife.Objects.AgeGroup
commentId: T:TinyLife.Objects.AgeGroup
parent: TinyLife.Objects
name: AgeGroup
nameWithType: AgeGroup
fullName: TinyLife.Objects.AgeGroup
- uid: TinyLife.Objects
commentId: N:TinyLife.Objects
name: TinyLife.Objects
nameWithType: TinyLife.Objects
fullName: TinyLife.Objects
- uid: TinyLife.Goals.LifeGoal.#ctor*
commentId: Overload:TinyLife.Goals.LifeGoal.#ctor
name: LifeGoal
nameWithType: LifeGoal.LifeGoal
fullName: TinyLife.Goals.LifeGoal.LifeGoal
- uid: TinyLife.Objects.Person
commentId: T:TinyLife.Objects.Person
parent: TinyLife.Objects
name: Person
nameWithType: Person
fullName: TinyLife.Objects.Person
- uid: TinyLife.Goals.LifeGoal.RewardPersonality
commentId: F:TinyLife.Goals.LifeGoal.RewardPersonality
isExternal: true
- uid: TinyLife.Goals.LifeGoal.IsCompleted*
commentId: Overload:TinyLife.Goals.LifeGoal.IsCompleted
name: IsCompleted
nameWithType: LifeGoal.IsCompleted
fullName: TinyLife.Goals.LifeGoal.IsCompleted
- uid: System.Boolean
commentId: T:System.Boolean
parent: System
isExternal: true
name: Boolean
nameWithType: Boolean
fullName: System.Boolean
- uid: TinyLife.Goals.LifeGoal.Register*
commentId: Overload:TinyLife.Goals.LifeGoal.Register
name: Register
nameWithType: LifeGoal.Register
fullName: TinyLife.Goals.LifeGoal.Register
Reference in a new issue View git blame Copy permalink