Package com.fs.starfarer.api.campaign.rules

Interface MemoryAPI

public interface MemoryAPI

Method Summary

Modifier and Type	Method	Description
void	addRequired(String key, String requiredKey)	Can be called multiple times for a key.
void	advance(float amount)
boolean	between(String key, float min, float max)	Includes both endpoints.
void	clear()
boolean	contains(String key)
void	expire(String key, float days)
Object	get(String key)
boolean	getBoolean(String key)
SectorEntityToken	getEntity(String key)
float	getExpire(String key)
CampaignFleetAPI	getFleet(String key)
float	getFloat(String key)
int	getInt(String key)
Collection<String>	getKeys()
long	getLong(String key)
Set<String>	getRequired(String key)
String	getString(String key)
org.lwjgl.util.vector.Vector2f	getVector2f(String key)
boolean	is(String key, boolean value)
boolean	is(String key, float value)
boolean	is(String key, Object value)
boolean	isEmpty()
void	removeAllRequired(String key)
void	removeRequired(String key, String requiredKey)
void	set(String key, Object value)	Never expires.
void	set(String key, Object value, float expire)	With expiration.
void	unset(String key)

Method Details

unset

void unset(String key)

expire

void expire(String key,
 float days)

contains

boolean contains(String key)

is

boolean is(String key,
 Object value)

is

boolean is(String key,
 float value)

is

boolean is(String key,
 boolean value)

set

void set(String key,
 Object value)

Never expires.

Parameters:

key -

value -

set

void set(String key,
 Object value,
 float expire)

With expiration.

Parameters:

key -

value -

expire -

get

Object get(String key)

getString

String getString(String key)

getFloat

float getFloat(String key)

getBoolean

boolean getBoolean(String key)

getLong

long getLong(String key)

getVector2f

org.lwjgl.util.vector.Vector2f getVector2f(String key)

getEntity

SectorEntityToken getEntity(String key)

getFleet

CampaignFleetAPI getFleet(String key)

between

boolean between(String key,
 float min,
 float max)

Includes both endpoints.

Parameters:

key -

from -

to -

Returns:

getKeys

Collection<String> getKeys()

getExpire

float getExpire(String key)

advance

void advance(float amount)

addRequired

void addRequired(String key,
 String requiredKey)

Can be called multiple times for a key. If this is called, then key will be removed from memory when NONE of the requiredKeys are left in memory.

Parameters:

key -

requiredKey -

removeRequired

void removeRequired(String key,
 String requiredKey)

isEmpty

boolean isEmpty()

getRequired

Set<String> getRequired(String key)

removeAllRequired

void removeAllRequired(String key)

clear

void clear()

getInt

int getInt(String key)