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

411 lines
12 KiB
YAML
Raw Permalink Normal View History

2021-08-04 06:51:12 +02:00
### YamlMime:ManagedReference
items:
- uid: TinyLife.Objects.Visibility
commentId: T:TinyLife.Objects.Visibility
id: Visibility
parent: TinyLife.Objects
children:
- TinyLife.Objects.Visibility.HideZoomedOut
2022-09-05 14:19:42 +02:00
- TinyLife.Objects.Visibility.Static
2021-08-04 06:51:12 +02:00
- TinyLife.Objects.Visibility.WhenVisible
- TinyLife.Objects.Visibility.WhenVisibleExt
langs:
- csharp
- vb
name: Visibility
nameWithType: Visibility
fullName: TinyLife.Objects.Visibility
type: Enum
source:
remote:
path: TinyLife/Objects/MapObject.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: Visibility
2022-03-09 16:13:05 +01:00
path: ../TinyLife/Objects/MapObject.cs
2024-04-21 10:22:04 +02:00
startLine: 868
2021-08-04 06:51:12 +02:00
assemblies:
- Tiny Life
namespace: TinyLife.Objects
2024-01-07 16:53:47 +01:00
summary: An enumeration that represents visibility settings for <xref href="TinyLife.Objects.MapObject" data-throw-if-not-resolved="false"></xref> objects
2021-08-04 06:51:12 +02:00
example: []
syntax:
content: public enum Visibility
content.vb: Public Enum Visibility
extensionMethods:
- TinyLife.Objects.Visibility.TinyLife.Utilities.Extensions.JsonCopy``1
- uid: TinyLife.Objects.Visibility.WhenVisible
commentId: F:TinyLife.Objects.Visibility.WhenVisible
id: WhenVisible
parent: TinyLife.Objects.Visibility
langs:
- csharp
- vb
name: WhenVisible
nameWithType: Visibility.WhenVisible
fullName: TinyLife.Objects.Visibility.WhenVisible
type: Field
source:
remote:
path: TinyLife/Objects/MapObject.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: WhenVisible
2022-03-09 16:13:05 +01:00
path: ../TinyLife/Objects/MapObject.cs
2024-04-21 10:22:04 +02:00
startLine: 873
2021-08-04 06:51:12 +02:00
assemblies:
- Tiny Life
namespace: TinyLife.Objects
2024-01-07 16:53:47 +01:00
summary: A visibility setting that causes the object to be visible only when the <xref href="TinyLife.World.MapSection" data-throw-if-not-resolved="false"></xref> it is in is in view
2021-08-04 06:51:12 +02:00
example: []
syntax:
content: WhenVisible = 0
return:
type: TinyLife.Objects.Visibility
- uid: TinyLife.Objects.Visibility.WhenVisibleExt
commentId: F:TinyLife.Objects.Visibility.WhenVisibleExt
id: WhenVisibleExt
parent: TinyLife.Objects.Visibility
langs:
- csharp
- vb
name: WhenVisibleExt
nameWithType: Visibility.WhenVisibleExt
fullName: TinyLife.Objects.Visibility.WhenVisibleExt
type: Field
source:
remote:
path: TinyLife/Objects/MapObject.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: WhenVisibleExt
2022-03-09 16:13:05 +01:00
path: ../TinyLife/Objects/MapObject.cs
2024-04-21 10:22:04 +02:00
startLine: 877
2021-08-04 06:51:12 +02:00
assemblies:
- Tiny Life
namespace: TinyLife.Objects
2024-01-07 16:53:47 +01:00
summary: A visibility setting that causes the object to be visible when the <xref href="TinyLife.World.MapSection" data-throw-if-not-resolved="false"></xref> it is in, or any adjacent map section, is in view
2021-08-04 06:51:12 +02:00
example: []
syntax:
content: WhenVisibleExt = 1
return:
type: TinyLife.Objects.Visibility
- uid: TinyLife.Objects.Visibility.HideZoomedOut
commentId: F:TinyLife.Objects.Visibility.HideZoomedOut
id: HideZoomedOut
parent: TinyLife.Objects.Visibility
langs:
- csharp
- vb
name: HideZoomedOut
nameWithType: Visibility.HideZoomedOut
fullName: TinyLife.Objects.Visibility.HideZoomedOut
type: Field
source:
remote:
path: TinyLife/Objects/MapObject.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: HideZoomedOut
2022-03-09 16:13:05 +01:00
path: ../TinyLife/Objects/MapObject.cs
2024-04-21 10:22:04 +02:00
startLine: 881
2021-08-04 06:51:12 +02:00
assemblies:
- Tiny Life
namespace: TinyLife.Objects
2024-04-14 17:55:54 +02:00
summary: A visibility setting that causes the object to be visible when the <xref href="TinyLife.World.MapSection" data-throw-if-not-resolved="false"></xref> it is in is in view, but only if the game <xref href="MLEM.Cameras.Camera" data-throw-if-not-resolved="false"></xref>'s <xref href="MLEM.Cameras.Camera.Scale" data-throw-if-not-resolved="false"></xref> is greather than <xref href="TinyLife.Utilities.TextureHandler.TileSizeFactor" data-throw-if-not-resolved="false"></xref>.
2021-08-04 06:51:12 +02:00
example: []
syntax:
content: HideZoomedOut = 2
return:
type: TinyLife.Objects.Visibility
2022-09-05 14:19:42 +02:00
- uid: TinyLife.Objects.Visibility.Static
commentId: F:TinyLife.Objects.Visibility.Static
id: Static
parent: TinyLife.Objects.Visibility
langs:
- csharp
- vb
name: Static
nameWithType: Visibility.Static
fullName: TinyLife.Objects.Visibility.Static
type: Field
source:
remote:
path: TinyLife/Objects/MapObject.cs
2023-12-06 13:25:52 +01:00
branch: main
2022-09-05 14:19:42 +02:00
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Static
path: ../TinyLife/Objects/MapObject.cs
2024-04-21 10:22:04 +02:00
startLine: 886
2022-09-05 14:19:42 +02:00
assemblies:
- Tiny Life
namespace: TinyLife.Objects
2024-01-07 16:53:47 +01:00
summary: >-
A visibility setting that causes the object to be drawn using a <xref href="MLEM.Graphics.StaticSpriteBatch" data-throw-if-not-resolved="false"></xref> rather than a <xref href="Microsoft.Xna.Framework.Graphics.SpriteBatch" data-throw-if-not-resolved="false"></xref>.
Objects that move a lot, or objects that are animated, should not use this visibility setting.
2022-09-05 14:19:42 +02:00
example: []
syntax:
content: Static = 3
return:
type: TinyLife.Objects.Visibility
2021-08-04 06:51:12 +02:00
references:
- uid: TinyLife.Objects.MapObject
commentId: T:TinyLife.Objects.MapObject
parent: TinyLife.Objects
2024-01-07 16:53:47 +01:00
href: TinyLife.Objects.MapObject.html
2021-08-04 06:51:12 +02:00
name: MapObject
nameWithType: MapObject
fullName: TinyLife.Objects.MapObject
- uid: TinyLife.Objects
commentId: N:TinyLife.Objects
2024-01-07 16:53:47 +01:00
href: TinyLife.html
2021-08-04 06:51:12 +02:00
name: TinyLife.Objects
nameWithType: TinyLife.Objects
fullName: TinyLife.Objects
2023-03-30 18:07:55 +02:00
spec.csharp:
- uid: TinyLife
name: TinyLife
2024-01-07 16:53:47 +01:00
href: TinyLife.html
2023-03-30 18:07:55 +02:00
- name: .
- uid: TinyLife.Objects
name: Objects
2024-01-07 16:53:47 +01:00
href: TinyLife.Objects.html
2023-03-30 18:07:55 +02:00
spec.vb:
- uid: TinyLife
name: TinyLife
2024-01-07 16:53:47 +01:00
href: TinyLife.html
2023-03-30 18:07:55 +02:00
- name: .
- uid: TinyLife.Objects
name: Objects
2024-01-07 16:53:47 +01:00
href: TinyLife.Objects.html
2021-08-04 06:51:12 +02:00
- uid: TinyLife.Objects.Visibility.TinyLife.Utilities.Extensions.JsonCopy``1
commentId: M:TinyLife.Utilities.Extensions.JsonCopy``1(``0)
parent: TinyLife.Utilities.Extensions
definition: TinyLife.Utilities.Extensions.JsonCopy``1(``0)
2024-01-07 16:53:47 +01:00
href: TinyLife.Utilities.Extensions.html#TinyLife_Utilities_Extensions_JsonCopy__1___0_
2023-03-30 18:07:55 +02:00
name: JsonCopy<Visibility>(Visibility)
nameWithType: Extensions.JsonCopy<Visibility>(Visibility)
fullName: TinyLife.Utilities.Extensions.JsonCopy<TinyLife.Objects.Visibility>(TinyLife.Objects.Visibility)
nameWithType.vb: Extensions.JsonCopy(Of Visibility)(Visibility)
fullName.vb: TinyLife.Utilities.Extensions.JsonCopy(Of TinyLife.Objects.Visibility)(TinyLife.Objects.Visibility)
name.vb: JsonCopy(Of Visibility)(Visibility)
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.Visibility)
name: JsonCopy
2024-01-07 16:53:47 +01:00
href: TinyLife.Utilities.Extensions.html#TinyLife_Utilities_Extensions_JsonCopy__1___0_
2023-03-30 18:07:55 +02:00
- name: <
- uid: TinyLife.Objects.Visibility
name: Visibility
2024-01-07 16:53:47 +01:00
href: TinyLife.Objects.Visibility.html
2023-03-30 18:07:55 +02:00
- name: '>'
2021-08-04 06:51:12 +02:00
- name: (
2023-03-30 18:07:55 +02:00
- uid: TinyLife.Objects.Visibility
name: Visibility
2024-01-07 16:53:47 +01:00
href: TinyLife.Objects.Visibility.html
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.Visibility)
name: JsonCopy
2024-01-07 16:53:47 +01:00
href: TinyLife.Utilities.Extensions.html#TinyLife_Utilities_Extensions_JsonCopy__1___0_
2023-03-30 18:07:55 +02:00
- name: (
- name: Of
- name: " "
- uid: TinyLife.Objects.Visibility
name: Visibility
2024-01-07 16:53:47 +01:00
href: TinyLife.Objects.Visibility.html
2023-03-30 18:07:55 +02:00
- name: )
2021-08-04 06:51:12 +02:00
- name: (
2023-03-30 18:07:55 +02:00
- uid: TinyLife.Objects.Visibility
name: Visibility
2024-01-07 16:53:47 +01:00
href: TinyLife.Objects.Visibility.html
2021-08-04 06:51:12 +02:00
- name: )
- uid: TinyLife.Utilities.Extensions.JsonCopy``1(``0)
commentId: M:TinyLife.Utilities.Extensions.JsonCopy``1(``0)
2024-01-07 16:53:47 +01:00
href: TinyLife.Utilities.Extensions.html#TinyLife_Utilities_Extensions_JsonCopy__1___0_
2021-08-04 06:51:12 +02:00
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
2024-01-07 16:53:47 +01:00
href: TinyLife.Utilities.Extensions.html#TinyLife_Utilities_Extensions_JsonCopy__1___0_
2023-03-30 18:07:55 +02:00
- 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
2024-01-07 16:53:47 +01:00
href: TinyLife.Utilities.Extensions.html#TinyLife_Utilities_Extensions_JsonCopy__1___0_
2023-03-30 18:07:55 +02:00
- 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
2024-01-07 16:53:47 +01:00
href: TinyLife.Utilities.Extensions.html
2021-08-04 06:51:12 +02:00
name: Extensions
nameWithType: Extensions
fullName: TinyLife.Utilities.Extensions
- uid: TinyLife.Utilities
commentId: N:TinyLife.Utilities
2024-01-07 16:53:47 +01:00
href: TinyLife.html
2021-08-04 06:51:12 +02:00
name: TinyLife.Utilities
nameWithType: TinyLife.Utilities
fullName: TinyLife.Utilities
2023-03-30 18:07:55 +02:00
spec.csharp:
- uid: TinyLife
name: TinyLife
2024-01-07 16:53:47 +01:00
href: TinyLife.html
2023-03-30 18:07:55 +02:00
- name: .
- uid: TinyLife.Utilities
name: Utilities
2024-01-07 16:53:47 +01:00
href: TinyLife.Utilities.html
2023-03-30 18:07:55 +02:00
spec.vb:
- uid: TinyLife
name: TinyLife
2024-01-07 16:53:47 +01:00
href: TinyLife.html
2023-03-30 18:07:55 +02:00
- name: .
- uid: TinyLife.Utilities
name: Utilities
2024-01-07 16:53:47 +01:00
href: TinyLife.Utilities.html
2021-08-04 06:51:12 +02:00
- uid: TinyLife.World.MapSection
commentId: T:TinyLife.World.MapSection
parent: TinyLife.World
2024-01-07 16:53:47 +01:00
href: TinyLife.World.MapSection.html
2021-08-04 06:51:12 +02:00
name: MapSection
nameWithType: MapSection
fullName: TinyLife.World.MapSection
- uid: TinyLife.Objects.Visibility
commentId: T:TinyLife.Objects.Visibility
parent: TinyLife.Objects
2024-01-07 16:53:47 +01:00
href: TinyLife.Objects.Visibility.html
2021-08-04 06:51:12 +02:00
name: Visibility
nameWithType: Visibility
fullName: TinyLife.Objects.Visibility
- uid: TinyLife.World
commentId: N:TinyLife.World
2024-01-07 16:53:47 +01:00
href: TinyLife.html
2021-08-04 06:51:12 +02:00
name: TinyLife.World
nameWithType: TinyLife.World
fullName: TinyLife.World
2023-03-30 18:07:55 +02:00
spec.csharp:
- uid: TinyLife
name: TinyLife
2024-01-07 16:53:47 +01:00
href: TinyLife.html
2023-03-30 18:07:55 +02:00
- name: .
- uid: TinyLife.World
name: World
2024-01-07 16:53:47 +01:00
href: TinyLife.World.html
2023-03-30 18:07:55 +02:00
spec.vb:
- uid: TinyLife
name: TinyLife
2024-01-07 16:53:47 +01:00
href: TinyLife.html
2023-03-30 18:07:55 +02:00
- name: .
- uid: TinyLife.World
name: World
2024-01-07 16:53:47 +01:00
href: TinyLife.World.html
2021-08-04 06:51:12 +02:00
- uid: MLEM.Cameras.Camera
commentId: T:MLEM.Cameras.Camera
parent: MLEM.Cameras
isExternal: true
name: Camera
nameWithType: Camera
fullName: MLEM.Cameras.Camera
- uid: MLEM.Cameras.Camera.Scale
commentId: P:MLEM.Cameras.Camera.Scale
isExternal: true
2023-03-30 18:07:55 +02:00
name: Scale
nameWithType: Camera.Scale
fullName: MLEM.Cameras.Camera.Scale
2024-04-14 17:55:54 +02:00
- uid: TinyLife.Utilities.TextureHandler.TileSizeFactor
commentId: P:TinyLife.Utilities.TextureHandler.TileSizeFactor
href: TinyLife.Utilities.TextureHandler.html#TinyLife_Utilities_TextureHandler_TileSizeFactor
name: TileSizeFactor
nameWithType: TextureHandler.TileSizeFactor
fullName: TinyLife.Utilities.TextureHandler.TileSizeFactor
2021-08-04 06:51:12 +02:00
- uid: MLEM.Cameras
commentId: N:MLEM.Cameras
isExternal: true
name: MLEM.Cameras
nameWithType: MLEM.Cameras
fullName: MLEM.Cameras
2023-03-30 18:07:55 +02:00
spec.csharp:
- uid: MLEM
name: MLEM
isExternal: true
- name: .
- uid: MLEM.Cameras
name: Cameras
isExternal: true
spec.vb:
- uid: MLEM
name: MLEM
isExternal: true
- name: .
- uid: MLEM.Cameras
name: Cameras
isExternal: true
2022-09-05 14:19:42 +02:00
- uid: MLEM.Graphics.StaticSpriteBatch
commentId: T:MLEM.Graphics.StaticSpriteBatch
isExternal: true
2023-03-30 18:07:55 +02:00
name: StaticSpriteBatch
nameWithType: StaticSpriteBatch
fullName: MLEM.Graphics.StaticSpriteBatch
2022-09-05 14:19:42 +02:00
- uid: Microsoft.Xna.Framework.Graphics.SpriteBatch
commentId: T:Microsoft.Xna.Framework.Graphics.SpriteBatch
parent: Microsoft.Xna.Framework.Graphics
isExternal: true
name: SpriteBatch
nameWithType: SpriteBatch
fullName: Microsoft.Xna.Framework.Graphics.SpriteBatch
- uid: Microsoft.Xna.Framework.Graphics
commentId: N:Microsoft.Xna.Framework.Graphics
isExternal: true
name: Microsoft.Xna.Framework.Graphics
nameWithType: Microsoft.Xna.Framework.Graphics
fullName: Microsoft.Xna.Framework.Graphics
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
- name: .
- uid: Microsoft.Xna.Framework.Graphics
name: Graphics
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
- name: .
- uid: Microsoft.Xna.Framework.Graphics
name: Graphics
isExternal: true