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

Class PlayCustomMusic

java.lang.Object

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

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

All Implemented Interfaces:

CommandPlugin

public class PlayCustomMusic
extends BaseCommandPlugin

Plays custom music with the provided ID. MUST call ResumeNormalMusic at some point after this to re-enable normal music playback, otherwise normal music will not play. Can call PauseMusic to stop all music playback.

Constructor Summary

Constructors

Constructor	Description
PlayCustomMusic()

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

Constructor Details

PlayCustomMusic

public PlayCustomMusic()

Method Details

execute

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