Ellpeck/TinyLifeWeb
1
0
Fork 0
mirror of https://github.com/Ellpeck/TinyLifeWeb.git synced 2024-11-29 14:08:33 +01:00
Code Issues Projects Releases Wiki Activity
TinyLifeWeb/docs/api/TinyLife.Objects.IUpdatingObject.UpdateMode.yml
Ell 329a956d8e 0.38.4
2024-01-07 16:53:47 +01:00

406 lines
16 KiB
YAML
Raw Blame History

### YamlMime:ManagedReference
items:
- uid: TinyLife.Objects.IUpdatingObject.UpdateMode
commentId: T:TinyLife.Objects.IUpdatingObject.UpdateMode
id: IUpdatingObject.UpdateMode
parent: TinyLife.Objects
children:
- TinyLife.Objects.IUpdatingObject.UpdateMode.AlwaysMajor
- TinyLife.Objects.IUpdatingObject.UpdateMode.MajorIfActive
- TinyLife.Objects.IUpdatingObject.UpdateMode.Minor
langs:
- csharp
- vb
name: IUpdatingObject.UpdateMode
nameWithType: IUpdatingObject.UpdateMode
fullName: TinyLife.Objects.IUpdatingObject.UpdateMode
type: Enum
source:
remote:
path: TinyLife/Objects/IUpdatingObject.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: UpdateMode
path: ../TinyLife/Objects/IUpdatingObject.cs
startLine: 31
assemblies:
- Tiny Life
namespace: TinyLife.Objects
summary: A set of update modes for updating objects, used by <xref href="TinyLife.Objects.IUpdatingObject.CurrentMode" data-throw-if-not-resolved="false"></xref>.
example: []
syntax:
content: public enum IUpdatingObject.UpdateMode
content.vb: Public Enum IUpdatingObject.UpdateMode
extensionMethods:
- TinyLife.Objects.IUpdatingObject.UpdateMode.TinyLife.Utilities.Extensions.JsonCopy``1
- uid: TinyLife.Objects.IUpdatingObject.UpdateMode.MajorIfActive
commentId: F:TinyLife.Objects.IUpdatingObject.UpdateMode.MajorIfActive
id: MajorIfActive
parent: TinyLife.Objects.IUpdatingObject.UpdateMode
langs:
- csharp
- vb
name: MajorIfActive
nameWithType: IUpdatingObject.UpdateMode.MajorIfActive
fullName: TinyLife.Objects.IUpdatingObject.UpdateMode.MajorIfActive
type: Field
source:
remote:
path: TinyLife/Objects/IUpdatingObject.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: MajorIfActive
path: ../TinyLife/Objects/IUpdatingObject.cs
startLine: 37
assemblies:
- Tiny Life
namespace: TinyLife.Objects
summary: >-
An update mode that causes objects to be updated each update frame (through <xref href="TinyLife.World.Map.Update(Microsoft.Xna.Framework.GameTime%2cSystem.TimeSpan%2cSystem.Single)" data-throw-if-not-resolved="false"></xref>), on the condition that the map the object is on returns <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> on <xref href="TinyLife.World.Map.IsActive" data-throw-if-not-resolved="false"></xref>.
When a map is inactive, the object is updated with the <xref href="TinyLife.World.Map.PassiveUpdateMinutes" data-throw-if-not-resolved="false"></xref> between each call to <xref href="TinyLife.Objects.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime%2cSystem.TimeSpan%2cSystem.Single)" data-throw-if-not-resolved="false"></xref>, but with the parameters adjusted to reflect the time passed.
example: []
syntax:
content: MajorIfActive = 0
return:
type: TinyLife.Objects.IUpdatingObject.UpdateMode
- uid: TinyLife.Objects.IUpdatingObject.UpdateMode.AlwaysMajor
commentId: F:TinyLife.Objects.IUpdatingObject.UpdateMode.AlwaysMajor
id: AlwaysMajor
parent: TinyLife.Objects.IUpdatingObject.UpdateMode
langs:
- csharp
- vb
name: AlwaysMajor
nameWithType: IUpdatingObject.UpdateMode.AlwaysMajor
fullName: TinyLife.Objects.IUpdatingObject.UpdateMode.AlwaysMajor
type: Field
source:
remote:
path: TinyLife/Objects/IUpdatingObject.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: AlwaysMajor
path: ../TinyLife/Objects/IUpdatingObject.cs
startLine: 41
assemblies:
- Tiny Life
namespace: TinyLife.Objects
summary: An update mode that causes objects to be updated each update frame (through <xref href="TinyLife.World.Map.Update(Microsoft.Xna.Framework.GameTime%2cSystem.TimeSpan%2cSystem.Single)" data-throw-if-not-resolved="false"></xref>), regardless of whether the map the object is on returns <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> on <xref href="TinyLife.World.Map.IsActive" data-throw-if-not-resolved="false"></xref>.
example: []
syntax:
content: AlwaysMajor = 1
return:
type: TinyLife.Objects.IUpdatingObject.UpdateMode
- uid: TinyLife.Objects.IUpdatingObject.UpdateMode.Minor
commentId: F:TinyLife.Objects.IUpdatingObject.UpdateMode.Minor
id: Minor
parent: TinyLife.Objects.IUpdatingObject.UpdateMode
langs:
- csharp
- vb
name: Minor
nameWithType: IUpdatingObject.UpdateMode.Minor
fullName: TinyLife.Objects.IUpdatingObject.UpdateMode.Minor
type: Field
source:
remote:
path: TinyLife/Objects/IUpdatingObject.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Minor
path: ../TinyLife/Objects/IUpdatingObject.cs
startLine: 45
assemblies:
- Tiny Life
namespace: TinyLife.Objects
summary: An update mode that causes objects to update minorly all the time, meaning with the <xref href="TinyLife.World.Map.MinorUpdateMinutes" data-throw-if-not-resolved="false"></xref> between each call to <xref href="TinyLife.Objects.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime%2cSystem.TimeSpan%2cSystem.Single)" data-throw-if-not-resolved="false"></xref>, but with the parameters adjusted to reflect the time passed.
example: []
syntax:
content: Minor = 2
return:
type: TinyLife.Objects.IUpdatingObject.UpdateMode
references:
- uid: TinyLife.Objects.IUpdatingObject.CurrentMode
commentId: P:TinyLife.Objects.IUpdatingObject.CurrentMode
parent: TinyLife.Objects.IUpdatingObject
href: TinyLife.Objects.IUpdatingObject.html#TinyLife_Objects_IUpdatingObject_CurrentMode
name: CurrentMode
nameWithType: IUpdatingObject.CurrentMode
fullName: TinyLife.Objects.IUpdatingObject.CurrentMode
- 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.UpdateMode.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<UpdateMode>(UpdateMode)
nameWithType: Extensions.JsonCopy<IUpdatingObject.UpdateMode>(IUpdatingObject.UpdateMode)
fullName: TinyLife.Utilities.Extensions.JsonCopy<TinyLife.Objects.IUpdatingObject.UpdateMode>(TinyLife.Objects.IUpdatingObject.UpdateMode)
nameWithType.vb: Extensions.JsonCopy(Of IUpdatingObject.UpdateMode)(IUpdatingObject.UpdateMode)
fullName.vb: TinyLife.Utilities.Extensions.JsonCopy(Of TinyLife.Objects.IUpdatingObject.UpdateMode)(TinyLife.Objects.IUpdatingObject.UpdateMode)
name.vb: JsonCopy(Of UpdateMode)(UpdateMode)
spec.csharp:
- uid: TinyLife.Utilities.Extensions.JsonCopy``1(TinyLife.Objects.IUpdatingObject.UpdateMode)
name: JsonCopy
href: TinyLife.Utilities.Extensions.html#TinyLife_Utilities_Extensions_JsonCopy__1___0_
- name: <
- uid: TinyLife.Objects.IUpdatingObject.UpdateMode
name: UpdateMode
href: TinyLife.Objects.IUpdatingObject.UpdateMode.html
- name: '>'
- name: (
- uid: TinyLife.Objects.IUpdatingObject.UpdateMode
name: UpdateMode
href: TinyLife.Objects.IUpdatingObject.UpdateMode.html
- name: )
spec.vb:
- uid: TinyLife.Utilities.Extensions.JsonCopy``1(TinyLife.Objects.IUpdatingObject.UpdateMode)
name: JsonCopy
href: TinyLife.Utilities.Extensions.html#TinyLife_Utilities_Extensions_JsonCopy__1___0_
- name: (
- name: Of
- name: " "
- uid: TinyLife.Objects.IUpdatingObject.UpdateMode
name: UpdateMode
href: TinyLife.Objects.IUpdatingObject.UpdateMode.html
- name: )
- name: (
- uid: TinyLife.Objects.IUpdatingObject.UpdateMode
name: UpdateMode
href: TinyLife.Objects.IUpdatingObject.UpdateMode.html
- name: )
- uid: TinyLife.Objects.IUpdatingObject
commentId: T:TinyLife.Objects.IUpdatingObject
parent: TinyLife.Objects
href: TinyLife.Objects.IUpdatingObject.html
name: IUpdatingObject
nameWithType: IUpdatingObject
fullName: TinyLife.Objects.IUpdatingObject
- 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.World.Map.Update(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
commentId: M:TinyLife.World.Map.Update(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
isExternal: true
href: TinyLife.World.Map.html#TinyLife_World_Map_Update_Microsoft_Xna_Framework_GameTime_System_TimeSpan_System_Single_
name: Update(GameTime, TimeSpan, float)
nameWithType: Map.Update(GameTime, TimeSpan, float)
fullName: TinyLife.World.Map.Update(Microsoft.Xna.Framework.GameTime, System.TimeSpan, float)
nameWithType.vb: Map.Update(GameTime, TimeSpan, Single)
fullName.vb: TinyLife.World.Map.Update(Microsoft.Xna.Framework.GameTime, System.TimeSpan, Single)
name.vb: Update(GameTime, TimeSpan, Single)
spec.csharp:
- uid: TinyLife.World.Map.Update(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
name: Update
href: TinyLife.World.Map.html#TinyLife_World_Map_Update_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.World.Map.Update(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
name: Update
href: TinyLife.World.Map.html#TinyLife_World_Map_Update_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.World.Map.IsActive
commentId: P:TinyLife.World.Map.IsActive
href: TinyLife.World.Map.html#TinyLife_World_Map_IsActive
name: IsActive
nameWithType: Map.IsActive
fullName: TinyLife.World.Map.IsActive
- uid: TinyLife.World.Map.PassiveUpdateMinutes
commentId: F:TinyLife.World.Map.PassiveUpdateMinutes
href: TinyLife.World.Map.html#TinyLife_World_Map_PassiveUpdateMinutes
name: PassiveUpdateMinutes
nameWithType: Map.PassiveUpdateMinutes
fullName: TinyLife.World.Map.PassiveUpdateMinutes
- 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: TinyLife.Objects.IUpdatingObject.html#TinyLife_Objects_IUpdatingObject_Update_Microsoft_Xna_Framework_GameTime_System_TimeSpan_System_Single_
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
href: TinyLife.Objects.IUpdatingObject.html#TinyLife_Objects_IUpdatingObject_Update_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.IUpdatingObject.Update(Microsoft.Xna.Framework.GameTime,System.TimeSpan,System.Single)
name: Update
href: TinyLife.Objects.IUpdatingObject.html#TinyLife_Objects_IUpdatingObject_Update_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.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.World.Map.MinorUpdateMinutes
commentId: F:TinyLife.World.Map.MinorUpdateMinutes
href: TinyLife.World.Map.html#TinyLife_World_Map_MinorUpdateMinutes
name: MinorUpdateMinutes
nameWithType: Map.MinorUpdateMinutes
fullName: TinyLife.World.Map.MinorUpdateMinutes
Reference in a new issue View git blame Copy permalink