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

### YamlMime:ManagedReference
items:
- uid: TinyLife.Objects.IUpdatingObject
  commentId: T:TinyLife.Objects.IUpdatingObject
  id: IUpdatingObject
  parent: TinyLife.Objects
  children:
  - TinyLife.Objects.IUpdatingObject.CurrentMode
  - 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: >-
    This 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.

    This is used by things like <xref href="TinyLife.Objects.Person" data-throw-if-not-resolved="false"></xref>, which needs to update for movement etc.
  example: []
  syntax:
    content: public interface IUpdatingObject
    content.vb: Public Interface IUpdatingObject
  extensionMethods:
  - TinyLife.Objects.IUpdatingObject.TinyLife.Utilities.Extensions.JsonCopy``1
- uid: TinyLife.Objects.IUpdatingObject.CurrentMode
  commentId: P:TinyLife.Objects.IUpdatingObject.CurrentMode
  id: CurrentMode
  parent: TinyLife.Objects.IUpdatingObject
  langs:
  - csharp
  - vb
  name: CurrentMode
  nameWithType: IUpdatingObject.CurrentMode
  fullName: TinyLife.Objects.IUpdatingObject.CurrentMode
  type: Property
  source:
    remote:
      path: TinyLife/Objects/IUpdatingObject.cs
      branch: main
      repo: https://git.ellpeck.de/Ellpeck/TinyLife
    id: CurrentMode
    path: ../TinyLife/Objects/IUpdatingObject.cs
    startLine: 17
  assemblies:
  - Tiny Life
  namespace: TinyLife.Objects
  summary: >-
    A 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>.

    When 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't occur immediately.

    See the documentation for each <xref href="TinyLife.Objects.IUpdatingObject.UpdateMode" data-throw-if-not-resolved="false"></xref> for more information.
  example: []
  syntax:
    content: IUpdatingObject.UpdateMode CurrentMode { get; }
    parameters: []
    return:
      type: TinyLife.Objects.IUpdatingObject.UpdateMode
    content.vb: ReadOnly Property CurrentMode As IUpdatingObject.UpdateMode
  overload: TinyLife.Objects.IUpdatingObject.CurrentMode*
- 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: 26
  assemblies:
  - Tiny Life
  namespace: TinyLife.Objects
  summary: >-
    The 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>.

    To 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>.
  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
  href: TinyLife.Objects.MapObject.html
  name: MapObject
  nameWithType: MapObject
  fullName: TinyLife.Objects.MapObject
- uid: TinyLife.Objects.Person
  commentId: T:TinyLife.Objects.Person
  parent: TinyLife.Objects
  href: TinyLife.Objects.Person.html
  name: Person
  nameWithType: Person
  fullName: TinyLife.Objects.Person
- uid: TinyLife.Objects
  commentId: N:TinyLife.Objects
  href: TinyLife.html
  name: TinyLife.Objects
  nameWithType: TinyLife.Objects
  fullName: TinyLife.Objects
  spec.csharp:
  - uid: TinyLife
    name: TinyLife
    href: TinyLife.html
  - name: .
  - uid: TinyLife.Objects
    name: Objects
    href: TinyLife.Objects.html
  spec.vb:
  - uid: TinyLife
    name: TinyLife
    href: TinyLife.html
  - name: .
  - uid: TinyLife.Objects
    name: Objects
    href: TinyLife.Objects.html
- 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)
  href: TinyLife.Utilities.Extensions.html#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
    href: TinyLife.Utilities.Extensions.html#TinyLife_Utilities_Extensions_JsonCopy__1___0_
  - name: <
  - uid: TinyLife.Objects.IUpdatingObject
    name: IUpdatingObject
    href: TinyLife.Objects.IUpdatingObject.html
  - name: '>'
  - name: (
  - uid: TinyLife.Objects.IUpdatingObject
    name: IUpdatingObject
    href: TinyLife.Objects.IUpdatingObject.html
  - name: )
  spec.vb:
  - uid: TinyLife.Utilities.Extensions.JsonCopy``1(TinyLife.Objects.IUpdatingObject)
    name: JsonCopy
    href: TinyLife.Utilities.Extensions.html#TinyLife_Utilities_Extensions_JsonCopy__1___0_
  - name: (
  - name: Of
  - name: " "
  - uid: TinyLife.Objects.IUpdatingObject
    name: IUpdatingObject
    href: TinyLife.Objects.IUpdatingObject.html
  - name: )
  - name: (
  - uid: TinyLife.Objects.IUpdatingObject
    name: IUpdatingObject
    href: TinyLife.Objects.IUpdatingObject.html
  - name: )
- uid: TinyLife.Utilities.Extensions.JsonCopy``1(``0)
  commentId: M:TinyLife.Utilities.Extensions.JsonCopy``1(``0)
  href: TinyLife.Utilities.Extensions.html#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
    href: TinyLife.Utilities.Extensions.html#TinyLife_Utilities_Extensions_JsonCopy__1___0_
  - name: <
  - name: T
  - name: '>'
  - name: (
  - name: T
  - name: )
  spec.vb:
  - uid: TinyLife.Utilities.Extensions.JsonCopy``1(``0)
    name: JsonCopy
    href: TinyLife.Utilities.Extensions.html#TinyLife_Utilities_Extensions_JsonCopy__1___0_
  - name: (
  - name: Of
  - name: " "
  - name: T
  - name: )
  - name: (
  - name: T
  - name: )
