Module:Liste d'objets de Fallout 76

Documentation du module

Ce module génère une liste de récompenses pour Fallout 76.

Pour cela, le module part d'un sous-module racine et va boucler sur éléments qui peuvent être soit des objets, soit des listes. Si l'élément est une liste, elle est appelée et on répète l'opération de manière récursive.

Le paramétrage des listes sont des sous-modules de celui-ci. Ils sont rangés dans la catégorie Module Liste d'objets de Fallout 76.

Usage

Fonctions exportables :

build(frame) – voir la documentation du modèle {{Liste d'objets de Fallout 76}} ;
_build(args) – même fonction mais utilisable directement dans un autre module Lua ;

Paramétrage d'une liste

Une liste d'objet est décrite par une table présente dans un sous-module de Liste d'objets de Fallout 76. Cette table doit contenir les propriétés suivantes.

Propriété	Type	Description	Obligatoire	Valeur par défaut
`title`	string	Titre de la liste	Oui
`auto`	bool	Indique si les probabilités d'obtenir les éléments de la liste doivent être calculées automatiquement	Non	`true`
`items`	table	Éléments de la liste	Oui

La table items elle contient les propriétés suivantes.

Propriété	Type	Description	Obligatoire	Valeur par défaut
`type`	string	Type d'élément, au choix `item` ou `sublist`	Oui
`value`	string	Nom d'un objet ou d'une liste	Oui
`quantity`	string number	Quantité d'un élément qu'il est possible d'obtenir mais qui n'influence pas les probabilités	Non
`min`	number	Minimum cet élément qu'il est possible d'obtenir	Non	`1`
`max`	number	Maximum de cet élément qu'il est possible d'obtenir	Non	`1`
`chance`	number	Nombre entre 0 et 1 représentant la probabilité d'obtenir cet élément	Oui si `auto == false`
`level`	number	Niveau du joueur pour obtenir cet élément	Non
`event`	string	Nom d'un événement, dans le cas où un élément ne serait disponible que lors de sa disponibilité	Non

	-- Cas où auto == true
	return {
		title = "Titre de la liste",
		items = {
			{ type = "item", value = "[[Réacteur légendaire]]", max = 3 },
			{ type = "item", value = "[[Note de la Trésorerie]]" },
			{ type = "sublist", value = "LLS_Loot_GoodyBag_Large" }
		}
	}

	-- Cas où auto == false
	return {
		title = "Titre de la liste",
		auto = false,
		items = {
			{ type = "item", value = "[[Réacteur légendaire]]", chance = 0.5 },
			{ type = "item", value = "[[Note de la Trésorerie]]", chance = 0.5 },
			{ type = "sublist", value = "LLS_Loot_GoodyBag_Large", chance = 1 }
		}
	}

Calcul des probabilités

Automatique

Dans le cas du calcul automatique, la probabilité d'obtenir chaque élément dépend :

du nombre d'éléments de la liste ;
du nombre max de cet élément ;
de la probabilité d'obtenir la liste.

Dans ce mode, les probabilités sont donc liées à la liste mère.

Exemple

	-- Nom = Liste mère
	return {
		title = "Ma liste mère",
		items = {
			{ type = "item", value = "item1", max = 3 },
			{ type = "item", value = "item2" },
			{ type = "sublist", value = "Liste fille", max = 2 }
		}
	}

	-- Nom = Liste fille
	return {
		title = "Ma liste fille",
		items = {
			{ type = "item", value = "item3" },
			{ type = "item", value = "item4" }
		}
	}

Si on appelle le modèle {{Liste d'objets de Fallout 76}}. Alors le calcul se fait ainsi :

Dans Liste mère, il est possible d'obtenir trois fois item1, une fois item2 et deux fois Liste fille. Le probabilités se répartissent ainsi :

P(item1) = 3 / 6 = 50.00 %
P(item2) = 1 / 6 = 16.67 %
P(Liste fille) = 2 / 6 = 33.33 %

Pour Liste fille, on peut obtenir item3 et item4, du coup :

P(item3) = P(item4) = P(Liste fille) * 1 / 2 = 16,67 %

Manuel

Si le mode automatique est désactivé, il faut renseigner les probabilités d'obtenir chaque élément. Dans ce mode, la propriété max n'est plus prise en compte et il n'y a plus de relation entre les probabilités de chaque élément.

Exemple

-- Nom = Liste mère
return {
	title = 'Liste de vente de marchands itinérants',
	auto = false,
	items = {
		{ type = 'sublist', value = 'Liste fille 1', chance = 1 },
		{ type = 'sublist', value = 'Liste fille 2', chance = 0.5 },
		{ type = 'sublist', value = 'Liste fille 3', chance = 1 }
	}
}

Dans cette exemple, on est sûr à 100 % d'obtenir un objet de la liste Liste fille 1 et un autre objet de la liste Liste fille 3.

Documentation transclues de Module:Liste d'objets de Fallout 76/doc.

local p = {}

function addItem(item)
	if type(item) == 'string' then
		return '*' .. item
	elseif type(item) == 'table' then
		local moduledata = require( 'Module:Liste d\'objets de Fallout 76/' .. item.value )
		
		local sublist = '<div class="avt-dropdown-box mw-collapsible">' ..
			'<div class="avt-dropdown-box-title">' .. moduledata.title .. '</div>' ..
			'<div class="avt-dropdown-box-content mw-collapsible-content">\n'
		
		for i, subitem in pairs(moduledata.items) do
			sublist = sublist .. addItem(subitem) .. '\n'
		end
		
		sublist = sublist .. '</div></div>'
		
		return sublist
	end
end

function p._build(args)
	-- chargement du module de paramétrage
	local moduledata = require( 'Module:Liste d\'objets de Fallout 76/' .. args.nom )
	
	local list = '<div class="avt-dropdown-box mw-collapsible">' ..
		'<div class="avt-dropdown-box-title">' .. moduledata.title .. '</div>' ..
		'<div class="avt-dropdown-box-content mw-collapsible-content">\n'
	
	for i, item in pairs(moduledata.items) do
		list = list .. addItem(item) .. '\n'
	end
	
	local list = list .. '</div></div>'

	return tostring(list)
end

function p.build(frame)
	local args = {}
	
	local argsParent = frame:getParent().args
	for cle, val in pairs(argsParent) do
		if val then
			args[cle] = mw.text.trim(val)
		end
	end
	
	return p._build(args)
end

return p