001package com.fs.starfarer.api.campaign.events;
002
003
004/**
005 * 
006 * Probability = 1 means event is guaranteed to occur next time it's checked for.
007 * 
008 * If an event occurs, the probability is reset to 0.
009 * If an event fails to occur, the probability is multiplied by 0.5
010 * 
011 * @author Alex Mosolov
012 *
013 * Copyright 2014 Fractal Softworks, LLC
014 */
015
016public interface EventProbabilityAPI {
017        
018        
019        float getProbability();
020        void setProbability(float probability);
021        String getEventType();
022        CampaignEventTarget getEventTarget();
023        void increaseProbability(float incr);
024        void decreaseProbability(float decr);
025        CampaignEventPlugin getPlugin();
026        
027        /**
028         * probabilityMult from events.json.
029         * @return
030         */
031        float getMult();
032        void setProbabilityAfterMult(float p);
033        boolean isPrimed();
034        void setPrimed(boolean primed);
035        
036}