starvationevasion.common.policies

Class LoanPolicy

java.lang.Object

starvationevasion.common.PolicyCard

starvationevasion.common.policies.LoanPolicy

All Implemented Interfaces:

java.io.Serializable, JSON, Sendable

public class LoanPolicy
extends PolicyCard

Title: "Loan"

Game Text: "Target player region lends you X million dollars at 10% interest. Annual loan payments are scheduled from year 2 through year 11 (spanning 4 turns)."

Draft Affects: When drafting this policy, player selects target player from whom to attempt to borrow and the amount X.

Votes Required: 2
Eligible Regions: Target player only

Model Effects: Before resolving any other model effects, X million dollars are transferred from target player to the card owner. Then, on each subsequent year for the next 10 years, X/10 + 10% of remaining balance million dollars are transferred from card owner back to the target player. Thus, the duration of the loan is 11 years (3 full turns plus the first two years of a 4th turn.)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class starvationevasion.common.PolicyCard

PolicyCard.EnumVariable, PolicyCard.EnumVariableUnit

Nested classes/interfaces inherited from interface starvationevasion.server.io.JSON

JSON.Parser

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TEXT
static java.lang.String	TITLE
static int	VOTES_REQUIRED The number of votes required for this policy.

Fields inherited from class starvationevasion.common.PolicyCard

MAX_MILLION_DOLLARS, MAX_PERCENT, MIN_MILLION_DOLLARS, MIN_PERCENT

Constructor Summary

Constructors

Constructor and Description
LoanPolicy()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getGameText()
PolicyCard.EnumVariableUnit	getRequiredVariables(PolicyCard.EnumVariable variable) The default is null (the given variable is not required).
java.lang.String	getTitle()
EnumRegion[]	getValidTargetRegions() The default is null (no target region required).
boolean	isEligibleToVote(EnumRegion playerRegion) In the abstract Policy class, this method returns the default behavior of a policy card (isEligibleToVote() = false if the policy is automatic and true for any region if not automatic).
int	votesRequired() In the abstract Policy class, this method returns the default behavior of a policy card (votesRequired() = 0).

Methods inherited from class starvationevasion.common.PolicyCard

addEnactingRegion, clearVotes, create, didVoteYes, equals, fromJSON, getCardType, getEnactingRegionCount, getOptionsOfVariable, getOwner, getPolicyName, getTargetFood, getTargetRegion, getType, getValidTargetFoods, getValidTargetRegion, getX, getY, getZ, hashCode, setTargetFood, setTargetRegion, setType, setX, setY, setZ, toJSON, toString, validate, voteWaitForAll

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

TITLE

public static final java.lang.String TITLE

See Also:

Constant Field Values

TEXT

public static final java.lang.String TEXT

See Also:

Constant Field Values

VOTES_REQUIRED

public static final int VOTES_REQUIRED

The number of votes required for this policy. A value of 0 means that the policy is automatic.

See Also:

Constant Field Values

Constructor Detail

LoanPolicy

public LoanPolicy()

Method Detail

getTitle

public java.lang.String getTitle()

Specified by:

getTitle in class PolicyCard

Returns:

The title text for this policy.

getGameText

public java.lang.String getGameText()

Specified by:

getGameText in class PolicyCard

Returns:

The game text for this policy.

votesRequired

public int votesRequired()

In the abstract Policy class, this method returns the default behavior of a policy card (votesRequired() = 0). If a class extending Policy is not automatic, then it must override this method.

Overrides:

votesRequired in class PolicyCard

Returns:

0 if the policy is automatic. Otherwise, returns the number of votes required for the policy to be enacted.
Note: This will always return a number that is no smaller than the number of regions returned by getRegionsEligibleToVote().

isEligibleToVote

public boolean isEligibleToVote(EnumRegion playerRegion)

In the abstract Policy class, this method returns the default behavior of a policy card (isEligibleToVote() = false if the policy is automatic and true for any region if not automatic). If a class extending Policy requires different behavior, then it must override this method.

Overrides:

isEligibleToVote in class PolicyCard

Parameters:

playerRegion - being queried.

Returns:

true if and only if the given playerRegion is eligible to vote on this particular policy

getValidTargetRegions

public EnumRegion[] getValidTargetRegions()

The default is null (no target region required).

Overrides:

getValidTargetRegions in class PolicyCard

Returns:

An array of regions valid as the target region of this policyCard. Returns null if this card does not require a region.

getRequiredVariables

public PolicyCard.EnumVariableUnit getRequiredVariables(PolicyCard.EnumVariable variable)

The default is null (the given variable is not required).

Overrides:

getRequiredVariables in class PolicyCard

Parameters:

variable - to be queried.

Returns:

The units of the required variable or null if the given variable is not required.