Package com.fs.starfarer.api.impl.campaign.rulecmd

Class SetCodexEntryId

java.lang.Object

com.fs.starfarer.api.impl.campaign.rulecmd.BaseCommandPlugin

com.fs.starfarer.api.impl.campaign.rulecmd.SetCodexEntryId

All Implemented Interfaces:

CommandPlugin

public class SetCodexEntryId
extends BaseCommandPlugin

SetCodexEntryId Sets the id of the entry to show when the Codex is opened, with an expiration of 0. If no entry id is specified, it is unset instead.

Field Summary

Fields

Modifier and Type	Field	Description
static String	GLOBAL_CODEX_ENTRY_TO_OPEN

Constructor Summary

Constructors

Constructor	Description
SetCodexEntryId()

Method Summary

Modifier and Type	Method	Description
boolean	execute(String ruleId, InteractionDialogAPI dialog, List<Misc.Token> params, Map<String,MemoryAPI> memoryMap)

Methods inherited from class com.fs.starfarer.api.impl.campaign.rulecmd.BaseCommandPlugin

doesCommandAddOptions, getEntityMemory, getOptionOrder

Methods inherited from class java.lang.Object

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

Field Details

GLOBAL_CODEX_ENTRY_TO_OPEN

public static String GLOBAL_CODEX_ENTRY_TO_OPEN

Constructor Details

SetCodexEntryId

public SetCodexEntryId()

Method Details

execute

public boolean execute(String ruleId,
 InteractionDialogAPI dialog,
 List<Misc.Token> params,
 Map<String,MemoryAPI> memoryMap)