Class TrinketTinkerCompanion

Namespace

TrinketTinker.Companions

Assembly

TrinketTinker.dll

Main companion class for trinket tinker.

public class TrinketTinkerCompanion : Companion, INetObject<NetFields>

Inheritance

object

Companion

TrinketTinkerCompanion

Implements

INetObject<NetFields>

Inherited Members

Companion.direction

Companion._position

Companion._owner

Companion.whichVariant

Companion.lerp

Companion.startPosition

Companion.endPosition

Companion.height

Companion.gravity

Companion.hopEvent

Companion.NetFields

Companion.Owner

Companion.Position

Companion.OwnerPosition

Companion.IsLocal

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TrinketTinkerCompanion()

Argumentless constructor for netcode deserialization.

public TrinketTinkerCompanion()

TrinketTinkerCompanion(string, int)

Construct new companion using companion ID.

public TrinketTinkerCompanion(string companionId, int variant)

Parameters

companionId string

variant int

Fields

_id

NetField for ID

protected readonly NetString _id

Field Value

NetString

Properties

Anchor

Position the companion should follow.

public Vector2 Anchor { get; set; }

Property Value

Vector2

BoundingBox

Bounding box of companion

public Rectangle BoundingBox { get; }

Property Value

Rectangle

CompanionMoving

Whether companion is moving

public bool CompanionMoving { get; }

Property Value

bool

CurrAnchorTarget

Getter and setter for override key

public AnchorTarget CurrAnchorTarget { get; set; }

Property Value

AnchorTarget

ID

Companion ID. Companion is (re)loaded when this is changed.

public string ID { get; }

Property Value

string

Motion

Motion class that controls how the companion moves.

public IMotion? Motion { get; }

Property Value

IMotion

Offset

Current motion offset

public Vector2 Offset { get; }

Property Value

Vector2

OneshotKey

Getter and setter for oneshot key

public string? OneshotKey { get; set; }

Property Value

string

OverrideKey

Getter and setter for override key

public string? OverrideKey { get; set; }

Property Value

string

OwnerMoving

Whether owner is moving and not using a tool

public bool OwnerMoving { get; }

Property Value

bool

Speaker

public ChatterSpeaker? Speaker { get; }

Property Value

ChatterSpeaker

Methods

CleanupCompanion()

Cleanup Motion class.

public override void CleanupCompanion()

Draw(SpriteBatch)

Draw using Motion.

public override void Draw(SpriteBatch b)

Parameters

b SpriteBatch

SpriteBatch

Hop(float)

Vanilla hop event handler, not using.

public override void Hop(float amount)

Parameters

amount float

InitNetFields()

Setup net fields.

public override void InitNetFields()

InitializeCompanion(Farmer)

Initialize Motion class.

public override void InitializeCompanion(Farmer farmer)

Parameters

farmer Farmer

OnOwnerWarp()

Reset position and display status on warp

public override void OnOwnerWarp()

SetActiveAnchors(IEnumerable<string>)

Set active anchors list, based on ability types

public void SetActiveAnchors(IEnumerable<string> abilityTypes)

Parameters

abilityTypes IEnumerable<string>

SetSpeechBubble(string?)

Set speech bubble key

public void SetSpeechBubble(string? speechBubbleKey)

Parameters

speechBubbleKey string

Update(GameTime, GameLocation)

Do updates in Motion. The client of the player with the trinket is responsible for calculating position direction rotation. All clients must update animation frame.

public override void Update(GameTime time, GameLocation location)

Parameters

time GameTime

Game time

location GameLocation

Current map location