Contracts

class ContractManager

Contracts manager. Obtained by calling contract_manager.

types

A list of all contract types.

Attribute:

Read-only, cannot be set

Return type:

set(str)

all_contracts

A list of all contracts.

Attribute:

Read-only, cannot be set

Return type:

list(Contract)

active_contracts

A list of all active contracts.

Attribute:

Read-only, cannot be set

Return type:

list(Contract)

offered_contracts

A list of all offered, but unaccepted, contracts.

Attribute:

Read-only, cannot be set

Return type:

list(Contract)

completed_contracts

A list of all completed contracts.

Attribute:

Read-only, cannot be set

Return type:

list(Contract)

failed_contracts

A list of all failed contracts.

Attribute:

Read-only, cannot be set

Return type:

list(Contract)

class Contract

A contract. Can be accessed using contract_manager.

type

Type of the contract.

Attribute:

Read-only, cannot be set

Return type:

str

title

Title of the contract.

Attribute:

Read-only, cannot be set

Return type:

str

description

Description of the contract.

Attribute:

Read-only, cannot be set

Return type:

str

notes

Notes for the contract.

Attribute:

Read-only, cannot be set

Return type:

str

synopsis

Synopsis for the contract.

Attribute:

Read-only, cannot be set

Return type:

str

keywords

Keywords for the contract.

Attribute:

Read-only, cannot be set

Return type:

list(str)

state

State of the contract.

Attribute:

Read-only, cannot be set

Return type:

ContractState

seen

Whether the contract has been seen.

Attribute:

Read-only, cannot be set

Return type:

bool

read

Whether the contract has been read.

Attribute:

Read-only, cannot be set

Return type:

bool

active

Whether the contract is active.

Attribute:

Read-only, cannot be set

Return type:

bool

failed

Whether the contract has been failed.

Attribute:

Read-only, cannot be set

Return type:

bool

can_be_canceled

Whether the contract can be canceled.

Attribute:

Read-only, cannot be set

Return type:

bool

can_be_declined

Whether the contract can be declined.

Attribute:

Read-only, cannot be set

Return type:

bool

can_be_failed

Whether the contract can be failed.

Attribute:

Read-only, cannot be set

Return type:

bool

accept()

Accept an offered contract.

cancel()

Cancel an active contract.

decline()

Decline an offered contract.

funds_advance

Funds received when accepting the contract.

Attribute:

Read-only, cannot be set

Return type:

float

funds_completion

Funds received on completion of the contract.

Attribute:

Read-only, cannot be set

Return type:

float

funds_failure

Funds lost if the contract is failed.

Attribute:

Read-only, cannot be set

Return type:

float

reputation_completion

Reputation gained on completion of the contract.

Attribute:

Read-only, cannot be set

Return type:

float

reputation_failure

Reputation lost if the contract is failed.

Attribute:

Read-only, cannot be set

Return type:

float

science_completion

Science gained on completion of the contract.

Attribute:

Read-only, cannot be set

Return type:

float

parameters

Parameters for the contract.

Attribute:

Read-only, cannot be set

Return type:

list(ContractParameter)

class ContractState

The state of a contract. See Contract.state.

active

The contract is active.

canceled

The contract has been canceled.

completed

The contract has been completed.

deadline_expired

The deadline for the contract has expired.

declined

The contract has been declined.

failed

The contract has been failed.

generated

The contract has been generated.

offered

The contract has been offered to the player.

offer_expired

The contract was offered to the player, but the offer expired.

withdrawn

The contract has been withdrawn.

class ContractParameter

A contract parameter. See Contract.parameters.

title

Title of the parameter.

Attribute:

Read-only, cannot be set

Return type:

str

notes

Notes for the parameter.

Attribute:

Read-only, cannot be set

Return type:

str

children

Child contract parameters.

Attribute:

Read-only, cannot be set

Return type:

list(ContractParameter)

completed

Whether the parameter has been completed.

Attribute:

Read-only, cannot be set

Return type:

bool

failed

Whether the parameter has been failed.

Attribute:

Read-only, cannot be set

Return type:

bool

optional

Whether the contract parameter is optional.

Attribute:

Read-only, cannot be set

Return type:

bool

funds_completion

Funds received on completion of the contract parameter.

Attribute:

Read-only, cannot be set

Return type:

float

funds_failure

Funds lost if the contract parameter is failed.

Attribute:

Read-only, cannot be set

Return type:

float

reputation_completion

Reputation gained on completion of the contract parameter.

Attribute:

Read-only, cannot be set

Return type:

float

reputation_failure

Reputation lost if the contract parameter is failed.

Attribute:

Read-only, cannot be set

Return type:

float

science_completion

Science gained on completion of the contract parameter.

Attribute:

Read-only, cannot be set

Return type:

float