Ellpeck/TinyLifeWeb
1
0
Fork 0
mirror of https://github.com/Ellpeck/TinyLifeWeb.git synced 2024-11-05 04:29:08 +01:00
Code Issues Projects Releases Wiki Activity
TinyLifeWeb/docs/api/TinyLife.Objects.WornClothes.yml
Ell fd7401dd85 0.19.0
2022-01-01 17:06:03 +01:00

777 lines
22 KiB
YAML
Raw Blame History

### YamlMime:ManagedReference
items:
- uid: TinyLife.Objects.WornClothes
commentId: T:TinyLife.Objects.WornClothes
id: WornClothes
parent: TinyLife.Objects
children:
- TinyLife.Objects.WornClothes.#ctor(TinyLife.Objects.Clothes,System.Int32[])
- TinyLife.Objects.WornClothes.Colors
- TinyLife.Objects.WornClothes.FromStorage
- TinyLife.Objects.WornClothes.GetColor(System.Int32)
- TinyLife.Objects.WornClothes.Type
- TinyLife.Objects.WornClothes.Validate
langs:
- csharp
- vb
name: WornClothes
nameWithType: WornClothes
fullName: TinyLife.Objects.WornClothes
type: Class
source:
remote:
path: TinyLife/Objects/Clothes.cs
branch: master
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: WornClothes
path: Objects/Clothes.cs
startLine: 290
assemblies:
- Tiny Life
namespace: TinyLife.Objects
summary: "\nWornClothes is a wrapper around <xref href=\"TinyLife.Objects.Clothes\" data-throw-if-not-resolved=\"false\"></xref> that additionally stores the colors and whether or not the clothes are from the <xref href=\"TinyLife.World.Household.ClothesStorage\" data-throw-if-not-resolved=\"false\"></xref> or not\n"
example: []
syntax:
content: >-
[DataContract]
public class WornClothes
content.vb: >-
<DataContract>
Public Class WornClothes
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.Objects.WornClothes.TinyLife.Utilities.Extensions.JsonCopy``1
attributes:
- type: System.Runtime.Serialization.DataContractAttribute
ctor: System.Runtime.Serialization.DataContractAttribute.#ctor
arguments: []
modifiers.csharp:
- public
- class
modifiers.vb:
- Public
- Class
- uid: TinyLife.Objects.WornClothes.Type
commentId: F:TinyLife.Objects.WornClothes.Type
id: Type
parent: TinyLife.Objects.WornClothes
langs:
- csharp
- vb
name: Type
nameWithType: WornClothes.Type
fullName: TinyLife.Objects.WornClothes.Type
type: Field
source:
remote:
path: TinyLife/Objects/Clothes.cs
branch: master
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Type
path: Objects/Clothes.cs
startLine: 297
assemblies:
- Tiny Life
namespace: TinyLife.Objects
summary: "\nThe <xref href=\"TinyLife.Objects.Clothes\" data-throw-if-not-resolved=\"false\"></xref> type that these worn clothes reference\n"
example: []
syntax:
content: >-
[DataMember]
public readonly Clothes Type
return:
type: TinyLife.Objects.Clothes
content.vb: >-
<DataMember>
Public ReadOnly Type As Clothes
attributes:
- type: System.Runtime.Serialization.DataMemberAttribute
ctor: System.Runtime.Serialization.DataMemberAttribute.#ctor
arguments: []
modifiers.csharp:
- public
- readonly
modifiers.vb:
- Public
- ReadOnly
- uid: TinyLife.Objects.WornClothes.Colors
commentId: F:TinyLife.Objects.WornClothes.Colors
id: Colors
parent: TinyLife.Objects.WornClothes
langs:
- csharp
- vb
name: Colors
nameWithType: WornClothes.Colors
fullName: TinyLife.Objects.WornClothes.Colors
type: Field
source:
remote:
path: TinyLife/Objects/Clothes.cs
branch: master
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Colors
path: Objects/Clothes.cs
startLine: 304
assemblies:
- Tiny Life
namespace: TinyLife.Objects
summary: "\nThe colors of this <xref href=\"TinyLife.Objects.Clothes\" data-throw-if-not-resolved=\"false\"></xref> instance.\nEach index references the color of the underlying <xref href=\"TinyLife.Objects.WornClothes.Type\" data-throw-if-not-resolved=\"false\"></xref>&apos;s <xref href=\"TinyLife.Objects.Clothes.Colors\" data-throw-if-not-resolved=\"false\"></xref>.\nThe actual color can be retrieved easily using <xref href=\"TinyLife.Objects.WornClothes.GetColor(System.Int32)\" data-throw-if-not-resolved=\"false\"></xref>.\n"
example: []
syntax:
content: >-
[DataMember]
public int[] Colors
return:
type: System.Int32[]
content.vb: >-
<DataMember>
Public Colors As Integer()
attributes:
- type: System.Runtime.Serialization.DataMemberAttribute
ctor: System.Runtime.Serialization.DataMemberAttribute.#ctor
arguments: []
modifiers.csharp:
- public
modifiers.vb:
- Public
- uid: TinyLife.Objects.WornClothes.FromStorage
commentId: F:TinyLife.Objects.WornClothes.FromStorage
id: FromStorage
parent: TinyLife.Objects.WornClothes
langs:
- csharp
- vb
name: FromStorage
nameWithType: WornClothes.FromStorage
fullName: TinyLife.Objects.WornClothes.FromStorage
type: Field
source:
remote:
path: TinyLife/Objects/Clothes.cs
branch: master
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: FromStorage
path: Objects/Clothes.cs
startLine: 309
assemblies:
- Tiny Life
namespace: TinyLife.Objects
summary: "\nThis value is true if this clothes item is from the <xref href=\"TinyLife.World.Household.ClothesStorage\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax:
content: >-
[DataMember]
public bool FromStorage
return:
type: System.Boolean
content.vb: >-
<DataMember>
Public FromStorage As Boolean
attributes:
- type: System.Runtime.Serialization.DataMemberAttribute
ctor: System.Runtime.Serialization.DataMemberAttribute.#ctor
arguments: []
modifiers.csharp:
- public
modifiers.vb:
- Public
- uid: TinyLife.Objects.WornClothes.#ctor(TinyLife.Objects.Clothes,System.Int32[])
commentId: M:TinyLife.Objects.WornClothes.#ctor(TinyLife.Objects.Clothes,System.Int32[])
id: '#ctor(TinyLife.Objects.Clothes,System.Int32[])'
parent: TinyLife.Objects.WornClothes
langs:
- csharp
- vb
name: WornClothes(Clothes, Int32[])
nameWithType: WornClothes.WornClothes(Clothes, Int32[])
fullName: TinyLife.Objects.WornClothes.WornClothes(TinyLife.Objects.Clothes, System.Int32[])
type: Constructor
source:
remote:
path: TinyLife/Objects/Clothes.cs
branch: master
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: .ctor
path: Objects/Clothes.cs
startLine: 316
assemblies:
- Tiny Life
namespace: TinyLife.Objects
summary: "\nCreates a new worn <xref href=\"TinyLife.Objects.Clothes\" data-throw-if-not-resolved=\"false\"></xref> instance with the given settings\n"
example: []
syntax:
content: public WornClothes(Clothes type, int[] colors)
parameters:
- id: type
type: TinyLife.Objects.Clothes
description: The <xref href="TinyLife.Objects.Clothes" data-throw-if-not-resolved="false"></xref> type
- id: colors
type: System.Int32[]
description: The indices of the colors that this instance should have
content.vb: Public Sub New(type As Clothes, colors As Integer())
overload: TinyLife.Objects.WornClothes.#ctor*
nameWithType.vb: WornClothes.WornClothes(Clothes, Int32())
modifiers.csharp:
- public
modifiers.vb:
- Public
fullName.vb: TinyLife.Objects.WornClothes.WornClothes(TinyLife.Objects.Clothes, System.Int32())
name.vb: WornClothes(Clothes, Int32())
- uid: TinyLife.Objects.WornClothes.GetColor(System.Int32)
commentId: M:TinyLife.Objects.WornClothes.GetColor(System.Int32)
id: GetColor(System.Int32)
parent: TinyLife.Objects.WornClothes
langs:
- csharp
- vb
name: GetColor(Int32)
nameWithType: WornClothes.GetColor(Int32)
fullName: TinyLife.Objects.WornClothes.GetColor(System.Int32)
type: Method
source:
remote:
path: TinyLife/Objects/Clothes.cs
branch: master
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: GetColor
path: Objects/Clothes.cs
startLine: 326
assemblies:
- Tiny Life
namespace: TinyLife.Objects
summary: "\nReturns the <xref href=\"Microsoft.Xna.Framework.Color\" data-throw-if-not-resolved=\"false\"></xref> of the given layer\n"
example: []
syntax:
content: public Color GetColor(int layer)
parameters:
- id: layer
type: System.Int32
description: The layer to query the color for
return:
type: Microsoft.Xna.Framework.Color
description: The color that the layer has, based on <xref href="TinyLife.Objects.WornClothes.Colors" data-throw-if-not-resolved="false"></xref>
content.vb: Public Function GetColor(layer As Integer) As Color
overload: TinyLife.Objects.WornClothes.GetColor*
modifiers.csharp:
- public
modifiers.vb:
- Public
- uid: TinyLife.Objects.WornClothes.Validate
commentId: M:TinyLife.Objects.WornClothes.Validate
id: Validate
parent: TinyLife.Objects.WornClothes
langs:
- csharp
- vb
name: Validate()
nameWithType: WornClothes.Validate()
fullName: TinyLife.Objects.WornClothes.Validate()
type: Method
source:
remote:
path: TinyLife/Objects/Clothes.cs
branch: master
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Validate
path: Objects/Clothes.cs
startLine: 334
assemblies:
- Tiny Life
namespace: TinyLife.Objects
summary: "\nThis method is called when this object is loaded from disk.\n"
example: []
syntax:
content: public bool Validate()
return:
type: System.Boolean
description: false if the object is not valid, true otherwise
content.vb: Public Function Validate As Boolean
overload: TinyLife.Objects.WornClothes.Validate*
modifiers.csharp:
- public
modifiers.vb:
- Public
references:
- uid: TinyLife.Objects.Clothes
commentId: T:TinyLife.Objects.Clothes
parent: TinyLife.Objects
name: Clothes
nameWithType: Clothes
fullName: TinyLife.Objects.Clothes
- uid: TinyLife.World.Household.ClothesStorage
commentId: F:TinyLife.World.Household.ClothesStorage
isExternal: true
- uid: TinyLife.Objects
commentId: N:TinyLife.Objects
name: TinyLife.Objects
nameWithType: TinyLife.Objects
fullName: TinyLife.Objects
- 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.Objects.WornClothes.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<WornClothes>()
nameWithType: Extensions.JsonCopy<WornClothes>()
fullName: TinyLife.Utilities.Extensions.JsonCopy<TinyLife.Objects.WornClothes>()
nameWithType.vb: Extensions.JsonCopy(Of WornClothes)()
fullName.vb: TinyLife.Utilities.Extensions.JsonCopy(Of TinyLife.Objects.WornClothes)()
name.vb: JsonCopy(Of WornClothes)()
spec.csharp:
- uid: TinyLife.Utilities.Extensions.JsonCopy``1
name: JsonCopy<WornClothes>
nameWithType: Extensions.JsonCopy<WornClothes>
fullName: TinyLife.Utilities.Extensions.JsonCopy<TinyLife.Objects.WornClothes>
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
spec.vb:
- uid: TinyLife.Utilities.Extensions.JsonCopy``1
name: JsonCopy(Of WornClothes)
nameWithType: Extensions.JsonCopy(Of WornClothes)
fullName: TinyLife.Utilities.Extensions.JsonCopy(Of TinyLife.Objects.WornClothes)
- name: (
nameWithType: (
fullName: (
- name: )
nameWithType: )
fullName: )
- 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: TinyLife.Objects.WornClothes.Type
commentId: F:TinyLife.Objects.WornClothes.Type
isExternal: true
- uid: TinyLife.Objects.Clothes.Colors
commentId: F:TinyLife.Objects.Clothes.Colors
isExternal: true
- uid: TinyLife.Objects.WornClothes.GetColor(System.Int32)
commentId: M:TinyLife.Objects.WornClothes.GetColor(System.Int32)
isExternal: true
- uid: System.Int32[]
isExternal: true
name: Int32[]
nameWithType: Int32[]
fullName: System.Int32[]
nameWithType.vb: Int32()
fullName.vb: System.Int32()
name.vb: Int32()
spec.csharp:
- uid: System.Int32
name: Int32
nameWithType: Int32
fullName: System.Int32
isExternal: true
- name: '[]'
nameWithType: '[]'
fullName: '[]'
spec.vb:
- uid: System.Int32
name: Int32
nameWithType: Int32
fullName: System.Int32
isExternal: true
- name: ()
nameWithType: ()
fullName: ()
- uid: System.Boolean
commentId: T:System.Boolean
parent: System
isExternal: true
name: Boolean
nameWithType: Boolean
fullName: System.Boolean
- uid: TinyLife.Objects.WornClothes.#ctor*
commentId: Overload:TinyLife.Objects.WornClothes.#ctor
name: WornClothes
nameWithType: WornClothes.WornClothes
fullName: TinyLife.Objects.WornClothes.WornClothes
- uid: Microsoft.Xna.Framework.Color
commentId: T:Microsoft.Xna.Framework.Color
parent: Microsoft.Xna.Framework
isExternal: true
name: Color
nameWithType: Color
fullName: Microsoft.Xna.Framework.Color
- uid: TinyLife.Objects.WornClothes.Colors
commentId: F:TinyLife.Objects.WornClothes.Colors
isExternal: true
- uid: TinyLife.Objects.WornClothes.GetColor*
commentId: Overload:TinyLife.Objects.WornClothes.GetColor
name: GetColor
nameWithType: WornClothes.GetColor
fullName: TinyLife.Objects.WornClothes.GetColor
- uid: System.Int32
commentId: T:System.Int32
parent: System
isExternal: true
name: Int32
nameWithType: Int32
fullName: System.Int32
- uid: Microsoft.Xna.Framework
commentId: N:Microsoft.Xna.Framework
isExternal: true
name: Microsoft.Xna.Framework
nameWithType: Microsoft.Xna.Framework
fullName: Microsoft.Xna.Framework
- uid: TinyLife.Objects.WornClothes.Validate*
commentId: Overload:TinyLife.Objects.WornClothes.Validate
name: Validate
nameWithType: WornClothes.Validate
fullName: TinyLife.Objects.WornClothes.Validate
Reference in a new issue View git blame Copy permalink