Package megamek.common.jacksonadapters

Class PrincessSettingsBuilder

java.lang.Object

megamek.common.jacksonadapters.PrincessSettingsBuilder

public class PrincessSettingsBuilder
extends Object

This class is a builder for settings for a Princess bot (BehaviorSettings) and also supports parsing such settings from a yaml MM scenario definition. The difference to BehaviorSettings itself is that this builder can work with incomplete settings, such as only a change to herdmentality or only a change to auto-flee. When building the final BehaviorSettings, either default values or the values of a given other BehaviorSettings are used where the builder has no value.

See Also:

• BehaviorSettings
• build()
• build(BehaviorSettings)

Constructor Summary

Constructors

Constructor	Description
PrincessSettingsBuilder()

Method Summary

Modifier and Type	Method	Description
PrincessSettingsBuilder	bravery(int bravery)
BehaviorSettings	build()	Returns new BehaviorSettings based on the Princess default settings.
BehaviorSettings	build(BehaviorSettings previousSettings)	Returns new BehaviorSettings based on the given settings.
PrincessSettingsBuilder	description(String description)
PrincessSettingsBuilder	fallShame(int fallShame)
PrincessSettingsBuilder	flee(boolean flee)
PrincessSettingsBuilder	herdMentality(int herdMentality)
PrincessSettingsBuilder	hyperAgression(int hyperAgression)
PrincessSettingsBuilder	selfPreservation(int selfPreservation)
PrincessSettingsBuilder	setFleeEdge(String edge)
PrincessSettingsBuilder	useWithdraw(boolean useWithdraw)
PrincessSettingsBuilder	withdrawEdge(String edge)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PrincessSettingsBuilder

public PrincessSettingsBuilder()

Method Details

selfPreservation

public PrincessSettingsBuilder selfPreservation(int selfPreservation)

fallShame

public PrincessSettingsBuilder fallShame(int fallShame)

hyperAgression

public PrincessSettingsBuilder hyperAgression(int hyperAgression)

herdMentality

public PrincessSettingsBuilder herdMentality(int herdMentality)

bravery

public PrincessSettingsBuilder bravery(int bravery)

flee

public PrincessSettingsBuilder flee(boolean flee)

useWithdraw

public PrincessSettingsBuilder useWithdraw(boolean useWithdraw)

setFleeEdge

public PrincessSettingsBuilder setFleeEdge(String edge)

withdrawEdge

public PrincessSettingsBuilder withdrawEdge(String edge)

description

public PrincessSettingsBuilder description(String description)

build

public BehaviorSettings build(@Nullable
 BehaviorSettings previousSettings)

Returns new BehaviorSettings based on the given settings. Settings that are present in this builder overwrite the previous settings, otherwise the previous settings are left unchanged.

Parameters:

previousSettings - Settings to base the new settings on

Returns:

New BehaviorSettings that incorporate the settings of this builder

build

public BehaviorSettings build()

Returns new BehaviorSettings based on the Princess default settings. Settings that are present in this builder overwrite the default settings, others are left at their default values.

Returns:

New BehaviorSettings that incorporate the settings of this builder