TinyLifeWeb/docs/api/TinyLife.Objects.LightFurniture.Settings.yml
2023-11-18 12:57:05 +01:00

672 lines
22 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: TinyLife.Objects.LightFurniture.Settings
commentId: T:TinyLife.Objects.LightFurniture.Settings
id: LightFurniture.Settings
parent: TinyLife.Objects
children:
- TinyLife.Objects.LightFurniture.Settings.CreateLights
- TinyLife.Objects.LightFurniture.Settings.FireParticleOffsets
- TinyLife.Objects.LightFurniture.Settings.Flickers
- TinyLife.Objects.LightFurniture.Settings.IsAutomatic
- TinyLife.Objects.LightFurniture.Settings.IsElectrical
langs:
- csharp
- vb
name: LightFurniture.Settings
nameWithType: LightFurniture.Settings
fullName: TinyLife.Objects.LightFurniture.Settings
type: Struct
source:
remote:
path: TinyLife/Objects/LightFurniture.cs
branch: 0.37.5-dev
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Settings
path: ../TinyLife/Objects/LightFurniture.cs
startLine: 138
assemblies:
- Tiny Life
namespace: TinyLife.Objects
summary: "\nA set of settings for a <xref href=\"TinyLife.Objects.LightFurniture\" data-throw-if-not-resolved=\"false\"></xref>, which can be added to a furniture type using <xref href=\"TinyLife.Objects.FurnitureType.TypeSettings.LightSettings\" data-throw-if-not-resolved=\"false\"></xref>.\n"
example: []
syntax:
content: public struct LightFurniture.Settings
content.vb: Public Structure LightFurniture.Settings
inheritedMembers:
- System.ValueType.Equals(System.Object)
- System.ValueType.GetHashCode
- System.ValueType.ToString
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetType
- System.Object.ReferenceEquals(System.Object,System.Object)
extensionMethods:
- TinyLife.Objects.LightFurniture.Settings.TinyLife.Utilities.Extensions.JsonCopy``1
- uid: TinyLife.Objects.LightFurniture.Settings.CreateLights
commentId: F:TinyLife.Objects.LightFurniture.Settings.CreateLights
id: CreateLights
parent: TinyLife.Objects.LightFurniture.Settings
langs:
- csharp
- vb
name: CreateLights
nameWithType: LightFurniture.Settings.CreateLights
fullName: TinyLife.Objects.LightFurniture.Settings.CreateLights
type: Field
source:
remote:
path: TinyLife/Objects/LightFurniture.cs
branch: 0.37.5-dev
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: CreateLights
path: ../TinyLife/Objects/LightFurniture.cs
startLine: 143
assemblies:
- Tiny Life
namespace: TinyLife.Objects
summary: "\nA function that is used to create the lights for the <xref href=\"TinyLife.Objects.LightFurniture\" data-throw-if-not-resolved=\"false\"></xref>.\n"
example: []
syntax:
content: public Func<LightFurniture, Light[]> CreateLights
return:
type: System.Func{TinyLife.Objects.LightFurniture,TinyLife.Objects.Light[]}
content.vb: Public CreateLights As Func(Of LightFurniture, Light())
- uid: TinyLife.Objects.LightFurniture.Settings.IsElectrical
commentId: F:TinyLife.Objects.LightFurniture.Settings.IsElectrical
id: IsElectrical
parent: TinyLife.Objects.LightFurniture.Settings
langs:
- csharp
- vb
name: IsElectrical
nameWithType: LightFurniture.Settings.IsElectrical
fullName: TinyLife.Objects.LightFurniture.Settings.IsElectrical
type: Field
source:
remote:
path: TinyLife/Objects/LightFurniture.cs
branch: 0.37.5-dev
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: IsElectrical
path: ../TinyLife/Objects/LightFurniture.cs
startLine: 147
assemblies:
- Tiny Life
namespace: TinyLife.Objects
summary: "\nWhether the light furniture is electrical. If it is, it will automatically be <xref href=\"TinyLife.Objects.LightFurniture.IsDisabled\" data-throw-if-not-resolved=\"false\"></xref> if the owning household&apos;s bills have not been paid.\n"
example: []
syntax:
content: public bool IsElectrical
return:
type: System.Boolean
content.vb: Public IsElectrical As Boolean
- uid: TinyLife.Objects.LightFurniture.Settings.Flickers
commentId: F:TinyLife.Objects.LightFurniture.Settings.Flickers
id: Flickers
parent: TinyLife.Objects.LightFurniture.Settings
langs:
- csharp
- vb
name: Flickers
nameWithType: LightFurniture.Settings.Flickers
fullName: TinyLife.Objects.LightFurniture.Settings.Flickers
type: Field
source:
remote:
path: TinyLife/Objects/LightFurniture.cs
branch: 0.37.5-dev
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Flickers
path: ../TinyLife/Objects/LightFurniture.cs
startLine: 151
assemblies:
- Tiny Life
namespace: TinyLife.Objects
summary: "\nWhether the light furniture flickers, which causes the lights created in <xref href=\"TinyLife.Objects.LightFurniture.Settings.CreateLights\" data-throw-if-not-resolved=\"false\"></xref> to change size slightly over time.\n"
example: []
syntax:
content: public bool Flickers
return:
type: System.Boolean
content.vb: Public Flickers As Boolean
- uid: TinyLife.Objects.LightFurniture.Settings.FireParticleOffsets
commentId: F:TinyLife.Objects.LightFurniture.Settings.FireParticleOffsets
id: FireParticleOffsets
parent: TinyLife.Objects.LightFurniture.Settings
langs:
- csharp
- vb
name: FireParticleOffsets
nameWithType: LightFurniture.Settings.FireParticleOffsets
fullName: TinyLife.Objects.LightFurniture.Settings.FireParticleOffsets
type: Field
source:
remote:
path: TinyLife/Objects/LightFurniture.cs
branch: 0.37.5-dev
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: FireParticleOffsets
path: ../TinyLife/Objects/LightFurniture.cs
startLine: 157
assemblies:
- Tiny Life
namespace: TinyLife.Objects
summary: "\nA set of positions that fire particles should be displayed with, based on the given <xref href=\"TinyLife.Objects.LightFurniture\" data-throw-if-not-resolved=\"false\"></xref> instance&apos;s position.\nThese offsets are applied to <xref href=\"TinyLife.Objects.Particle.DrawOffset\" data-throw-if-not-resolved=\"false\"></xref>.\nIf this is null, no fire particles will be displayed.\n"
example: []
syntax:
content: public Func<LightFurniture, Vector2>[] FireParticleOffsets
return:
type: System.Func{TinyLife.Objects.LightFurniture,Microsoft.Xna.Framework.Vector2}[]
content.vb: Public FireParticleOffsets As Func(Of LightFurniture, Vector2)()
- uid: TinyLife.Objects.LightFurniture.Settings.IsAutomatic
commentId: F:TinyLife.Objects.LightFurniture.Settings.IsAutomatic
id: IsAutomatic
parent: TinyLife.Objects.LightFurniture.Settings
langs:
- csharp
- vb
name: IsAutomatic
nameWithType: LightFurniture.Settings.IsAutomatic
fullName: TinyLife.Objects.LightFurniture.Settings.IsAutomatic
type: Field
source:
remote:
path: TinyLife/Objects/LightFurniture.cs
branch: 0.37.5-dev
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: IsAutomatic
path: ../TinyLife/Objects/LightFurniture.cs
startLine: 162
assemblies:
- Tiny Life
namespace: TinyLife.Objects
summary: "\nWhether this light furniture is lit and unlit automatically based on the time of day.\nLight furniture with this setting should not use the <xref href=\"TinyLife.Objects.ObjectCategory.Lamp\" data-throw-if-not-resolved=\"false\"></xref> category, as that is what allows it to be toggled on and off by people.\n"
example: []
syntax:
content: public bool IsAutomatic
return:
type: System.Boolean
content.vb: Public IsAutomatic As Boolean
references:
- uid: TinyLife.Objects.LightFurniture
commentId: T:TinyLife.Objects.LightFurniture
parent: TinyLife.Objects
name: LightFurniture
nameWithType: LightFurniture
fullName: TinyLife.Objects.LightFurniture
- uid: TinyLife.Objects.FurnitureType.TypeSettings.LightSettings
commentId: F:TinyLife.Objects.FurnitureType.TypeSettings.LightSettings
name: LightSettings
nameWithType: FurnitureType.TypeSettings.LightSettings
fullName: TinyLife.Objects.FurnitureType.TypeSettings.LightSettings
- uid: TinyLife.Objects
commentId: N:TinyLife.Objects
name: TinyLife.Objects
nameWithType: TinyLife.Objects
fullName: TinyLife.Objects
spec.csharp:
- uid: TinyLife
name: TinyLife
- name: .
- uid: TinyLife.Objects
name: Objects
spec.vb:
- uid: TinyLife
name: TinyLife
- name: .
- uid: TinyLife.Objects
name: Objects
- uid: System.ValueType.Equals(System.Object)
commentId: M:System.ValueType.Equals(System.Object)
parent: System.ValueType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.valuetype.equals
name: Equals(object)
nameWithType: ValueType.Equals(object)
fullName: System.ValueType.Equals(object)
nameWithType.vb: ValueType.Equals(Object)
fullName.vb: System.ValueType.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.ValueType.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.valuetype.equals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.ValueType.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.valuetype.equals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.ValueType.GetHashCode
commentId: M:System.ValueType.GetHashCode
parent: System.ValueType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.valuetype.gethashcode
name: GetHashCode()
nameWithType: ValueType.GetHashCode()
fullName: System.ValueType.GetHashCode()
spec.csharp:
- uid: System.ValueType.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.valuetype.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.ValueType.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.valuetype.gethashcode
- name: (
- name: )
- uid: System.ValueType.ToString
commentId: M:System.ValueType.ToString
parent: System.ValueType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.valuetype.tostring
name: ToString()
nameWithType: ValueType.ToString()
fullName: System.ValueType.ToString()
spec.csharp:
- uid: System.ValueType.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.valuetype.tostring
- name: (
- name: )
spec.vb:
- uid: System.ValueType.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.valuetype.tostring
- name: (
- 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.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.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: TinyLife.Objects.LightFurniture.Settings.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<Settings>(Settings)
nameWithType: Extensions.JsonCopy<LightFurniture.Settings>(LightFurniture.Settings)
fullName: TinyLife.Utilities.Extensions.JsonCopy<TinyLife.Objects.LightFurniture.Settings>(TinyLife.Objects.LightFurniture.Settings)
nameWithType.vb: Extensions.JsonCopy(Of LightFurniture.Settings)(LightFurniture.Settings)
fullName.vb: TinyLife.Utilities.Extensions.JsonCopy(Of TinyLife.Objects.LightFurniture.Settings)(TinyLife.Objects.LightFurniture.Settings)
name.vb: JsonCopy(Of Settings)(Settings)
spec.csharp:
- uid: TinyLife.Utilities.Extensions.JsonCopy``1(TinyLife.Objects.LightFurniture.Settings)
name: JsonCopy
- name: <
- uid: TinyLife.Objects.LightFurniture.Settings
name: Settings
- name: '>'
- name: (
- uid: TinyLife.Objects.LightFurniture.Settings
name: Settings
- name: )
spec.vb:
- uid: TinyLife.Utilities.Extensions.JsonCopy``1(TinyLife.Objects.LightFurniture.Settings)
name: JsonCopy
- name: (
- name: Of
- name: " "
- uid: TinyLife.Objects.LightFurniture.Settings
name: Settings
- name: )
- name: (
- uid: TinyLife.Objects.LightFurniture.Settings
name: Settings
- name: )
- uid: System.ValueType
commentId: T:System.ValueType
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.valuetype
name: ValueType
nameWithType: ValueType
fullName: System.ValueType
- 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: 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
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: )
spec.vb:
- uid: TinyLife.Utilities.Extensions.JsonCopy``1(``0)
name: JsonCopy
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: )
- uid: TinyLife.Utilities.Extensions
commentId: T:TinyLife.Utilities.Extensions
parent: TinyLife.Utilities
name: Extensions
nameWithType: Extensions
fullName: TinyLife.Utilities.Extensions
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: TinyLife.Utilities
commentId: N:TinyLife.Utilities
name: TinyLife.Utilities
nameWithType: TinyLife.Utilities
fullName: TinyLife.Utilities
spec.csharp:
- uid: TinyLife
name: TinyLife
- name: .
- uid: TinyLife.Utilities
name: Utilities
spec.vb:
- uid: TinyLife
name: TinyLife
- name: .
- uid: TinyLife.Utilities
name: Utilities
- uid: System.Func{TinyLife.Objects.LightFurniture,TinyLife.Objects.Light[]}
commentId: T:System.Func{TinyLife.Objects.LightFurniture,TinyLife.Objects.Light[]}
parent: System
definition: System.Func`2
href: https://learn.microsoft.com/dotnet/api/system.func-2
name: Func<LightFurniture, Light[]>
nameWithType: Func<LightFurniture, Light[]>
fullName: System.Func<TinyLife.Objects.LightFurniture, TinyLife.Objects.Light[]>
nameWithType.vb: Func(Of LightFurniture, Light())
fullName.vb: System.Func(Of TinyLife.Objects.LightFurniture, TinyLife.Objects.Light())
name.vb: Func(Of LightFurniture, Light())
spec.csharp:
- uid: System.Func`2
name: Func
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.func-2
- name: <
- uid: TinyLife.Objects.LightFurniture
name: LightFurniture
- name: ','
- name: " "
- uid: TinyLife.Objects.Light
name: Light
- name: '['
- name: ']'
- name: '>'
spec.vb:
- uid: System.Func`2
name: Func
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.func-2
- name: (
- name: Of
- name: " "
- uid: TinyLife.Objects.LightFurniture
name: LightFurniture
- name: ','
- name: " "
- uid: TinyLife.Objects.Light
name: Light
- name: (
- name: )
- name: )
- uid: System.Func`2
commentId: T:System.Func`2
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.func-2
name: Func<T, TResult>
nameWithType: Func<T, TResult>
fullName: System.Func<T, TResult>
nameWithType.vb: Func(Of T, TResult)
fullName.vb: System.Func(Of T, TResult)
name.vb: Func(Of T, TResult)
spec.csharp:
- uid: System.Func`2
name: Func
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.func-2
- name: <
- name: T
- name: ','
- name: " "
- name: TResult
- name: '>'
spec.vb:
- uid: System.Func`2
name: Func
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.func-2
- name: (
- name: Of
- name: " "
- name: T
- name: ','
- name: " "
- name: TResult
- name: )
- uid: TinyLife.Objects.LightFurniture.IsDisabled
commentId: F:TinyLife.Objects.LightFurniture.IsDisabled
parent: TinyLife.Objects.LightFurniture
name: IsDisabled
nameWithType: LightFurniture.IsDisabled
fullName: TinyLife.Objects.LightFurniture.IsDisabled
- uid: System.Boolean
commentId: T:System.Boolean
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
name: bool
nameWithType: bool
fullName: bool
nameWithType.vb: Boolean
fullName.vb: Boolean
name.vb: Boolean
- uid: TinyLife.Objects.LightFurniture.Settings.CreateLights
commentId: F:TinyLife.Objects.LightFurniture.Settings.CreateLights
name: CreateLights
nameWithType: LightFurniture.Settings.CreateLights
fullName: TinyLife.Objects.LightFurniture.Settings.CreateLights
- uid: TinyLife.Objects.Particle.DrawOffset
commentId: F:TinyLife.Objects.Particle.DrawOffset
name: DrawOffset
nameWithType: Particle.DrawOffset
fullName: TinyLife.Objects.Particle.DrawOffset
- uid: System.Func{TinyLife.Objects.LightFurniture,Microsoft.Xna.Framework.Vector2}[]
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.func-2
name: Func<LightFurniture, Vector2>[]
nameWithType: Func<LightFurniture, Vector2>[]
fullName: System.Func<TinyLife.Objects.LightFurniture, Microsoft.Xna.Framework.Vector2>[]
nameWithType.vb: Func(Of LightFurniture, Vector2)()
fullName.vb: System.Func(Of TinyLife.Objects.LightFurniture, Microsoft.Xna.Framework.Vector2)()
name.vb: Func(Of LightFurniture, Vector2)()
spec.csharp:
- uid: System.Func`2
name: Func
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.func-2
- name: <
- uid: TinyLife.Objects.LightFurniture
name: LightFurniture
- name: ','
- name: " "
- uid: Microsoft.Xna.Framework.Vector2
name: Vector2
isExternal: true
- name: '>'
- name: '['
- name: ']'
spec.vb:
- uid: System.Func`2
name: Func
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.func-2
- name: (
- name: Of
- name: " "
- uid: TinyLife.Objects.LightFurniture
name: LightFurniture
- name: ','
- name: " "
- uid: Microsoft.Xna.Framework.Vector2
name: Vector2
isExternal: true
- name: )
- name: (
- name: )
- uid: TinyLife.Objects.ObjectCategory.Lamp
commentId: F:TinyLife.Objects.ObjectCategory.Lamp
name: Lamp
nameWithType: ObjectCategory.Lamp
fullName: TinyLife.Objects.ObjectCategory.Lamp