Wikipédia:LiveRC/Documentation/Hooks/AfterFillParamPanel/fr
"AfterFillParamPanel"
est le nom d'un hook inséré dans le code de LiveRC permettant à des fonctions annexes définies par une extension d'être exécutées juste après le décompte des paramètres à prendre en compte dans le menu de configuration et avant l'affichage du menu de personnalisation.
Utilisation
[modifier le code]Le hook AfterFillParamPanel
s'utilise en conjonction avec la fonction LiveRC_ManageParams_Fill()
, qui sert à ajouter une variable de type Object
à la personnalisation automatique, créant un nouvel onglet dans le menu.
Sa syntaxe est la suivante :
LiveRC_ManageParams_Fill(OptionArray, ArrayName, FunctionName, AddButton)
OptionArray
- nom de l'Object;
ArrayName
- nom de l'Object, entre guillemets;
FunctionName
- nom de la fonction utilisée pour définir la variable personnalisée. Si AddButton est à true, la fonction sera du type
AddCustomParam(Valeur)
, sinon, elle sera du typeAddCustomParam(item, Valeur)
. (falcultatif, mettre false pour que la définition soit faire directement)
- nom de la fonction utilisée pour définir la variable personnalisée. Si AddButton est à true, la fonction sera du type
AddButton
true
si il faut ajouter des liens permettant aux utilisateurs d'ajouter ou retirer des éléments à la variable (comme par exemple pour les messages de révocation). S'utilise lorsque la variable à personnaliser est une pureArray
.
Note : Les variables ainsi personnalisées seront prises en compte lors de l'enregistrement des paramètres du menu de configuration. Il n'y a pas besoin de fonction spécifique pour ce faire.
Syntaxe
[modifier le code]// Déclaration des variables personnalisables
var VariableUn = { "value1" : "1", "value2" : "2", "value3" : "3" }
var VariableDeux = [ "pomme", "banane", "abricot" ];
var VariableTrois = { "tomate" : "rouge", "laitue" : "vert", "radis" : "noir" };
var VariableQuatre = [ "coccinelle", "araignée", "guêpe" ];
// Fonctions de personnalisations
function AddParamToVariableTrois(item, value){
VariableTrois[item] = value;
}
function AddParamToVariableQuatre(value){
VariableQuatre = value;
}
// Intégration des variables à la personnalisation
LiveRC_AddHook("AfterFillParamPanel", function(){
LiveRC_ManageParams_Fill(VariableUn, "VariableUn");
LiveRC_ManageParams_Fill(VariableDeux, "VariableDeux", false, true);
LiveRC_ManageParams_Fill(VariableTrois, "VariableTrois", "AddParamToVariableTrois");
LiveRC_ManageParams_Fill(VariableQuatre, "VariableQuatre", "AddParamToVariableQuatre", true);
});
Exemple
[modifier le code]Extensions utilisant ce hook :