TinyLifeWeb/docs/api/TinyLife.Objects.IUpdatingObject.yml

408 lines
14 KiB
YAML
Raw Normal View History

2021-08-04 06:51:12 +02:00
### YamlMime:ManagedReference
items:
- uid: TinyLife.Objects.IUpdatingObject
commentId: T:TinyLife.Objects.IUpdatingObject
id: IUpdatingObject
parent: TinyLife.Objects
children:
2023-07-20 14:27:20 +02:00
- TinyLife.Objects.IUpdatingObject.CurrentMode
2022-09-05 14:19:42 +02:00
- TinyLife.Objects.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
2021-08-04 06:51:12 +02:00
langs:
- csharp
- vb
name: IUpdatingObject
nameWithType: IUpdatingObject
fullName: TinyLife.Objects.IUpdatingObject
type: Interface
source:
remote:
path: TinyLife/Objects/IUpdatingObject.cs
2023-12-06 13:25:52 +01:00
branch: main
2021-11-26 23:42:22 +01:00
repo: https://git.ellpeck.de/Ellpeck/TinyLife
2021-08-04 06:51:12 +02:00
id: IUpdatingObject
2022-03-09 16:13:05 +01:00
path: ../TinyLife/Objects/IUpdatingObject.cs
2022-09-05 14:19:42 +02:00
startLine: 10
2021-08-04 06:51:12 +02:00
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
2023-07-20 14:27:20 +02:00
- uid: TinyLife.Objects.IUpdatingObject.CurrentMode
commentId: P:TinyLife.Objects.IUpdatingObject.CurrentMode
id: CurrentMode
2022-07-28 14:58:38 +02:00
parent: TinyLife.Objects.IUpdatingObject
langs:
- csharp
- vb
2023-07-20 14:27:20 +02:00
name: CurrentMode
nameWithType: IUpdatingObject.CurrentMode
fullName: TinyLife.Objects.IUpdatingObject.CurrentMode
2022-07-28 14:58:38 +02:00
type: Property
source:
remote:
path: TinyLife/Objects/IUpdatingObject.cs
2023-12-06 13:25:52 +01:00
branch: main
2022-07-28 14:58:38 +02:00
repo: https://git.ellpeck.de/Ellpeck/TinyLife
2023-07-20 14:27:20 +02:00
id: CurrentMode
2022-07-28 14:58:38 +02:00
path: ../TinyLife/Objects/IUpdatingObject.cs
2023-07-20 14:27:20 +02:00
startLine: 17
2022-07-28 14:58:38 +02:00
assemblies:
- Tiny Life
namespace: TinyLife.Objects
2023-07-20 14:27:20 +02:00
summary: "\nA property that returns the current <xref href=\"TinyLife.Objects.IUpdatingObject.UpdateMode\" data-throw-if-not-resolved=\"false\"></xref> for this updating object. This property defaults to returning <xref href=\"TinyLife.Objects.IUpdatingObject.UpdateMode.MajorIfActive\" data-throw-if-not-resolved=\"false\"></xref>.\nWhen moving updating objects between update modes (ie changing the return value), objects are moved automatically after the respective update is invoked. This means that update mode changes don&apos;t occur immediately.\nSee the documentation for each <xref href=\"TinyLife.Objects.IUpdatingObject.UpdateMode\" data-throw-if-not-resolved=\"false\"></xref> for more information.\n"
2022-07-28 14:58:38 +02:00
example: []
syntax:
2023-07-20 14:27:20 +02:00
content: IUpdatingObject.UpdateMode CurrentMode { get; }
2022-07-28 14:58:38 +02:00
parameters: []
return:
2023-07-20 14:27:20 +02:00
type: TinyLife.Objects.IUpdatingObject.UpdateMode
content.vb: ReadOnly Property CurrentMode As IUpdatingObject.UpdateMode
overload: TinyLife.Objects.IUpdatingObject.CurrentMode*
2022-09-05 14:19:42 +02:00
- 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)
2021-08-04 06:51:12 +02:00
parent: TinyLife.Objects.IUpdatingObject
langs:
- csharp
- vb
2023-03-30 18:07:55 +02:00
name: Update(GameTime, TimeSpan, float)
nameWithType: IUpdatingObject.Update(GameTime, TimeSpan, float)
fullName: TinyLife.Objects.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime, System.TimeSpan, float)
2021-08-04 06:51:12 +02:00
type: Method
source:
remote:
path: TinyLife/Objects/IUpdatingObject.cs
2023-12-06 13:25:52 +01:00
branch: main
2021-11-26 23:42:22 +01:00
repo: https://git.ellpeck.de/Ellpeck/TinyLife
2021-08-04 06:51:12 +02:00
id: Update
2022-03-09 16:13:05 +01:00
path: ../TinyLife/Objects/IUpdatingObject.cs
2023-07-20 14:27:20 +02:00
startLine: 26
2021-08-04 06:51:12 +02:00
assemblies:
- Tiny Life
namespace: TinyLife.Objects
2022-09-05 14:19:42 +02:00
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"
2021-08-04 06:51:12 +02:00
example: []
syntax:
2021-11-26 23:42:22 +01:00
content: void Update(GameTime time, TimeSpan passedInGame, float speedMultiplier)
2021-08-04 06:51:12 +02:00
parameters:
- id: time
2022-09-05 14:19:42 +02:00
type: Microsoft.Xna.Framework.GameTime
2021-08-04 06:51:12 +02:00
description: The game&apos;s time
- id: passedInGame
type: System.TimeSpan
description: The amount of time that has passed since the last call
2021-11-26 23:42:22 +01:00
- 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)
2021-08-04 06:51:12 +02:00
overload: TinyLife.Objects.IUpdatingObject.Update*
2023-03-30 18:07:55 +02:00
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)
2021-08-04 06:51:12 +02:00
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
2023-03-30 18:07:55 +02:00
spec.csharp:
- uid: TinyLife
name: TinyLife
- name: .
- uid: TinyLife.Objects
name: Objects
spec.vb:
- uid: TinyLife
name: TinyLife
- name: .
- uid: TinyLife.Objects
name: Objects
2021-08-04 06:51:12 +02:00
- 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)
2023-03-30 18:07:55 +02:00
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)
2021-08-04 06:51:12 +02:00
spec.csharp:
2023-03-30 18:07:55 +02:00
- uid: TinyLife.Utilities.Extensions.JsonCopy``1(TinyLife.Objects.IUpdatingObject)
name: JsonCopy
- name: <
- uid: TinyLife.Objects.IUpdatingObject
name: IUpdatingObject
- name: '>'
2021-08-04 06:51:12 +02:00
- name: (
2023-03-30 18:07:55 +02:00
- uid: TinyLife.Objects.IUpdatingObject
name: IUpdatingObject
2021-08-04 06:51:12 +02:00
- name: )
spec.vb:
2023-03-30 18:07:55 +02:00
- uid: TinyLife.Utilities.Extensions.JsonCopy``1(TinyLife.Objects.IUpdatingObject)
name: JsonCopy
- name: (
- name: Of
- name: " "
- uid: TinyLife.Objects.IUpdatingObject
name: IUpdatingObject
- name: )
2021-08-04 06:51:12 +02:00
- name: (
2023-03-30 18:07:55 +02:00
- uid: TinyLife.Objects.IUpdatingObject
name: IUpdatingObject
2021-08-04 06:51:12 +02:00
- 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)
2023-03-30 18:07:55 +02:00
name: JsonCopy
- name: <
- name: T
- name: '>'
2021-08-04 06:51:12 +02:00
- name: (
- name: T
- name: )
spec.vb:
- uid: TinyLife.Utilities.Extensions.JsonCopy``1(``0)
2023-03-30 18:07:55 +02:00
name: JsonCopy
- name: (
- name: Of
- name: " "
- name: T
- name: )
2021-08-04 06:51:12 +02:00
- 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
2023-03-30 18:07:55 +02:00
spec.csharp:
- uid: TinyLife
name: TinyLife
- name: .
- uid: TinyLife.Utilities
name: Utilities
spec.vb:
- uid: TinyLife
name: TinyLife
- name: .
- uid: TinyLife.Utilities
name: Utilities
2023-07-20 14:27:20 +02:00
- uid: TinyLife.Objects.IUpdatingObject.UpdateMode
commentId: T:TinyLife.Objects.IUpdatingObject.UpdateMode
parent: TinyLife.Objects
name: IUpdatingObject.UpdateMode
nameWithType: IUpdatingObject.UpdateMode
fullName: TinyLife.Objects.IUpdatingObject.UpdateMode
2022-07-28 14:58:38 +02:00
spec.csharp:
2023-07-20 14:27:20 +02:00
- uid: TinyLife.Objects.IUpdatingObject
name: IUpdatingObject
- name: .
- uid: TinyLife.Objects.IUpdatingObject.UpdateMode
name: UpdateMode
2022-07-28 14:58:38 +02:00
spec.vb:
2023-07-20 14:27:20 +02:00
- uid: TinyLife.Objects.IUpdatingObject
name: IUpdatingObject
- name: .
- uid: TinyLife.Objects.IUpdatingObject.UpdateMode
name: UpdateMode
- uid: TinyLife.Objects.IUpdatingObject.UpdateMode.MajorIfActive
commentId: F:TinyLife.Objects.IUpdatingObject.UpdateMode.MajorIfActive
name: MajorIfActive
nameWithType: IUpdatingObject.UpdateMode.MajorIfActive
fullName: TinyLife.Objects.IUpdatingObject.UpdateMode.MajorIfActive
- uid: TinyLife.Objects.IUpdatingObject.CurrentMode*
commentId: Overload:TinyLife.Objects.IUpdatingObject.CurrentMode
name: CurrentMode
nameWithType: IUpdatingObject.CurrentMode
fullName: TinyLife.Objects.IUpdatingObject.CurrentMode
2021-08-04 06:51:12 +02:00
- uid: TinyLife.World.Map
commentId: T:TinyLife.World.Map
parent: TinyLife.World
name: Map
nameWithType: Map
fullName: TinyLife.World.Map
2022-09-05 14:19:42 +02:00
- uid: TinyLife.World.Household.FurnitureStorage
commentId: F:TinyLife.World.Household.FurnitureStorage
2023-03-30 18:07:55 +02:00
name: FurnitureStorage
nameWithType: Household.FurnitureStorage
fullName: TinyLife.World.Household.FurnitureStorage
2022-09-05 14:19:42 +02:00
- 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)
2022-07-28 14:58:38 +02:00
parent: TinyLife.Objects.MapObject
isExternal: true
2023-03-30 18:07:55 +02:00
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)
2022-07-28 14:58:38 +02:00
spec.csharp:
2022-09-05 14:19:42 +02:00
- uid: TinyLife.Objects.MapObject.DoUpdate(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
2022-07-28 14:58:38 +02:00
name: DoUpdate
- name: (
2022-09-05 14:19:42 +02:00
- uid: Microsoft.Xna.Framework.GameTime
2022-07-28 14:58:38 +02:00
name: GameTime
isExternal: true
2023-03-30 18:07:55 +02:00
- name: ','
- name: " "
2022-07-28 14:58:38 +02:00
- uid: System.TimeSpan
name: TimeSpan
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.timespan
- name: ','
- name: " "
2022-07-28 14:58:38 +02:00
- uid: System.Single
2023-03-30 18:07:55 +02:00
name: float
2022-07-28 14:58:38 +02:00
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.single
2022-07-28 14:58:38 +02:00
- name: )
spec.vb:
2022-09-05 14:19:42 +02:00
- uid: TinyLife.Objects.MapObject.DoUpdate(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
2022-07-28 14:58:38 +02:00
name: DoUpdate
- name: (
2022-09-05 14:19:42 +02:00
- uid: Microsoft.Xna.Framework.GameTime
2022-07-28 14:58:38 +02:00
name: GameTime
isExternal: true
2023-03-30 18:07:55 +02:00
- name: ','
- name: " "
2022-07-28 14:58:38 +02:00
- uid: System.TimeSpan
name: TimeSpan
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.timespan
- name: ','
- name: " "
2022-07-28 14:58:38 +02:00
- uid: System.Single
name: Single
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.single
2022-07-28 14:58:38 +02:00
- name: )
2021-11-26 23:42:22 +01:00
- uid: TinyLife.GameImpl.Speed
commentId: P:TinyLife.GameImpl.Speed
2023-03-30 18:07:55 +02:00
name: Speed
nameWithType: GameImpl.Speed
fullName: TinyLife.GameImpl.Speed
2021-08-04 06:51:12 +02:00
- uid: TinyLife.Objects.IUpdatingObject.Update*
commentId: Overload:TinyLife.Objects.IUpdatingObject.Update
name: Update
nameWithType: IUpdatingObject.Update
fullName: TinyLife.Objects.IUpdatingObject.Update
2022-09-05 14:19:42 +02:00
- uid: Microsoft.Xna.Framework.GameTime
commentId: T:Microsoft.Xna.Framework.GameTime
parent: Microsoft.Xna.Framework
2021-08-04 06:51:12 +02:00
isExternal: true
name: GameTime
nameWithType: GameTime
2022-09-05 14:19:42 +02:00
fullName: Microsoft.Xna.Framework.GameTime
2021-08-04 06:51:12 +02:00
- uid: System.TimeSpan
commentId: T:System.TimeSpan
parent: System
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.timespan
2021-08-04 06:51:12 +02:00
name: TimeSpan
nameWithType: TimeSpan
fullName: System.TimeSpan
2021-11-26 23:42:22 +01:00
- uid: System.Single
commentId: T:System.Single
parent: System
isExternal: true
2023-03-30 18:07:55 +02:00
href: https://learn.microsoft.com/dotnet/api/system.single
name: float
nameWithType: float
fullName: float
nameWithType.vb: Single
fullName.vb: Single
name.vb: Single
2021-08-04 06:51:12 +02:00
- uid: TinyLife.World
commentId: N:TinyLife.World
name: TinyLife.World
nameWithType: TinyLife.World
fullName: TinyLife.World
2023-03-30 18:07:55 +02:00
spec.csharp:
- uid: TinyLife
name: TinyLife
- name: .
- uid: TinyLife.World
name: World
spec.vb:
- uid: TinyLife
name: TinyLife
- name: .
- uid: TinyLife.World
name: World
2022-09-05 14:19:42 +02:00
- uid: Microsoft.Xna.Framework
commentId: N:Microsoft.Xna.Framework
isExternal: true
name: Microsoft.Xna.Framework
nameWithType: Microsoft.Xna.Framework
fullName: Microsoft.Xna.Framework
2023-03-30 18:07:55 +02:00
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
2023-07-20 14:27:20 +02:00
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System