API Reference¶

This section provides a detailed overview of the API of uncle-nelson.

Mix¶

uncle_nelson.mix.calculate_mix(drug, ingredients)¶

Calculates a mix based on a DrugType and a list of IngredientType.

Parameters:

drug (DrugType) – The type of drug to mix.
ingredients (List[IngredientType]) –
A list of ingredients to mix with the drug.
Note

The ingredients are mixed one by one, so the order matters.
```
mix = calculate_mix(..., [IngredientType.cuke, IngredientType.banana])
```
will not end in the same result as
```
mix = calculate_mix(..., [IngredientType.banana, IngredientType.cuke])
```

Returns:

The calculated mix.

Return type:

Mix

class uncle_nelson.Mix¶

A namedtuple which represents a calculated mix.

drug¶

The type of drug.

Type:: DrugType

ingredients¶

A list of added ingredients.

Type:: List[IngredientType]

effects¶

A list of effects the mixed drug has.

Type:: List[EffectType]

price¶

The (suggested) sell price of the mixed drug.

Type:: int

cost¶

The ingredients cost of the mixed drug.

Type:: int

Enumerations¶

All enumerations inherit from enum.Enum.

DrugType¶

class uncle_nelson.DrugType¶

Specifies the type of a drug.

og_kush¶: OG Kush weed.

sour_diesel¶: Sour Diesel weed.

green_crack¶: Green Crack weed.

granddaddy_purple¶: Granddaddy Purple weed.

methamphetamine¶: Methamphetamine.

meth¶: Alias of methamphetamine.

cocaine¶: Cocaine.

IngredientType¶

class uncle_nelson.IngredientType¶

Specifies the type of ingredient.

cuke¶: Cuke ingredient.

banana¶: Banana ingredient.

paracetamol¶: Paracetamol ingredient.

donut¶: Donut ingredient.

viagra¶: Viagra ingredient.

mouth_wash¶: Mouth Wash ingredient.

flu_medicine¶: Flu Medicine ingredient.

gasoline¶: Gasoline ingredient.

energy_drink¶: Energy Drink ingredient.

motor_oil¶: Motor Oil ingredient.

mega_bean¶: Mega Bean ingredient.

chili¶: Chili ingredient.

battery¶: Battery ingredient.

iodine¶: Iodine ingredient.

addy¶: Addy ingredient.

horse_semen¶: Horse Semen ingredient.

EffectType¶

class uncle_nelson.EffectType¶

Specifies the type of effect.

anti_gravity¶: Anti-Gravity effect.

athletic¶: Athletic effect.

balding¶: Balding effect.

bright_eyed¶: Bright-Eyed effect.

calming¶: Calming effect.

calorie_dense¶: Calorie-Dense effect.

cyclopean¶: Cyclopean effect.

disorienting¶: Disorienting effect.

electrifying¶: Electrifying effect.

energizing¶: Energizing effect.

euphoric¶: Euphoric effect.

explosive¶: Explosive effect.

focused¶: Focused effect.

foggy¶: Foggy effect.

gingeritis¶: Gingeritis effect.

glowing¶: Glowing effect.

jennerising¶: Jennerising effect.

laxative¶: Laxative effect.

lethal¶: Lethal effect.

long_faced¶: Long-Faced effect.

munchies¶: Munchies effect.

paranoia¶: Paranoia effect.

refreshing¶: Refreshing effect.

schizophrenic¶: Schizophrenic effect.

sedating¶: Sedating effect.

seizure_inducing¶: Seizure-Inducing effect.

shrinking¶: Shrinking effect.

slippery¶: Slippery effect.

smelly¶: Smelly effect.

sneaky¶: Sneaky effect.

spicy¶: Spicy effect.

thought_provoking¶: Thought-Provoking effect.

toxic¶: Toxic effect.

tropic_thunder¶: Tropic Thunder effect.

zombifying¶: Zombifying effect.