TinyLifeWeb/docs/api/TinyLife.Utilities.SelectionHandler.yml
2024-11-29 15:11:07 +01:00

687 lines
23 KiB
YAML
Generated

### YamlMime:ManagedReference
items:
- uid: TinyLife.Utilities.SelectionHandler
commentId: T:TinyLife.Utilities.SelectionHandler
id: SelectionHandler
parent: TinyLife.Utilities
children:
- TinyLife.Utilities.SelectionHandler.SelectedObjectChanged
- TinyLife.Utilities.SelectionHandler.SelectedRoofChanged
- TinyLife.Utilities.SelectionHandler.SelectedStairsChanged
- TinyLife.Utilities.SelectionHandler.SelectedWallChanged
langs:
- csharp
- vb
name: SelectionHandler
nameWithType: SelectionHandler
fullName: TinyLife.Utilities.SelectionHandler
type: Class
assemblies:
- Tiny Life
namespace: TinyLife.Utilities
summary: >-
The selection handler is responsible for handling the selection of objects, walls, roofs and stairs in the game world through pixel-perfect selection with the mouse using a <xref href="TinyLife.Utilities.SelectionHandler.RenderTarget" data-throw-if-not-resolved="false"></xref> that assigns a unique color to each object.
For modders, this class holds various events that can be subscribed to in order to be notified when the selected object changes.
example: []
syntax:
content: public class SelectionHandler
content.vb: Public Class SelectionHandler
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
extensionMethods:
- TinyLife.Utilities.SelectionHandler.TinyLife.Utilities.Extensions.JsonCopy``1
- uid: TinyLife.Utilities.SelectionHandler.SelectedObjectChanged
commentId: E:TinyLife.Utilities.SelectionHandler.SelectedObjectChanged
id: SelectedObjectChanged
parent: TinyLife.Utilities.SelectionHandler
langs:
- csharp
- vb
name: SelectedObjectChanged
nameWithType: SelectionHandler.SelectedObjectChanged
fullName: TinyLife.Utilities.SelectionHandler.SelectedObjectChanged
type: Event
assemblies:
- Tiny Life
namespace: TinyLife.Utilities
summary: >-
An event that is invoked when the selected object changes.
The first parameter is the previously selected object, and the second parameter is the newly selected object.
example: []
syntax:
content: public static event Action<MapObject, MapObject> SelectedObjectChanged
return:
type: System.Action{TinyLife.Objects.MapObject,TinyLife.Objects.MapObject}
content.vb: Public Shared Event SelectedObjectChanged As Action(Of MapObject, MapObject)
- uid: TinyLife.Utilities.SelectionHandler.SelectedWallChanged
commentId: E:TinyLife.Utilities.SelectionHandler.SelectedWallChanged
id: SelectedWallChanged
parent: TinyLife.Utilities.SelectionHandler
langs:
- csharp
- vb
name: SelectedWallChanged
nameWithType: SelectionHandler.SelectedWallChanged
fullName: TinyLife.Utilities.SelectionHandler.SelectedWallChanged
type: Event
assemblies:
- Tiny Life
namespace: TinyLife.Utilities
summary: >-
An event that is invoked when the selected wall changes.
The first parameter is the previously selected wall, and the second parameter is the newly selected wall.
example: []
syntax:
content: public static event Action<WallLike, WallLike> SelectedWallChanged
return:
type: System.Action{TinyLife.Objects.WallLike,TinyLife.Objects.WallLike}
content.vb: Public Shared Event SelectedWallChanged As Action(Of WallLike, WallLike)
- uid: TinyLife.Utilities.SelectionHandler.SelectedRoofChanged
commentId: E:TinyLife.Utilities.SelectionHandler.SelectedRoofChanged
id: SelectedRoofChanged
parent: TinyLife.Utilities.SelectionHandler
langs:
- csharp
- vb
name: SelectedRoofChanged
nameWithType: SelectionHandler.SelectedRoofChanged
fullName: TinyLife.Utilities.SelectionHandler.SelectedRoofChanged
type: Event
assemblies:
- Tiny Life
namespace: TinyLife.Utilities
summary: >-
An event that is invoked when the selected roof changes.
The first parameter is the previously selected roof, and the second parameter is the newly selected roof.
example: []
syntax:
content: public static event Action<Roof, Roof> SelectedRoofChanged
return:
type: System.Action{TinyLife.World.Roof,TinyLife.World.Roof}
content.vb: Public Shared Event SelectedRoofChanged As Action(Of Roof, Roof)
- uid: TinyLife.Utilities.SelectionHandler.SelectedStairsChanged
commentId: E:TinyLife.Utilities.SelectionHandler.SelectedStairsChanged
id: SelectedStairsChanged
parent: TinyLife.Utilities.SelectionHandler
langs:
- csharp
- vb
name: SelectedStairsChanged
nameWithType: SelectionHandler.SelectedStairsChanged
fullName: TinyLife.Utilities.SelectionHandler.SelectedStairsChanged
type: Event
assemblies:
- Tiny Life
namespace: TinyLife.Utilities
summary: >-
An event that is invoked when the selected stairs change.
The first parameter is the previously selected stairs, and the second parameter is the newly selected stairs.
example: []
syntax:
content: public static event Action<Stairs, Stairs> SelectedStairsChanged
return:
type: System.Action{TinyLife.World.Stairs,TinyLife.World.Stairs}
content.vb: Public Shared Event SelectedStairsChanged As Action(Of Stairs, Stairs)
references:
- uid: TinyLife.Utilities.SelectionHandler.RenderTarget
commentId: P:TinyLife.Utilities.SelectionHandler.RenderTarget
name: RenderTarget
nameWithType: SelectionHandler.RenderTarget
fullName: TinyLife.Utilities.SelectionHandler.RenderTarget
- 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: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: TinyLife.Utilities.SelectionHandler.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<SelectionHandler>(SelectionHandler)
nameWithType: Extensions.JsonCopy<SelectionHandler>(SelectionHandler)
fullName: TinyLife.Utilities.Extensions.JsonCopy<TinyLife.Utilities.SelectionHandler>(TinyLife.Utilities.SelectionHandler)
nameWithType.vb: Extensions.JsonCopy(Of SelectionHandler)(SelectionHandler)
fullName.vb: TinyLife.Utilities.Extensions.JsonCopy(Of TinyLife.Utilities.SelectionHandler)(TinyLife.Utilities.SelectionHandler)
name.vb: JsonCopy(Of SelectionHandler)(SelectionHandler)
spec.csharp:
- uid: TinyLife.Utilities.Extensions.JsonCopy``1(TinyLife.Utilities.SelectionHandler)
name: JsonCopy
href: TinyLife.Utilities.Extensions.html#TinyLife_Utilities_Extensions_JsonCopy__1___0_
- name: <
- uid: TinyLife.Utilities.SelectionHandler
name: SelectionHandler
href: TinyLife.Utilities.SelectionHandler.html
- name: '>'
- name: (
- uid: TinyLife.Utilities.SelectionHandler
name: SelectionHandler
href: TinyLife.Utilities.SelectionHandler.html
- name: )
spec.vb:
- uid: TinyLife.Utilities.Extensions.JsonCopy``1(TinyLife.Utilities.SelectionHandler)
name: JsonCopy
href: TinyLife.Utilities.Extensions.html#TinyLife_Utilities_Extensions_JsonCopy__1___0_
- name: (
- name: Of
- name: " "
- uid: TinyLife.Utilities.SelectionHandler
name: SelectionHandler
href: TinyLife.Utilities.SelectionHandler.html
- name: )
- name: (
- uid: TinyLife.Utilities.SelectionHandler
name: SelectionHandler
href: TinyLife.Utilities.SelectionHandler.html
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- 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: System.Action{TinyLife.Objects.MapObject,TinyLife.Objects.MapObject}
commentId: T:System.Action{TinyLife.Objects.MapObject,TinyLife.Objects.MapObject}
parent: System
definition: System.Action`2
href: https://learn.microsoft.com/dotnet/api/system.action-2
name: Action<MapObject, MapObject>
nameWithType: Action<MapObject, MapObject>
fullName: System.Action<TinyLife.Objects.MapObject, TinyLife.Objects.MapObject>
nameWithType.vb: Action(Of MapObject, MapObject)
fullName.vb: System.Action(Of TinyLife.Objects.MapObject, TinyLife.Objects.MapObject)
name.vb: Action(Of MapObject, MapObject)
spec.csharp:
- uid: System.Action`2
name: Action
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-2
- name: <
- uid: TinyLife.Objects.MapObject
name: MapObject
href: TinyLife.Objects.MapObject.html
- name: ','
- name: " "
- uid: TinyLife.Objects.MapObject
name: MapObject
href: TinyLife.Objects.MapObject.html
- name: '>'
spec.vb:
- uid: System.Action`2
name: Action
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-2
- name: (
- name: Of
- name: " "
- uid: TinyLife.Objects.MapObject
name: MapObject
href: TinyLife.Objects.MapObject.html
- name: ','
- name: " "
- uid: TinyLife.Objects.MapObject
name: MapObject
href: TinyLife.Objects.MapObject.html
- name: )
- uid: System.Action`2
commentId: T:System.Action`2
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-2
name: Action<T1, T2>
nameWithType: Action<T1, T2>
fullName: System.Action<T1, T2>
nameWithType.vb: Action(Of T1, T2)
fullName.vb: System.Action(Of T1, T2)
name.vb: Action(Of T1, T2)
spec.csharp:
- uid: System.Action`2
name: Action
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-2
- name: <
- name: T1
- name: ','
- name: " "
- name: T2
- name: '>'
spec.vb:
- uid: System.Action`2
name: Action
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-2
- name: (
- name: Of
- name: " "
- name: T1
- name: ','
- name: " "
- name: T2
- name: )
- uid: System.Action{TinyLife.Objects.WallLike,TinyLife.Objects.WallLike}
commentId: T:System.Action{TinyLife.Objects.WallLike,TinyLife.Objects.WallLike}
parent: System
definition: System.Action`2
href: https://learn.microsoft.com/dotnet/api/system.action-2
name: Action<WallLike, WallLike>
nameWithType: Action<WallLike, WallLike>
fullName: System.Action<TinyLife.Objects.WallLike, TinyLife.Objects.WallLike>
nameWithType.vb: Action(Of WallLike, WallLike)
fullName.vb: System.Action(Of TinyLife.Objects.WallLike, TinyLife.Objects.WallLike)
name.vb: Action(Of WallLike, WallLike)
spec.csharp:
- uid: System.Action`2
name: Action
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-2
- name: <
- uid: TinyLife.Objects.WallLike
name: WallLike
href: TinyLife.Objects.WallLike.html
- name: ','
- name: " "
- uid: TinyLife.Objects.WallLike
name: WallLike
href: TinyLife.Objects.WallLike.html
- name: '>'
spec.vb:
- uid: System.Action`2
name: Action
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-2
- name: (
- name: Of
- name: " "
- uid: TinyLife.Objects.WallLike
name: WallLike
href: TinyLife.Objects.WallLike.html
- name: ','
- name: " "
- uid: TinyLife.Objects.WallLike
name: WallLike
href: TinyLife.Objects.WallLike.html
- name: )
- uid: System.Action{TinyLife.World.Roof,TinyLife.World.Roof}
commentId: T:System.Action{TinyLife.World.Roof,TinyLife.World.Roof}
parent: System
definition: System.Action`2
href: https://learn.microsoft.com/dotnet/api/system.action-2
name: Action<Roof, Roof>
nameWithType: Action<Roof, Roof>
fullName: System.Action<TinyLife.World.Roof, TinyLife.World.Roof>
nameWithType.vb: Action(Of Roof, Roof)
fullName.vb: System.Action(Of TinyLife.World.Roof, TinyLife.World.Roof)
name.vb: Action(Of Roof, Roof)
spec.csharp:
- uid: System.Action`2
name: Action
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-2
- name: <
- uid: TinyLife.World.Roof
name: Roof
href: TinyLife.World.Roof.html
- name: ','
- name: " "
- uid: TinyLife.World.Roof
name: Roof
href: TinyLife.World.Roof.html
- name: '>'
spec.vb:
- uid: System.Action`2
name: Action
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-2
- name: (
- name: Of
- name: " "
- uid: TinyLife.World.Roof
name: Roof
href: TinyLife.World.Roof.html
- name: ','
- name: " "
- uid: TinyLife.World.Roof
name: Roof
href: TinyLife.World.Roof.html
- name: )
- uid: System.Action{TinyLife.World.Stairs,TinyLife.World.Stairs}
commentId: T:System.Action{TinyLife.World.Stairs,TinyLife.World.Stairs}
parent: System
definition: System.Action`2
href: https://learn.microsoft.com/dotnet/api/system.action-2
name: Action<Stairs, Stairs>
nameWithType: Action<Stairs, Stairs>
fullName: System.Action<TinyLife.World.Stairs, TinyLife.World.Stairs>
nameWithType.vb: Action(Of Stairs, Stairs)
fullName.vb: System.Action(Of TinyLife.World.Stairs, TinyLife.World.Stairs)
name.vb: Action(Of Stairs, Stairs)
spec.csharp:
- uid: System.Action`2
name: Action
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-2
- name: <
- uid: TinyLife.World.Stairs
name: Stairs
href: TinyLife.World.Stairs.html
- name: ','
- name: " "
- uid: TinyLife.World.Stairs
name: Stairs
href: TinyLife.World.Stairs.html
- name: '>'
spec.vb:
- uid: System.Action`2
name: Action
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.action-2
- name: (
- name: Of
- name: " "
- uid: TinyLife.World.Stairs
name: Stairs
href: TinyLife.World.Stairs.html
- name: ','
- name: " "
- uid: TinyLife.World.Stairs
name: Stairs
href: TinyLife.World.Stairs.html
- name: )