unitdets

Documentation

Index

• type TentOffer
• type TentSyncDetails
• type TentUpdateDetails
• type UnitDetails

Types

type TentOffer

type TentOffer struct {
	// InitiatingTeam is the team initiating the offer.
	InitiatingTeam int `json:"initiating_team" mapstructure:"initiating_team"`

	// TargetTeam is the team recieving the offer
	TargetTeam int `json:"target_team" mapstructure:"target_team"`

	// Offer is the offer of resources being made, which will be taken from the
	// initiating team and given to the target team if the offer is accepted.
	Offer map[string]int `json:"offer" mapstructure:"offer"`

	// Request is the request of resources, which will be taken from the target
	// team and given to the initiating team if the offer is accepted.
	Request map[string]int `json:"request" mapstructure:"request"`
}

TentOffer describes a single offer in a tent. The offer is visible on both the initiating and target teams tents. You can only see offers on your own tent.

type TentSyncDetails

type TentSyncDetails struct {
	// IncomingOffers are the offers from other teams which have been made
	// to the team owning this tent. The keys are uids of the offers.
	IncomingOffers map[string]TentOffer `json:"incoming_offers" mapstructure:"incoming_offers"`

	// OutgoingOffers are the offers from this team which have been made to
	// other teams. The keys are the uids of the offers.
	OutgoingOffers map[string]TentOffer `json:"outgoing_offers" mapstructure:"outgoing_offers"`
}

TentSyncDetails is the information provided under Additional for a tent unit during a sync event, typically a GameSync or SmartObjectAdded. It provides all the custom information about the tent. If the Tent is not owned by the player then the offers will always be empty maps.

type TentUpdateDetails

type TentUpdateDetails struct {
	// RemovedIncomingOffers is the slice of incoming offer uids which are no
	// longer in this tent, either because they were responded to or withdrawn
	RemovedIncomingOffers []string `json:"removed_incoming_offers" mapstructure:"removed_incoming_offers"`

	// RemovedOutgoings is the slice of outgoing offer uids which are no longer
	// in this tent, either because they were responded to or withdrawn
	RemovedOutgoingOffers []string `json:"removed_outgoing_offers" mapstructure:"removed_outgoing_offers"`

	// AddedIncomingOffers contains all the new incoming offers on this tent,
	// where the keys are uids
	AddedIncomingOffers map[string]TentOffer `json:"added_incoming_offers" mapstructure:"added_incoming_offers"`

	// AddedOutgoingOffers contains all the new outgoing offers on this tent,
	// where the keys are uids
	AddedOutgoingOffers map[string]TentOffer `json:"added_outgoing_offers" mapstructure:"added_outgoing_offers"`
}

TentUpdateDetails contains the information under Additional for a tent unit during an update event, typically SmartObjectUpdate.

type UnitDetails

type UnitDetails interface{}

UnitDetails is a simple marker to indicate that a result or parameter should be either a SyncDetails or a UpdateDetails from this package, i.e., a value for Additional in a unit