Struct Planet 

pub struct Planet {
    pub ai: Box<dyn PlanetAI>,
    /* private fields */
}

Main, top-level planet definition. This type is built on top of PlanetState, PlanetType and PlanetAI, through composition.

It needs to be constructed by each group as it represents the actual planet and contains the base logic that runs the AI. Also, this is what should be returned to the orchestrator.

See module-level docs for more general info.

Fields

ai: Box<dyn PlanetAI>

Implementations

impl Planet

pub fn new( id: ID, type_: PlanetType, ai: Box<dyn PlanetAI>, gen_rules: Vec<BasicResourceType>, comb_rules: Vec<ComplexResourceType>, orchestrator_channels: (Receiver<OrchestratorToPlanet>, Sender<PlanetToOrchestrator>), explorers_receiver: Receiver<ExplorerToPlanet>, ) -> Result<Planet, String>

Constructor for the Planet type.

Errors

Returns an error if the construction parameters are invalid (they violate the planet_type constraints).

Arguments

• id - The identifier to assign to the planet.
• planet_type - Type of the planet. Constraints the rules of the planet.
• ai - A group-defined struct implementing the PlanetAI trait.
• gen_rules - A vec of BasicResourceType containing the basic resources the planet will be able to generate.
• comb_rules - A vec of ComplexResourceType containing the complex resources the planet will be able to make.
• orchestrator_channels - A pair containing the receiver and sender half of the channels OrchestratorToPlanet and PlanetToOrchestrator.
• explorers_receiver - The receiver half of the ExplorerToPlanet channel where all explorers send messages to this planet (when they’re visiting it).

pub fn run(&mut self) -> Result<(), String>

Starts the planet in a stopped state, waiting for a OrchestratorToPlanet::StartPlanetAI message, then invokes PlanetAI::on_start and runs the main message polling loop. See PlanetAI docs to know more about when message handlers are invoked and how the planet reacts to the different messages.

This method is blocking and should be called by the orchestrator in a separate thread. It returns with an empty Ok when the planet has been killed (destroyed).

Errors

If the orchestrator disconnects from the channel, this will return an Err.

pub fn id(&self) -> ID

Returns the planet id.

pub fn planet_type(&self) -> PlanetType

Returns the planet type.

pub fn state(&self) -> &PlanetState

Returns an immutable borrow of planet’s internal state.

pub fn generator(&self) -> &Generator

Returns an immutable borrow of the planet generator.

pub fn combinator(&self) -> &Combinator

Returns an immutable borrow of the planet combinator.