Class BreakableFurniture
Breakable furniture is Furniture that can be Broken and then repaired. An object of this class is automatically returned in Construct<T>(int[], Map, Vector2, float, Guid?) if no ConstructedType is set.
public class BreakableFurniture : Furniture, IGenericDataHolder, IUpdatingObject- Inheritance
-
JsonTypeSafeGenericDataHolderBreakableFurniture
- Implements
-
IGenericDataHolder
- Derived
- Inherited Members
-
JsonTypeSafeGenericDataHolder.GetDataKeys()
- Extension Methods
Constructors
BreakableFurniture(Guid, FurnitureType, int[], Map, Vector2, float)
Creates a new furniture instance. By default, this is done using Construct<T>(int[], Map, Vector2, float, Guid?).
public BreakableFurniture(Guid id, FurnitureType type, int[] colors, Map map, Vector2 pos, float floor)Parameters
idGuidThe id to apply to the created furniture instance
typeFurnitureTypeThe type to create an instance of
colorsint[]The colors to apply to the furniture
mapMapThe map to create the furniture on
posVector2The position that the furniture should have
floorfloatThe floor that this object is on.
Properties
Broken
A field that stores whether this furniture is currently broken
[DataMember]
public virtual bool Broken { get; set; }Property Value
RepairProgress
The progress that has been made on repairing this object, between 0 and 1.
[DataMember]
public virtual float RepairProgress { get; set; }Property Value
Methods
ActionUpdate(Action, GameTime, TimeSpan, float, bool)
This method is called when an Action that this object is involved in updates, which is every Microsoft.Xna.Framework.Game.Update(Microsoft.Xna.Framework.GameTime) frame. Note that this includes actions that are underlying (see Parent) and actions that aren't fully in progress yet (FullyInProgress). This object counts as involved in the action if its ActionInfo's GetInvolvedObjects<T>(ObjectCategory, bool, bool) includes this object. In general, the base method should be called for Furniture objects, since it sets deals with Dirty objects.
public override void ActionUpdate(Action action, GameTime time, TimeSpan passedInGame, float speedMultiplier, bool isAuxiliary)Parameters
actionActionThe action
timeGameTimeThe current game time
passedInGameTimeSpanThe amount of time that has passed, in game time
speedMultiplierfloatThe game speed multiplier, which represents how fast things should happen, which is usually determined by Speed
isAuxiliaryboolWhether this object counts as an auxiliary object. If this value is false, the object is th eGetActionObject<T>(bool)
CanExecuteAction(ActionType, ActionInfo, bool, bool)
Returns whether the given action can be executed at this map object.
By default, this method returns Valid for all actions, but Furniture additionally returns custom results based on whether the furniture is Broken or based on AreUtilitiesDisabled.
public override CanExecuteResult CanExecuteAction(ActionType action, ActionInfo info, bool automatic, bool isAuxiliary)Parameters
actionActionTypeThe action that is querying whether it can be executed.
infoActionInfoThe action info.
automaticboolWhether the action was started automatically.
isAuxiliaryboolWhether this object is auxiliary (or the main action object).
Returns
- CanExecuteResult
Whether this object allows the action to be executed at it.
GetDecorativeRating(Room)
Returns the decorative rating of this object in the given room. By default, the underlying Type's DecorativeRating, influeced by whether this object is Dirty, is returned.
public override float GetDecorativeRating(Room room)Parameters
roomRoomThe room that the object is in, or null if it is not in a room at all
Returns
- float
The decorative rating of this object
GetDescription(List<string>, bool)
This method allows adding a set of strings to the description list that get displayed when the object is hovered over in the build mode or household storage UIs.
By default, this method adds various strings related to the ElectricityRating, Quality, Creator, and also invokes the OnGetDescription event.
public override void GetDescription(List<string> description, bool forHoverInfo)Parameters
descriptionList<string>The description to add to.
forHoverInfoboolWhether this method is being called by GetHoverInfo(Tooltip) (or by build mode).
GetPrice()
Returns the price of this furniture item, including its CustomPrice or its Type's base price, whether it was devalued through use, whether it is dirty, its Quality, and more.
public override float GetPrice()Returns
- float
This furniture item's price.
OnRemoved()
This method is called when this object is removed from a Map. By default, it does nothing.
public override void OnRemoved()Update(GameTime, TimeSpan, float)
The update method, which is called every update frame by the underlying Map, as well as additional places like the FurnitureStorage. Because of this, some actions might only want to be invoked if an object IsInWorld. To call this method while invoking all required events, use DoUpdate(GameTime, TimeSpan, float).
public virtual void Update(GameTime time, TimeSpan passedInGame, float speedMultiplier)Parameters
timeGameTimeThe game's time
passedInGameTimeSpanThe amount of time that has passed since the last call
speedMultiplierfloatThe game speed multiplier, which represents how fast things should happen, which is usually determined by Speed
WearDown(TimeSpan)
Causes this furniture to wear down, increasing the likelihood of it becoming Broken and randomly breaking it
public virtual void WearDown(TimeSpan passedInGame)Parameters
passedInGameTimeSpanThe amount of in-game time that this furniture should be worn down by
Events
OnBreak
An event that is invoked when this breakable furniture breaks. This event can be subscribed to using OnEventsAttachable.
public event Action OnBreakEvent Type
OnWearDown
An event that is invoked when this breakable furniture is worn down in WearDown(TimeSpan). This event can be subscribed to using OnEventsAttachable.
public event BreakableFurniture.WearDownDelegate OnWearDown