- uid: TinyLife.Utilities.Extensions
  commentId: T:TinyLife.Utilities.Extensions
  parent: TinyLife.Utilities
  href: TinyLife.Utilities.Extensions.html
  name: Extensions
  nameWithType: Extensions
  fullName: TinyLife.Utilities.Extensions
- uid: TinyLife.Utilities
  commentId: N:TinyLife.Utilities
  href: TinyLife.html
  name: TinyLife.Utilities
  nameWithType: TinyLife.Utilities
  fullName: TinyLife.Utilities
  spec.csharp:
  - uid: TinyLife
    name: TinyLife
    href: TinyLife.html
  - name: .
  - uid: TinyLife.Utilities
    name: Utilities
    href: TinyLife.Utilities.html
  spec.vb:
  - uid: TinyLife
    name: TinyLife
    href: TinyLife.html
  - name: .
  - uid: TinyLife.Utilities
    name: Utilities
    href: TinyLife.Utilities.html
- uid: TinyLife.Objects.IUpdatingObject.UpdateMode
  commentId: T:TinyLife.Objects.IUpdatingObject.UpdateMode
  parent: TinyLife.Objects
  href: TinyLife.Objects.IUpdatingObject.html
  name: IUpdatingObject.UpdateMode
  nameWithType: IUpdatingObject.UpdateMode
  fullName: TinyLife.Objects.IUpdatingObject.UpdateMode
  spec.csharp:
  - uid: TinyLife.Objects.IUpdatingObject
    name: IUpdatingObject
    href: TinyLife.Objects.IUpdatingObject.html
  - name: .
  - uid: TinyLife.Objects.IUpdatingObject.UpdateMode
    name: UpdateMode
    href: TinyLife.Objects.IUpdatingObject.UpdateMode.html
  spec.vb:
  - uid: TinyLife.Objects.IUpdatingObject
    name: IUpdatingObject
    href: TinyLife.Objects.IUpdatingObject.html
  - name: .
  - uid: TinyLife.Objects.IUpdatingObject.UpdateMode
    name: UpdateMode
    href: TinyLife.Objects.IUpdatingObject.UpdateMode.html
- uid: TinyLife.Objects.IUpdatingObject.UpdateMode.MajorIfActive
  commentId: F:TinyLife.Objects.IUpdatingObject.UpdateMode.MajorIfActive
  href: TinyLife.Objects.IUpdatingObject.UpdateMode.html#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
  href: TinyLife.Objects.IUpdatingObject.html#TinyLife_Objects_IUpdatingObject_CurrentMode
  name: CurrentMode
  nameWithType: IUpdatingObject.CurrentMode
  fullName: TinyLife.Objects.IUpdatingObject.CurrentMode
- uid: TinyLife.World.Map
  commentId: T:TinyLife.World.Map
  parent: TinyLife.World
  href: TinyLife.World.Map.html
  name: Map
  nameWithType: Map
  fullName: TinyLife.World.Map
- uid: TinyLife.World.Household.FurnitureStorage
  commentId: F:TinyLife.World.Household.FurnitureStorage
  href: TinyLife.World.Household.html#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
  href: TinyLife.Objects.MapObject.html#TinyLife_Objects_MapObject_IsInWorld
  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: TinyLife.Objects.MapObject.html#TinyLife_Objects_MapObject_DoUpdate_Microsoft_Xna_Framework_GameTime_System_TimeSpan_System_Single_
  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
    href: TinyLife.Objects.MapObject.html#TinyLife_Objects_MapObject_DoUpdate_Microsoft_Xna_Framework_GameTime_System_TimeSpan_System_Single_
  - 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
    href: TinyLife.Objects.MapObject.html#TinyLife_Objects_MapObject_DoUpdate_Microsoft_Xna_Framework_GameTime_System_TimeSpan_System_Single_
  - 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
  href: TinyLife.GameImpl.html#TinyLife_GameImpl_Speed
  name: Speed
  nameWithType: GameImpl.Speed
  fullName: TinyLife.GameImpl.Speed
- uid: TinyLife.Objects.IUpdatingObject.Update*
  commentId: Overload:TinyLife.Objects.IUpdatingObject.Update
  href: TinyLife.Objects.IUpdatingObject.html#TinyLife_Objects_IUpdatingObject_Update_Microsoft_Xna_Framework_GameTime_System_TimeSpan_System_Single_
  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
  href: TinyLife.html
  name: TinyLife.World
  nameWithType: TinyLife.World
  fullName: TinyLife.World
  spec.csharp:
  - uid: TinyLife
    name: TinyLife
    href: TinyLife.html
  - name: .
  - uid: TinyLife.World
    name: World
    href: TinyLife.World.html
  spec.vb:
  - uid: TinyLife
    name: TinyLife
    href: TinyLife.html
  - name: .
  - uid: TinyLife.World
    name: World
    href: TinyLife.World.html
- 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
- uid: System
  commentId: N:System
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system
  name: System
  nameWithType: System
  fullName: System