Class FurnitureType
A furniture type is basically a blueprint for Furniture objects. Each furniture type can create a furniture instance and the type's data will be transferred to the instance. Furniture types are automatically listed in the FurnitureTool if registered using Register(TypeSettings).
[JsonConverter(typeof(StaticJsonConverter<FurnitureType>), new object[] { typeof(FurnitureType), "PrivateTypes" })]
public class FurnitureType : GenericDataHolder, IGenericDataHolder, IEmotionSource- Inheritance
-
GenericDataHolderFurnitureType
- Implements
-
IGenericDataHolder
- Inherited Members
-
GenericDataHolder.GetDataKeys()
- Extension Methods
Fields
BabyBathtub
public static readonly FurnitureType BabyBathtubField Value
BabyBook
public static readonly FurnitureType BabyBookField Value
BarFrameChair
public static readonly FurnitureType BarFrameChairField Value
BaristaCoffeeMachine
public static readonly FurnitureType BaristaCoffeeMachineField Value
BigBush
public static readonly FurnitureType BigBushField Value
BigPedestal
public static readonly FurnitureType BigPedestalField Value
BigRocks
public static readonly FurnitureType[] BigRocksField Value
BigVase
public static readonly FurnitureType BigVaseField Value
BirchTree
public static readonly FurnitureType BirchTreeField Value
Book
public static readonly FurnitureType BookField Value
BookCart
public static readonly FurnitureType BookCartField Value
BottledSunlight
public static readonly FurnitureType BottledSunlightField Value
BridgeBorderEnd
public static readonly FurnitureType BridgeBorderEndField Value
BridgeBorderSegment
public static readonly FurnitureType BridgeBorderSegmentField Value
BridgeBorderStart
public static readonly FurnitureType BridgeBorderStartField Value
BulbFairyLights
public static readonly FurnitureType BulbFairyLightsField Value
CafeDisplayCase
public static readonly FurnitureType CafeDisplayCaseField Value
CafeSign
public static readonly FurnitureType CafeSignField Value
Cattails
public static readonly FurnitureType[] CattailsField Value
ChildStove
public static readonly FurnitureType ChildStoveField Value
CloverPatch
public static readonly FurnitureType CloverPatchField Value
CocktailShaker
public static readonly FurnitureType CocktailShakerField Value
ColorfulCandles
public static readonly FurnitureType ColorfulCandlesField Value
ColoringBook
public static readonly FurnitureType ColoringBookField Value
ContemporaryBar
public static readonly FurnitureType ContemporaryBarField Value
ContemporaryCocktailBar
public static readonly FurnitureType ContemporaryCocktailBarField Value
ContemporaryCounter
public static readonly FurnitureType ContemporaryCounterField Value
ContemporaryDoubleBed
public static readonly FurnitureType ContemporaryDoubleBedField Value
ContemporaryNightstand
public static readonly FurnitureType ContemporaryNightstandField Value
ContemporaryPaintings
public static readonly FurnitureType[] ContemporaryPaintingsField Value
ContemporarySingleBed
public static readonly FurnitureType ContemporarySingleBedField Value
CounterLight
public static readonly FurnitureType CounterLightField Value
CountryFence
[Obsolete("Use the new FenceWall system instead")]
public static readonly FurnitureType CountryFenceField Value
CushionedWoodworkingSofa
public static readonly FurnitureType CushionedWoodworkingSofaField Value
CustomPainting
public static readonly FurnitureType CustomPaintingField Value
Cypress
public static readonly FurnitureType CypressField Value
DecorativeBowls
public static readonly FurnitureType[] DecorativeBowlsField Value
DecorativeKite
public static readonly FurnitureType DecorativeKiteField Value
DecorativeLogPile
public static readonly FurnitureType DecorativeLogPileField Value
DirtyTextures
The textures that this furniture type overlays over its regular Textures when it is Dirty. If DirtyOverlayTextureName is not set, this field will be null.
public readonly IDictionary<Direction2, TextureRegion[]> DirtyTexturesField Value
- IDictionary<Direction2, TextureRegion[]>
Doormat
public static readonly FurnitureType DoormatField Value
Dumbbell
public static readonly FurnitureType DumbbellField Value
DumbbellRack
public static readonly FurnitureType DumbbellRackField Value
EdisonWoodworkingLamp
public static readonly FurnitureType EdisonWoodworkingLampField Value
EmptyGlass
public static readonly FurnitureType EmptyGlassField Value
EmptyMug
public static readonly FurnitureType EmptyMugField Value
EmptyPlate
public static readonly FurnitureType EmptyPlateField Value
EmptyPlatter
public static readonly FurnitureType EmptyPlatterField Value
EvergreenTree
public static readonly FurnitureType EvergreenTreeField Value
FancyOttoman
public static readonly FurnitureType FancyOttomanField Value
FoodGlass
public static readonly FurnitureType FoodGlassField Value
FoodMug
public static readonly FurnitureType FoodMugField Value
FoodPlate
public static readonly FurnitureType FoodPlateField Value
FoodPlatter
public static readonly FurnitureType FoodPlatterField Value
FourPostBed
public static readonly FurnitureType FourPostBedField Value
FrameChair
public static readonly FurnitureType FrameChairField Value
FullyCushionedWoodworkingSofa
public static readonly FurnitureType FullyCushionedWoodworkingSofaField Value
GlassDinnerTable
public static readonly FurnitureType GlassDinnerTableField Value
GlassJars
public static readonly FurnitureType[] GlassJarsField Value
GlassPenCup
public static readonly FurnitureType GlassPenCupField Value
GlassSingleTable
public static readonly FurnitureType GlassSingleTableField Value
GrassPatch
public static readonly FurnitureType GrassPatchField Value
Gravestone
public static readonly FurnitureType GravestoneField Value
GrillingFood
public static readonly FurnitureType GrillingFoodField Value
Hedge
public static readonly FurnitureType HedgeField Value
HomeworkBook
public static readonly FurnitureType HomeworkBookField Value
HugeRectangleRug
public static readonly FurnitureType HugeRectangleRugField Value
LargeContemporaryPainting
public static readonly FurnitureType LargeContemporaryPaintingField Value
LargeOpenShelf
public static readonly FurnitureType LargeOpenShelfField Value
LargePotPlant
public static readonly FurnitureType[] LargePotPlantField Value
LargeRectangleRug
public static readonly FurnitureType LargeRectangleRugField Value
LargeRoundRug
public static readonly FurnitureType LargeRoundRugField Value
LargeWoodworkingSofa
public static readonly FurnitureType LargeWoodworkingSofaField Value
LgbtFlags
public static readonly FurnitureType[] LgbtFlagsField Value
LightUpCase
public static readonly FurnitureType LightUpCaseField Value
LongDinnerTable
public static readonly FurnitureType LongDinnerTableField Value
MagazineStack
public static readonly FurnitureType MagazineStackField Value
Mailbox
public static readonly FurnitureType MailboxField Value
MapleFairyLights
public static readonly FurnitureType MapleFairyLightsField Value
MapleTree
public static readonly FurnitureType MapleTreeField Value
MixologyKit
public static readonly FurnitureType MixologyKitField Value
MobilePhone
public static readonly FurnitureType MobilePhoneField Value
ModernBed
public static readonly FurnitureType ModernBedField Value
ModernBedsideLamp
public static readonly FurnitureType ModernBedsideLampField Value
ModernChair
public static readonly FurnitureType ModernChairField Value
ModernCoffeeTable
public static readonly FurnitureType ModernCoffeeTableField Value
ModernComputer
public static readonly FurnitureType ModernComputerField Value
ModernCrib
public static readonly FurnitureType ModernCribField Value
ModernFridge
public static readonly FurnitureType ModernFridgeField Value
ModernLandlinePhone
public static readonly FurnitureType ModernLandlinePhoneField Value
ModernModularCurtains
public static readonly FurnitureType[] ModernModularCurtainsField Value
ModernShapeRug
public static readonly FurnitureType ModernShapeRugField Value
ModernSingleBed
public static readonly FurnitureType ModernSingleBedField Value
ModernSingleDiningTable
public static readonly FurnitureType ModernSingleDiningTableField Value
ModernSink
public static readonly FurnitureType ModernSinkField Value
ModernStove
public static readonly FurnitureType ModernStoveField Value
ModernTv
public static readonly FurnitureType ModernTvField Value
ModernTvStand
public static readonly FurnitureType ModernTvStandField Value
ModernWoodworkingLamp
public static readonly FurnitureType ModernWoodworkingLampField Value
Mop
public static readonly FurnitureType MopField Value
MuseumSign
public static readonly FurnitureType MuseumSignField Value
Newspaper
public static readonly FurnitureType NewspaperField Value
OakTree
public static readonly FurnitureType OakTreeField Value
OldComputer
public static readonly FurnitureType OldComputerField Value
OrnateBed
public static readonly FurnitureType OrnateBedField Value
OrnateFlowerBed
public static readonly FurnitureType OrnateFlowerBedField Value
OrnateSingleBed
public static readonly FurnitureType OrnateSingleBedField Value
PaintBrush
public static readonly FurnitureType PaintBrushField Value
Palette
public static readonly FurnitureType PaletteField Value
PaperPendantLight
public static readonly FurnitureType PaperPendantLightField Value
ParkTrashCan
public static readonly FurnitureType ParkTrashCanField Value
Pen
public static readonly FurnitureType PenField Value
PlainCoffeeTable
public static readonly FurnitureType PlainCoffeeTableField Value
PlateStack
public static readonly FurnitureType PlateStackField Value
Pot
public static readonly FurnitureType PotField Value
PotPlant
public static readonly FurnitureType PotPlantField Value
PreparedFood
public static readonly FurnitureType PreparedFoodField Value
PrismaticShard
public static readonly FurnitureType PrismaticShardField Value
ProteinShakeKit
public static readonly FurnitureType ProteinShakeKitField Value
Puddle
public static readonly FurnitureType PuddleField Value
Puzzle
public static readonly FurnitureType PuzzleField Value
RetroChair
public static readonly FurnitureType RetroChairField Value
RetroClock
public static readonly FurnitureType RetroClockField Value
RetroDinnerTable
public static readonly FurnitureType RetroDinnerTableField Value
RetroDinnerTableSquare
public static readonly FurnitureType RetroDinnerTableSquareField Value
RetroDoubleBed
public static readonly FurnitureType RetroDoubleBedField Value
RetroFridge
public static readonly FurnitureType RetroFridgeField Value
RetroSingleBed
public static readonly FurnitureType RetroSingleBedField Value
RetroSingleTable
public static readonly FurnitureType RetroSingleTableField Value
RetroSingleTableSquare
public static readonly FurnitureType RetroSingleTableSquareField Value
RetroSofa
public static readonly FurnitureType RetroSofaField Value
RetroStove
public static readonly FurnitureType RetroStoveField Value
RetroTv
public static readonly FurnitureType RetroTvField Value
RhombusRug
public static readonly FurnitureType RhombusRugField Value
RoundCeilingLamp
public static readonly FurnitureType RoundCeilingLampField Value
RoundedBackChair
public static readonly FurnitureType RoundedBackChairField Value
Sandbox
public static readonly FurnitureType SandboxField Value
SandboxStuff
public static readonly FurnitureType SandboxStuffField Value
SelfCareBottles
public static readonly FurnitureType SelfCareBottlesField Value
Settings
This furniture type's settings
public readonly FurnitureType.TypeSettings SettingsField Value
SimpleBar
public static readonly FurnitureType SimpleBarField Value
SimpleBench
public static readonly FurnitureType SimpleBenchField Value
SimpleBookshelf
public static readonly FurnitureType SimpleBookshelfField Value
SimpleCeilingLamp
public static readonly FurnitureType SimpleCeilingLampField Value
SimpleChair
public static readonly FurnitureType SimpleChairField Value
SimpleChangingStation
public static readonly FurnitureType SimpleChangingStationField Value
SimpleCounter
public static readonly FurnitureType SimpleCounterField Value
SimpleDesk
public static readonly FurnitureType SimpleDeskField Value
SimpleDoubleSidedBookshelf
public static readonly FurnitureType SimpleDoubleSidedBookshelfField Value
SimpleDrawer
public static readonly FurnitureType SimpleDrawerField Value
SimpleEasel
public static readonly FurnitureType SimpleEaselField Value
SimpleGroundLight
public static readonly FurnitureType SimpleGroundLightField Value
SimpleLamp
public static readonly FurnitureType SimpleLampField Value
SimpleLowTable
public static readonly FurnitureType SimpleLowTableField Value
SimpleNightstand
public static readonly FurnitureType SimpleNightstandField Value
SimpleOpenShower
public static readonly FurnitureType SimpleOpenShowerField Value
SimplePicnicTable
public static readonly FurnitureType SimplePicnicTableField Value
SimplePotty
public static readonly FurnitureType SimplePottyField Value
SimpleShower
public static readonly FurnitureType SimpleShowerField Value
SimpleSofa
public static readonly FurnitureType SimpleSofaField Value
SimpleStoneWall
[Obsolete("Use the new FenceWall system instead")]
public static readonly FurnitureType SimpleStoneWallField Value
SimpleToilet
public static readonly FurnitureType SimpleToiletField Value
SimpleWallSink
public static readonly FurnitureType SimpleWallSinkField Value
SingleLilyPad
public static readonly FurnitureType SingleLilyPadField Value
SkillBooks
public static readonly Dictionary<FurnitureType, SkillType> SkillBooksField Value
SmallBarbecue
public static readonly FurnitureType SmallBarbecueField Value
SmallBlinds
public static readonly FurnitureType[] SmallBlindsField Value
SmallBookStack
public static readonly FurnitureType SmallBookStackField Value
SmallBush
public static readonly FurnitureType SmallBushField Value
SmallCandlestick
public static readonly FurnitureType SmallCandlestickField Value
SmallChimney
public static readonly FurnitureType SmallChimneyField Value
SmallJungleGym
public static readonly FurnitureType SmallJungleGymField Value
SmallMirror
public static readonly FurnitureType SmallMirrorField Value
SmallModernShapeRug
public static readonly FurnitureType SmallModernShapeRugField Value
SmallOpenShelf
public static readonly FurnitureType SmallOpenShelfField Value
SmallPicnicTable
public static readonly FurnitureType SmallPicnicTableField Value
SmallPlant
public static readonly FurnitureType SmallPlantField Value
SmallRocks
public static readonly FurnitureType SmallRocksField Value
SmallShovel
public static readonly FurnitureType SmallShovelField Value
SmallSimpleCurtain
public static readonly FurnitureType SmallSimpleCurtainField Value
Spanner
public static readonly FurnitureType SpannerField Value
Sponge
public static readonly FurnitureType SpongeField Value
SquareDinnerTable
public static readonly FurnitureType SquareDinnerTableField Value
SquareIndoorTrashCan
public static readonly FurnitureType SquareIndoorTrashCanField Value
SquarePlantPots
public static readonly FurnitureType[] SquarePlantPotsField Value
StandingCoatRack
public static readonly FurnitureType StandingCoatRackField Value
StandingDesk
public static readonly FurnitureType StandingDeskField Value
StandingMirror
public static readonly FurnitureType StandingMirrorField Value
StorageBoxSeat
public static readonly FurnitureType StorageBoxSeatField Value
StreetLamps
public static readonly FurnitureType[] StreetLampsField Value
StudyBook
public static readonly FurnitureType StudyBookField Value
Succulents
public static readonly FurnitureType[] SucculentsField Value
Sunflowers
public static readonly FurnitureType[] SunflowersField Value
SwirlWoodworkingLamp
public static readonly FurnitureType SwirlWoodworkingLampField Value
TallBoxBookshelf
public static readonly FurnitureType TallBoxBookshelfField Value
TallCountryFence
[Obsolete("Use the new FenceWall system instead")]
public static readonly FurnitureType TallCountryFenceField Value
TallDresser
public static readonly FurnitureType TallDresserField Value
TeaKit
public static readonly FurnitureType TeaKitField Value
Textures
The textures that this furniture type has. Each texture is automatically loaded based on the registered MLEM.Data.DataTextureAtlas instances. If a furniture type has multiple Map entries (or multiple Colors), additional texture regions will automatically be created to the right of the original texture region.
public readonly IDictionary<Direction2, TextureRegion[]> TexturesField Value
- IDictionary<Direction2, TextureRegion[]>
TinyDinnerTable
public static readonly FurnitureType TinyDinnerTableField Value
ToyCar
public static readonly FurnitureType ToyCarField Value
TraditionalBar
public static readonly FurnitureType TraditionalBarField Value
TraditionalBedsideLamp
public static readonly FurnitureType TraditionalBedsideLampField Value
TraditionalCeilingLight
public static readonly FurnitureType TraditionalCeilingLightField Value
TraditionalCounter
public static readonly FurnitureType TraditionalCounterField Value
TraditionalFireplace
public static readonly FurnitureType TraditionalFireplaceField Value
TrashBag
public static readonly FurnitureType TrashBagField Value
Treadmill
public static readonly FurnitureType TreadmillField Value
TreeStumps
public static readonly FurnitureType[] TreeStumpsField Value
Types
A list of all available furniture types. Register furniture types using Register(TypeSettings).
public static readonly ReadOnlyDictionary<string, FurnitureType> TypesField Value
UnfinishedWoodwork
public static readonly FurnitureType UnfinishedWoodworkField Value
UnpreparedFood
public static readonly FurnitureType UnpreparedFoodField Value
Vases
public static readonly FurnitureType[] VasesField Value
VerticalBookStack
public static readonly FurnitureType VerticalBookStackField Value
VerticalDumbbellRack
public static readonly FurnitureType VerticalDumbbellRackField Value
VerticalPlanter
public static readonly FurnitureType VerticalPlanterField Value
WashingUpStuff
public static readonly FurnitureType WashingUpStuffField Value
WheelieBin
public static readonly FurnitureType WheelieBinField Value
WideBoxBookshelf
public static readonly FurnitureType WideBoxBookshelfField Value
WideConsoleTable
public static readonly FurnitureType WideConsoleTableField Value
WindowPlants
public static readonly FurnitureType[] WindowPlantsField Value
WinterTree
public static readonly FurnitureType WinterTreeField Value
Wisteria
public static readonly FurnitureType[] WisteriaField Value
WoodenPowerPole
public static readonly FurnitureType WoodenPowerPoleField Value
WoodenPowerPoleLine
public static readonly FurnitureType WoodenPowerPoleLineField Value
WoodenStool
public static readonly FurnitureType WoodenStoolField Value
WoodenToyBox
public static readonly FurnitureType WoodenToyBoxField Value
WoodworkingChair
public static readonly FurnitureType WoodworkingChairField Value
WoodworkingChairArmrests
public static readonly FurnitureType WoodworkingChairArmrestsField Value
WoodworkingCloset
public static readonly FurnitureType WoodworkingClosetField Value
WoodworkingTable
public static readonly FurnitureType WoodworkingTableField Value
WorkoutPosters
public static readonly FurnitureType[] WorkoutPostersField Value
Properties
Rotations
The valid rotations that this furniture has, which are based on the available Textures.
public ICollection<Direction2> Rotations { get; }Property Value
- ICollection<Direction2>
SourceString
A (localized) string that is displayed when hovering over an EmotionModifier that has this source
public string SourceString { get; }Property Value
Methods
Construct<T>(int[], Map, Vector2, float, Guid?)
Constructs a new Furniture object from this furniture type
public T Construct<T>(int[] colors, Map map, Vector2 pos, float floor, Guid? id = null) where T : FurnitureParameters
colorsint[]The indices of the colors that the furniture should have
mapMapThe map that the furniture should be added to
posVector2The position that the furniture should have
floorfloatThe floor that the furniture should be on.
idGuid?The id that the furniture should have, or a random one by defualt
Returns
- T
A new furniture instance of this type
Type Parameters
T
DrawColumns(Map, Vector2, float, object, Vector2, Direction2, TextureRegion, Color, float, List<Item>, bool, ParentInfo, float, SpriteEffects)
This method is a semi-overload of DrawColumns(Map, Vector2, float, object, Vector2, TextureRegion, Color, float, Point, List<Item>, bool, ParentInfo, float, SpriteEffects, bool) that additionally calculates some values required for rendering furniture with certain ObjectCategory values correctly
public void DrawColumns(Map map, Vector2 position, float floor, object batch, Vector2 drawPos, Direction2 rotation, TextureRegion texture, Color color, float scale, List<StaticSpriteBatch.Item> items, bool pivot = true, ParentInfo parent = default, float depthOffset = 0, SpriteEffects effects = SpriteEffects.None)Parameters
mapMapThe map that the object is on
positionVector2The position that the object is on, in world space
floorfloatThe floor to draw at.
batchobjectThe sprite batch to draw with, which is either a Microsoft.Xna.Framework.Graphics.SpriteBatch or MLEM.Graphics.StaticSpriteBatch.
drawPosVector2The position to draw at, in draw space
rotationDirection2The rotation that this object has, used for some calculations
textureTextureRegionThe texture region to draw
colorColorThe color to draw with
scalefloatThe scale to draw at
itemsList<StaticSpriteBatch.Item>A list of sprite batch items that items should be added to if the
batchis a MLEM.Graphics.StaticSpriteBatch.pivotboolThe texture's pivot point, in texture-space pixels
parentParentInfoThe object's parent object
depthOffsetfloatA value that is added to the calculated object's depth
effectsSpriteEffectsThe sprite effects to use when rendering
DrawDirtyOverlay(Map, Vector2, float, object, Vector2, Direction2, float, List<Item>, Color?, bool, ParentInfo, float)
Draws the DirtyTextures of this object into the world. Note that, if this object cannot get dirty, this method will throw a NullReferenceException. By default, the dirty overlay is automatically drawn by a Furniture object that is Dirty.
public void DrawDirtyOverlay(Map map, Vector2 position, float floor, object batch, Vector2 drawPos, Direction2 rotation, float scale, List<StaticSpriteBatch.Item> items, Color? overrideColor = null, bool pivot = true, ParentInfo parent = default, float depthOffset = 0)Parameters
mapMapThe map that the object is on
positionVector2The position that the object is on, in world space
floorfloatThe floor to draw at.
batchobjectThe sprite batch to draw with, which is either a Microsoft.Xna.Framework.Graphics.SpriteBatch or MLEM.Graphics.StaticSpriteBatch.
drawPosVector2The position to draw at, in draw space
rotationDirection2The rotation that this object has, used for some calculations
scalefloatThe scale to draw at
itemsList<StaticSpriteBatch.Item>A list of sprite batch items that items should be added to if the
batchis a MLEM.Graphics.StaticSpriteBatch.overrideColorColor?An optional color to override the default colors of the furniture
pivotboolThe texture's pivot point, in texture-space pixels
parentParentInfoThe object's parent object
depthOffsetfloatA value that is added to the calculated object's depth
DrawLayers(Map, Vector2, float, object, Vector2, Direction2, TextureRegion[], int[], float, List<Item>, bool, ParentInfo, Color?, float)
Draws the furniture type with the given data. Internally, this uses DrawColumns(Map, Vector2, float, object, Vector2, Direction2, TextureRegion, Color, float, List<Item>, bool, ParentInfo, float, SpriteEffects) to draw each layer with a slight depth offset.
public void DrawLayers(Map map, Vector2 position, float floor, object batch, Vector2 drawPos, Direction2 rotation, TextureRegion[] layers, int[] colors, float scale, List<StaticSpriteBatch.Item> items, bool pivot = true, ParentInfo parent = default, Color? overrideColor = null, float depthOffset = 0)Parameters
mapMapThe map to draw the furniture type on
positionVector2The position on the map that the furniture is at
floorfloatThe floor to draw at.
batchobjectThe sprite batch to draw with, which is either a Microsoft.Xna.Framework.Graphics.SpriteBatch or MLEM.Graphics.StaticSpriteBatch.
drawPosVector2The position that this furniture should be drawn at on the screen
rotationDirection2The rotation of the furniture
layersTextureRegion[]The textures to draw this furniture with
colorsint[]The indices in the Colors that the furniture should be drawn with
scalefloatThe scale that the furniture should be drawn with
itemsList<StaticSpriteBatch.Item>A list of sprite batch items that items should be added to if the
batchis a MLEM.Graphics.StaticSpriteBatch.pivotboolWhether or not the furniture should be shifted by its pivot point
parentParentInfoThe parent that the furniture is attached to. Can be null.
overrideColorColor?The color that should be used to draw this furniture instead of
colorsdepthOffsetfloatA value that is added to the depth calculation for drawing this furniture type
GetBestRotation(Direction2)
Returns a MLEM.Misc.Direction2 that is closest to goal, but that this object is allowed to have.
The return value is guaranteed to be contained in Rotations and have the same verticality as goal, or be the same value.
public Direction2 GetBestRotation(Direction2 goal)Parameters
goalDirection2The goal rotation
Returns
- Direction2
The closest possible rotation to the goal rotation
GetConstructedType()
Returns the Type that is constructed for this furniture type's Furniture instance. By default, ConstructedType is returned if it is non-null, and otherwise, BreakableFurniture, LightFurniture and Furniture are considered.
public Type GetConstructedType()Returns
- Type
The type to construct for this furniture type's instance.
GetCoveredTiles(Vector2, Point)
Returns a rectangle that contains all of the tiles which intersect with the furniture when placed at the given position, with the given size.
public static Rectangle GetCoveredTiles(Vector2 pos, Point size)Parameters
posVector2The position to place the furniture at
sizePointThe size of the furniture
Returns
- Rectangle
A rectangle with all of the tiles that are covered
GetDisplayName(Furniture)
Returns this furniture item's display name, optionally based on the given Furniture instance.
public string GetDisplayName(Furniture instance)Parameters
instanceFurnitureThe furniture instance to get the name for, or null to get the default name.
Returns
- string
This furniture item's display name.
GetReferenceTexture(Direction2?)
Returns the reference texture of this furniture type for the given rotation. The reference texture is the first layer of the texture for the given rotation.
public TextureRegion GetReferenceTexture(Direction2? rotation = null)Parameters
rotationDirection2?The rotation to get the reference texture for. Defaults to DefaultRotation.
Returns
- TextureRegion
The reference texture for the given rotation
GetRotatedOffset(Vector2, Direction2, Direction2)
Returns the rotated offset of the given position, based on this furniture type's Size. This method is used to offset the position of furniture objects based on their (visual) rotation.
public Vector2 GetRotatedOffset(Vector2 offset, Direction2 objectRotation, Direction2 rotation)Parameters
offsetVector2The offset position to rotate
objectRotationDirection2The original rotation of the object
rotationDirection2The rotation to rotate by
Returns
- Vector2
The rotated offset of the
offset
GetSize(Direction2)
Returns the Size of this furniture type, modified based on the given rotation.
public Point GetSize(Direction2 rotation)Parameters
rotationDirection2The rotation to return the size for
Returns
- Point
The modified size
GetTexture(string, bool)
Returns a MLEM.Textures.TextureRegion with the given name, based on all of the textures in the base game and all GetCustomFurnitureTextures(ModInfo) textures.
public static TextureRegion GetTexture(string name, bool throwIfNotFound = true)Parameters
namestringThe name of the texture to get
throwIfNotFoundboolWhether an exception should be thrown if the texture is not found
Returns
- TextureRegion
A texture region with the given name, or null if there is none
GetTextures(string, int, Func<Direction2, bool>)
Create a dictionary of textures for all MLEM.Misc.Direction2Helper.Adjacent directions that have a texture registered for them. Textures are gathered using GetCustomFurnitureTextures(ModInfo), and textures need to be suffixed with the direction's string to be recognized. This method is used for furniture of all kinds.
public static Dictionary<Direction2, TextureRegion[]> GetTextures(string name, int amount = 1, Func<Direction2, bool> shouldThrow = null)Parameters
namestringThe name of the texture to load
amountintThe amount of layers the texture has
shouldThrowFunc<Direction2, bool>Whether an exception should be thrown if the texture is not found
Returns
- Dictionary<Direction2, TextureRegion[]>
A dictionary of directions to texture layers
HasCategory(ObjectCategory)
Returns whether this type's Settings have any of the supplied ObjectCategory values
public bool HasCategory(ObjectCategory category)Parameters
categoryObjectCategoryThe categories to query
Returns
- bool
Whether any of the passed categories are present
Register(TypeSettings)
Registers a custom furniture type
public static FurnitureType Register(FurnitureType.TypeSettings settings)Parameters
settingsFurnitureType.TypeSettingsThe settings to apply to the custom furniture type
Returns
- FurnitureType
The registered furniture type
ToString()
Returns a string that represents the current object.
public override string ToString()Returns
- string
A string that represents the current object.