mirror of
https://github.com/Ellpeck/TinyLifeWeb.git
synced 2024-12-22 22:59:23 +01:00
457 lines
17 KiB
YAML
457 lines
17 KiB
YAML
### YamlMime:ManagedReference
|
|
items:
|
|
- uid: TinyLife.Objects.IUpdatingObject
|
|
commentId: T:TinyLife.Objects.IUpdatingObject
|
|
id: IUpdatingObject
|
|
parent: TinyLife.Objects
|
|
children:
|
|
- TinyLife.Objects.IUpdatingObject.IsMinorUpdateNow
|
|
- TinyLife.Objects.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
|
|
langs:
|
|
- csharp
|
|
- vb
|
|
name: IUpdatingObject
|
|
nameWithType: IUpdatingObject
|
|
fullName: TinyLife.Objects.IUpdatingObject
|
|
type: Interface
|
|
source:
|
|
remote:
|
|
path: TinyLife/Objects/IUpdatingObject.cs
|
|
branch: main
|
|
repo: https://git.ellpeck.de/Ellpeck/TinyLife
|
|
id: IUpdatingObject
|
|
path: ../TinyLife/Objects/IUpdatingObject.cs
|
|
startLine: 10
|
|
assemblies:
|
|
- Tiny Life
|
|
namespace: TinyLife.Objects
|
|
summary: "\nThis is an interface that can be added to <xref href=\"TinyLife.Objects.MapObject\" data-throw-if-not-resolved=\"false\"></xref> classes to make them automatically update each update frame.\nThis is used by things like <xref href=\"TinyLife.Objects.Person\" data-throw-if-not-resolved=\"false\"></xref>, which needs to update for movement etc.\n"
|
|
example: []
|
|
syntax:
|
|
content: public interface IUpdatingObject
|
|
content.vb: Public Interface IUpdatingObject
|
|
extensionMethods:
|
|
- TinyLife.Objects.IUpdatingObject.TinyLife.Utilities.Extensions.JsonCopy``1
|
|
- uid: TinyLife.Objects.IUpdatingObject.IsMinorUpdateNow
|
|
commentId: P:TinyLife.Objects.IUpdatingObject.IsMinorUpdateNow
|
|
id: IsMinorUpdateNow
|
|
parent: TinyLife.Objects.IUpdatingObject
|
|
langs:
|
|
- csharp
|
|
- vb
|
|
name: IsMinorUpdateNow
|
|
nameWithType: IUpdatingObject.IsMinorUpdateNow
|
|
fullName: TinyLife.Objects.IUpdatingObject.IsMinorUpdateNow
|
|
type: Property
|
|
source:
|
|
remote:
|
|
path: TinyLife/Objects/IUpdatingObject.cs
|
|
branch: main
|
|
repo: https://git.ellpeck.de/Ellpeck/TinyLife
|
|
id: IsMinorUpdateNow
|
|
path: ../TinyLife/Objects/IUpdatingObject.cs
|
|
startLine: 18
|
|
assemblies:
|
|
- Tiny Life
|
|
namespace: TinyLife.Objects
|
|
summary: "\nA property that returns whether this updating object should currently update minorly, rather than majorly.\nA minor update means that <xref href=\"TinyLife.Objects.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime%2cSystem.TimeSpan%2cSystem.Single)\" data-throw-if-not-resolved=\"false\"></xref> is only called once every 10 in-game minutes (see <xref href=\"TinyLife.World.MapSection.MinorUpdateMinutes\" data-throw-if-not-resolved=\"false\"></xref>), but all of the parameters to <xref href=\"TinyLife.Objects.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime%2cSystem.TimeSpan%2cSystem.Single)\" data-throw-if-not-resolved=\"false\"></xref> are modified accordingly to maintain proper time calculations.\nNote that this property is only queried every 10 in-game minutes, as switching between major and minor update schedules only happens when a minor update is executed.\nFor example, a <xref href=\"TinyLife.Objects.Person\" data-throw-if-not-resolved=\"false\"></xref> updates minorly when they're out of town to aid the game's performance.\n"
|
|
example: []
|
|
syntax:
|
|
content: bool IsMinorUpdateNow { get; }
|
|
parameters: []
|
|
return:
|
|
type: System.Boolean
|
|
content.vb: ReadOnly Property IsMinorUpdateNow As Boolean
|
|
overload: TinyLife.Objects.IUpdatingObject.IsMinorUpdateNow*
|
|
- uid: TinyLife.Objects.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
|
|
commentId: M:TinyLife.Objects.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
|
|
id: Update(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
|
|
parent: TinyLife.Objects.IUpdatingObject
|
|
langs:
|
|
- csharp
|
|
- vb
|
|
name: Update(GameTime, TimeSpan, float)
|
|
nameWithType: IUpdatingObject.Update(GameTime, TimeSpan, float)
|
|
fullName: TinyLife.Objects.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime, System.TimeSpan, float)
|
|
type: Method
|
|
source:
|
|
remote:
|
|
path: TinyLife/Objects/IUpdatingObject.cs
|
|
branch: main
|
|
repo: https://git.ellpeck.de/Ellpeck/TinyLife
|
|
id: Update
|
|
path: ../TinyLife/Objects/IUpdatingObject.cs
|
|
startLine: 27
|
|
assemblies:
|
|
- Tiny Life
|
|
namespace: TinyLife.Objects
|
|
summary: "\nThe update method, which is called every update frame by the underlying <xref href=\"TinyLife.World.Map\" data-throw-if-not-resolved=\"false\"></xref>, as well as additional places like the <xref href=\"TinyLife.World.Household.FurnitureStorage\" data-throw-if-not-resolved=\"false\"></xref>. Because of this, some actions might only want to be invoked if an object <xref href=\"TinyLife.Objects.MapObject.IsInWorld\" data-throw-if-not-resolved=\"false\"></xref>.\nTo call this method while invoking all required events, use <xref href=\"TinyLife.Objects.MapObject.DoUpdate(Microsoft.Xna.Framework.GameTime%2cSystem.TimeSpan%2cSystem.Single)\" data-throw-if-not-resolved=\"false\"></xref>.\n"
|
|
example: []
|
|
syntax:
|
|
content: void Update(GameTime time, TimeSpan passedInGame, float speedMultiplier)
|
|
parameters:
|
|
- id: time
|
|
type: Microsoft.Xna.Framework.GameTime
|
|
description: The game's time
|
|
- id: passedInGame
|
|
type: System.TimeSpan
|
|
description: The amount of time that has passed since the last call
|
|
- id: speedMultiplier
|
|
type: System.Single
|
|
description: The game speed multiplier, which represents how fast things should happen, which is usually determined by <xref href="TinyLife.GameImpl.Speed" data-throw-if-not-resolved="false"></xref>
|
|
content.vb: Sub Update(time As GameTime, passedInGame As TimeSpan, speedMultiplier As Single)
|
|
overload: TinyLife.Objects.IUpdatingObject.Update*
|
|
nameWithType.vb: IUpdatingObject.Update(GameTime, TimeSpan, Single)
|
|
fullName.vb: TinyLife.Objects.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime, System.TimeSpan, Single)
|
|
name.vb: Update(GameTime, TimeSpan, Single)
|
|
references:
|
|
- uid: TinyLife.Objects.MapObject
|
|
commentId: T:TinyLife.Objects.MapObject
|
|
parent: TinyLife.Objects
|
|
name: MapObject
|
|
nameWithType: MapObject
|
|
fullName: TinyLife.Objects.MapObject
|
|
- uid: TinyLife.Objects.Person
|
|
commentId: T:TinyLife.Objects.Person
|
|
parent: TinyLife.Objects
|
|
name: Person
|
|
nameWithType: Person
|
|
fullName: TinyLife.Objects.Person
|
|
- 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: TinyLife.Objects.IUpdatingObject.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<IUpdatingObject>(IUpdatingObject)
|
|
nameWithType: Extensions.JsonCopy<IUpdatingObject>(IUpdatingObject)
|
|
fullName: TinyLife.Utilities.Extensions.JsonCopy<TinyLife.Objects.IUpdatingObject>(TinyLife.Objects.IUpdatingObject)
|
|
nameWithType.vb: Extensions.JsonCopy(Of IUpdatingObject)(IUpdatingObject)
|
|
fullName.vb: TinyLife.Utilities.Extensions.JsonCopy(Of TinyLife.Objects.IUpdatingObject)(TinyLife.Objects.IUpdatingObject)
|
|
name.vb: JsonCopy(Of IUpdatingObject)(IUpdatingObject)
|
|
spec.csharp:
|
|
- uid: TinyLife.Utilities.Extensions.JsonCopy``1(TinyLife.Objects.IUpdatingObject)
|
|
name: JsonCopy
|
|
- name: <
|
|
- uid: TinyLife.Objects.IUpdatingObject
|
|
name: IUpdatingObject
|
|
- name: '>'
|
|
- name: (
|
|
- uid: TinyLife.Objects.IUpdatingObject
|
|
name: IUpdatingObject
|
|
- name: )
|
|
spec.vb:
|
|
- uid: TinyLife.Utilities.Extensions.JsonCopy``1(TinyLife.Objects.IUpdatingObject)
|
|
name: JsonCopy
|
|
- name: (
|
|
- name: Of
|
|
- name: " "
|
|
- uid: TinyLife.Objects.IUpdatingObject
|
|
name: IUpdatingObject
|
|
- name: )
|
|
- name: (
|
|
- uid: TinyLife.Objects.IUpdatingObject
|
|
name: IUpdatingObject
|
|
- name: )
|
|
- 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: 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: TinyLife.Objects.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
|
|
commentId: M:TinyLife.Objects.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
|
|
parent: TinyLife.Objects.IUpdatingObject
|
|
isExternal: true
|
|
href: https://learn.microsoft.com/dotnet/api/system.timespan
|
|
name: Update(GameTime, TimeSpan, float)
|
|
nameWithType: IUpdatingObject.Update(GameTime, TimeSpan, float)
|
|
fullName: TinyLife.Objects.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime, System.TimeSpan, float)
|
|
nameWithType.vb: IUpdatingObject.Update(GameTime, TimeSpan, Single)
|
|
fullName.vb: TinyLife.Objects.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime, System.TimeSpan, Single)
|
|
name.vb: Update(GameTime, TimeSpan, Single)
|
|
spec.csharp:
|
|
- uid: TinyLife.Objects.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
|
|
name: Update
|
|
- name: (
|
|
- uid: Microsoft.Xna.Framework.GameTime
|
|
name: GameTime
|
|
isExternal: true
|
|
- name: ','
|
|
- name: " "
|
|
- uid: System.TimeSpan
|
|
name: TimeSpan
|
|
isExternal: true
|
|
href: https://learn.microsoft.com/dotnet/api/system.timespan
|
|
- name: ','
|
|
- name: " "
|
|
- uid: System.Single
|
|
name: float
|
|
isExternal: true
|
|
href: https://learn.microsoft.com/dotnet/api/system.single
|
|
- name: )
|
|
spec.vb:
|
|
- uid: TinyLife.Objects.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
|
|
name: Update
|
|
- name: (
|
|
- uid: Microsoft.Xna.Framework.GameTime
|
|
name: GameTime
|
|
isExternal: true
|
|
- name: ','
|
|
- name: " "
|
|
- uid: System.TimeSpan
|
|
name: TimeSpan
|
|
isExternal: true
|
|
href: https://learn.microsoft.com/dotnet/api/system.timespan
|
|
- name: ','
|
|
- name: " "
|
|
- uid: System.Single
|
|
name: Single
|
|
isExternal: true
|
|
href: https://learn.microsoft.com/dotnet/api/system.single
|
|
- name: )
|
|
- uid: TinyLife.World.MapSection.MinorUpdateMinutes
|
|
commentId: F:TinyLife.World.MapSection.MinorUpdateMinutes
|
|
name: MinorUpdateMinutes
|
|
nameWithType: MapSection.MinorUpdateMinutes
|
|
fullName: TinyLife.World.MapSection.MinorUpdateMinutes
|
|
- uid: TinyLife.Objects.IUpdatingObject.IsMinorUpdateNow*
|
|
commentId: Overload:TinyLife.Objects.IUpdatingObject.IsMinorUpdateNow
|
|
name: IsMinorUpdateNow
|
|
nameWithType: IUpdatingObject.IsMinorUpdateNow
|
|
fullName: TinyLife.Objects.IUpdatingObject.IsMinorUpdateNow
|
|
- 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.IUpdatingObject
|
|
commentId: T:TinyLife.Objects.IUpdatingObject
|
|
parent: TinyLife.Objects
|
|
name: IUpdatingObject
|
|
nameWithType: IUpdatingObject
|
|
fullName: TinyLife.Objects.IUpdatingObject
|
|
- uid: System
|
|
commentId: N:System
|
|
isExternal: true
|
|
href: https://learn.microsoft.com/dotnet/api/system
|
|
name: System
|
|
nameWithType: System
|
|
fullName: System
|
|
- uid: TinyLife.World.Map
|
|
commentId: T:TinyLife.World.Map
|
|
parent: TinyLife.World
|
|
name: Map
|
|
nameWithType: Map
|
|
fullName: TinyLife.World.Map
|
|
- uid: TinyLife.World.Household.FurnitureStorage
|
|
commentId: F:TinyLife.World.Household.FurnitureStorage
|
|
name: FurnitureStorage
|
|
nameWithType: Household.FurnitureStorage
|
|
fullName: TinyLife.World.Household.FurnitureStorage
|
|
- uid: TinyLife.Objects.MapObject.IsInWorld
|
|
commentId: P:TinyLife.Objects.MapObject.IsInWorld
|
|
parent: TinyLife.Objects.MapObject
|
|
name: IsInWorld
|
|
nameWithType: MapObject.IsInWorld
|
|
fullName: TinyLife.Objects.MapObject.IsInWorld
|
|
- uid: TinyLife.Objects.MapObject.DoUpdate(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
|
|
commentId: M:TinyLife.Objects.MapObject.DoUpdate(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
|
|
parent: TinyLife.Objects.MapObject
|
|
isExternal: true
|
|
href: https://learn.microsoft.com/dotnet/api/system.timespan
|
|
name: DoUpdate(GameTime, TimeSpan, float)
|
|
nameWithType: MapObject.DoUpdate(GameTime, TimeSpan, float)
|
|
fullName: TinyLife.Objects.MapObject.DoUpdate(Microsoft.Xna.Framework.GameTime, System.TimeSpan, float)
|
|
nameWithType.vb: MapObject.DoUpdate(GameTime, TimeSpan, Single)
|
|
fullName.vb: TinyLife.Objects.MapObject.DoUpdate(Microsoft.Xna.Framework.GameTime, System.TimeSpan, Single)
|
|
name.vb: DoUpdate(GameTime, TimeSpan, Single)
|
|
spec.csharp:
|
|
- uid: TinyLife.Objects.MapObject.DoUpdate(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
|
|
name: DoUpdate
|
|
- name: (
|
|
- uid: Microsoft.Xna.Framework.GameTime
|
|
name: GameTime
|
|
isExternal: true
|
|
- name: ','
|
|
- name: " "
|
|
- uid: System.TimeSpan
|
|
name: TimeSpan
|
|
isExternal: true
|
|
href: https://learn.microsoft.com/dotnet/api/system.timespan
|
|
- name: ','
|
|
- name: " "
|
|
- uid: System.Single
|
|
name: float
|
|
isExternal: true
|
|
href: https://learn.microsoft.com/dotnet/api/system.single
|
|
- name: )
|
|
spec.vb:
|
|
- uid: TinyLife.Objects.MapObject.DoUpdate(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
|
|
name: DoUpdate
|
|
- name: (
|
|
- uid: Microsoft.Xna.Framework.GameTime
|
|
name: GameTime
|
|
isExternal: true
|
|
- name: ','
|
|
- name: " "
|
|
- uid: System.TimeSpan
|
|
name: TimeSpan
|
|
isExternal: true
|
|
href: https://learn.microsoft.com/dotnet/api/system.timespan
|
|
- name: ','
|
|
- name: " "
|
|
- uid: System.Single
|
|
name: Single
|
|
isExternal: true
|
|
href: https://learn.microsoft.com/dotnet/api/system.single
|
|
- name: )
|
|
- uid: TinyLife.GameImpl.Speed
|
|
commentId: P:TinyLife.GameImpl.Speed
|
|
name: Speed
|
|
nameWithType: GameImpl.Speed
|
|
fullName: TinyLife.GameImpl.Speed
|
|
- uid: TinyLife.Objects.IUpdatingObject.Update*
|
|
commentId: Overload:TinyLife.Objects.IUpdatingObject.Update
|
|
name: Update
|
|
nameWithType: IUpdatingObject.Update
|
|
fullName: TinyLife.Objects.IUpdatingObject.Update
|
|
- uid: Microsoft.Xna.Framework.GameTime
|
|
commentId: T:Microsoft.Xna.Framework.GameTime
|
|
parent: Microsoft.Xna.Framework
|
|
isExternal: true
|
|
name: GameTime
|
|
nameWithType: GameTime
|
|
fullName: Microsoft.Xna.Framework.GameTime
|
|
- uid: System.TimeSpan
|
|
commentId: T:System.TimeSpan
|
|
parent: System
|
|
isExternal: true
|
|
href: https://learn.microsoft.com/dotnet/api/system.timespan
|
|
name: TimeSpan
|
|
nameWithType: TimeSpan
|
|
fullName: System.TimeSpan
|
|
- uid: System.Single
|
|
commentId: T:System.Single
|
|
parent: System
|
|
isExternal: true
|
|
href: https://learn.microsoft.com/dotnet/api/system.single
|
|
name: float
|
|
nameWithType: float
|
|
fullName: float
|
|
nameWithType.vb: Single
|
|
fullName.vb: Single
|
|
name.vb: Single
|
|
- uid: TinyLife.World
|
|
commentId: N:TinyLife.World
|
|
name: TinyLife.World
|
|
nameWithType: TinyLife.World
|
|
fullName: TinyLife.World
|
|
spec.csharp:
|
|
- uid: TinyLife
|
|
name: TinyLife
|
|
- name: .
|
|
- uid: TinyLife.World
|
|
name: World
|
|
spec.vb:
|
|
- uid: TinyLife
|
|
name: TinyLife
|
|
- name: .
|
|
- uid: TinyLife.World
|
|
name: World
|
|
- uid: Microsoft.Xna.Framework
|
|
commentId: N:Microsoft.Xna.Framework
|
|
isExternal: true
|
|
name: Microsoft.Xna.Framework
|
|
nameWithType: Microsoft.Xna.Framework
|
|
fullName: Microsoft.Xna.Framework
|
|
spec.csharp:
|
|
- uid: Microsoft
|
|
name: Microsoft
|
|
isExternal: true
|
|
- name: .
|
|
- uid: Microsoft.Xna
|
|
name: Xna
|
|
isExternal: true
|
|
- name: .
|
|
- uid: Microsoft.Xna.Framework
|
|
name: Framework
|
|
isExternal: true
|
|
spec.vb:
|
|
- uid: Microsoft
|
|
name: Microsoft
|
|
isExternal: true
|
|
- name: .
|
|
- uid: Microsoft.Xna
|
|
name: Xna
|
|
isExternal: true
|
|
- name: .
|
|
- uid: Microsoft.Xna.Framework
|
|
name: Framework
|
|
isExternal: true
|