ContextActionService

Méthodes

BindAction(actionName : string,functionToBind : function,createTouchButton : bool,inputTypes : Tuple):void
Lier l'entrée de l'utilisateur à une action donnée par une fonction de gestion de l'action.
BindActionAtPriority(actionName : string,functionToBind : function,createTouchButton : bool,priorityLevel : number,inputTypes : Tuple):void
Comporte comme BindAction mais aussi permet d'assigner une priorité à l'action liée pour les types d'entrée interchangeables (haut avant bas).
BindActivate(userInputTypeForActivation : Enum.UserInputType,keyCodesForActivation : Tuple):void
Liez un Enum.KeyCode et Enum.UserInputType avec un Tool.Activation spécifique pour déclencher 2>Class.Tool.Activation2> et 5>Class.ClickDetector5> événements.
GetAllBoundActionInfo():Dictionary
Obtenez une table d'informations sur toutes les actions liées (la clé est le nom donné à BindAction , la valeur est une table de GetBoundActionInfo lorsqu'elle est appelée avec la clé).
GetBoundActionInfo(actionName : string):Dictionary
Obtenez une table d'informations sur une action liée donnée son nom initialement passé à BindAction .
GetCurrentLocalToolIcon():string
Retournez le BackpackItem.TextureId d'un Tool actuellement equipped par le 1> Class.Player1>.
SetDescription(actionName : string,description : string):void
En fonction du nom d'une action avec un bouton de touche, définit la description de l'action.
SetImage(actionName : string,image : string):void
Si la clé actionName contient une action liée, alors image est définie comme l'image du bouton de touche.
SetPosition(actionName : string,position : UDim2):void
En raison du nom d'une action liée par un bouton de touche, détermine la position du bouton dans le ContextButtonFrame.
SetTitle(actionName : string,title : string):void
En fonction du nom d'une action liée par un bouton de touche, définit le texte affiché sur le bouton.
UnbindAction(actionName : string):void
Définir une action à partir de son nom d'entrée.
UnbindActivate(userInputTypeForActivation : Enum.UserInputType,keyCodeForActivation : Enum.KeyCode):void
Débind a Enum.KeyCode avec un Enum.UserInputType spécifique à partir du déclenchement de Tool.Activation lorsque lié à 1> Class.Tool.Activation1> .
UnbindAllActions():void
Supprime toutes les fonctions liées. Aucun nom d'action ne restera. Tous les boutons de touche seront supprimés.
GetButton(actionName : string):Instance
Rendement
Récupère un ImageButton d'une action bound qui avait un bouton d'entrée tactile créé.

Évènements

LocalToolEquipped(toolEquipped : Instance):RBXScriptSignal
Se déclenche lorsque le joueur actuel équipe un Tool .
LocalToolUnequipped(toolUnequipped : Instance):RBXScriptSignal
Tire quand le joueur actuel se dééquipe d'un Tool.

Propriétés

Méthodes

BindAction

void

Lier une action à l'entrée d'un utilisateur donné une fonction de gestion d'action. Lorsqu'

L'exemple de code ci-dessous montre comment un Sound peut être played pendant qu'une touche ( H), un bouton de pad de jeu ou un bouton d'écran touché est appuyé.


local ContextActionService = game:GetService("ContextActionService")

-- Un son de clairon d'automobile
local honkSound = Instance.new("Sound", workspace)
honkSound.Looped = true
honkSound.SoundId = "rbxassetid://9120386436"

local function handleAction(actionName, inputState, inputObject)
	if actionName == "HonkHorn" then
		if inputState == Enum.UserInputState.Begin then
			honkSound:Play()
		else
			honkSound:Pause()
		end
	end
end

-- Lorsque le joueur se situe dans le véhicule :
ContextActionService:BindAction("HonkHorn", handleAction, true, Enum.KeyCode.H, Enum.KeyCode.ButtonY)

-- Lorsque le joueur sort :
ContextActionService:UnbindAction("HonkHorn")

Paramètres du gestionnaire d'action

Les fonctions d'action sont appelées avec les paramètres suivants :


<tr>
  <td>1</td>
  <td><code>chaîne</code></td>
  <td>La même chaîne qui a été initialement passée à BindAction</td>
</tr>

<tr>
  <td>2</td>
  <td><code>État de l'entrée de l'utilisateur</code></td>
  <td>L'état de l'entrée (Début, Changer, Fin ou Annuler)\*</td>
</tr>

<tr>
  <td>3</td>
  <td><code>Objet d'entrée</code></td>
  <td>Un objet qui contient des informations sur l'entrée (selon le type d'entrée)</td>
</tr>

Type

Description

^ Cela permet à une fonction de gérer plusieurs actions à la fois, si nécessaire. * Annuler est envoyé si l'entrée est en cours et qu'une autre action est liée à l'entrée en cours, ou si l'entrée en cours est liée à unbound .

Pile de liens d'action

Les liens d

Boutons de touche

En plus des types d'entrée, ce paramètre de fonction contrôle si un bouton est créationspour les appareils Class.UserInputService.TouchEnabled|Touch

Paramètres

actionName: string

Une chaîne représentant l'action à exécuter (par exemple « HonkHorn » ou « OpenDoor »).

functionToBind: function

La fonction de gestion des actions, appelée avec les paramètres suivants lorsque les entrées liées sont déclenchées : string (actionName), Enum.UserInputState et un objet d'entrée.

createTouchButton: bool

Whether a GUI button should be created for the action sur les appareils d'entrée tactile.

inputTypes: Tuple

N'importe quel nombre de Enum.KeyCode ou Enum.UserInputType représentant les entrées à lier à l'action.

Retours

void

Échantillons de code

ContextActionService Tool Reload

local ContextActionService = game:GetService("ContextActionService")

local ACTION_RELOAD = "Reload"

local tool = script.Parent

local function handleAction(actionName, inputState, _inputObject)
	if actionName == ACTION_RELOAD and inputState == Enum.UserInputState.Begin then
		print("Reloading!")
	end
end

tool.Equipped:Connect(function()
	ContextActionService:BindAction(ACTION_RELOAD, handleAction, true, Enum.KeyCode.R)
end)

tool.Unequipped:Connect(function()
	ContextActionService:UnbindAction(ACTION_RELOAD)
end)

General Action Handler

local ContextActionService = game:GetService("ContextActionService")

local function handleAction(actionName, inputState, inputObj)
	if inputState == Enum.UserInputState.Begin then
		print("Handling action: " .. actionName)
		print(inputObj.UserInputType)
	end

	-- Since this function does not return anything, this handler will
	-- "sink" the input and no other action handlers will be called after
	-- this one.
end

ContextActionService:BindAction("BoundAction", handleAction, false, Enum.KeyCode.F)

Stacked Action Handlers

local ContextActionService = game:GetService("ContextActionService")

-- Define an action handler for FirstAction
local function actionHandlerOne(actionName, inputState, _inputObj)
	if inputState == Enum.UserInputState.Begin then
		print("Action Handler One: " .. actionName)
	end
	-- This action handler returns nil, so it is assumed that
	-- it properly handles the action.
end

-- Binding the action FirstAction (it's on the bottom of the stack)
ContextActionService:BindAction("FirstAction", actionHandlerOne, false, Enum.KeyCode.Z, Enum.KeyCode.X, Enum.KeyCode.C)

-- Define an action handler for SecondAction
local function actionHandlerTwo(actionName, inputState, inputObj)
	if inputState == Enum.UserInputState.Begin then
		print("Action Handler Two: " .. actionName)
	end

	if inputObj.KeyCode == Enum.KeyCode.X then
		return Enum.ContextActionResult.Pass
	else
		-- Returning nil implicitly Sinks inputs
		return Enum.ContextActionResult.Sink
	end
end

-- Binding SecondAction over the first action (since it bound more recently, it is on the top of the stack)
-- Note that SecondAction uses the same keys as
ContextActionService:BindAction("SecondAction", actionHandlerTwo, false, Enum.KeyCode.Z, Enum.KeyCode.X)

BindActionAtPriority

void

BindActionAtPriority se comporte comme BindAction mais permet également à une priorité d'être attribuée à l'action liée. Si plusieurs actions sont liées à la même entrée, la fonction de priorité la plus élevée est appelée indépendamment de l'ordre dans lequel les actions sont liées. En d'autres termes, cette fonction remplace le comportement normal de BindAction.

Paramètres

actionName: string

Une chaîne représentant l'action à exécuter (par exemple « HonkHorn » ou « OpenDoor »).

functionToBind: function

La fonction de gestion des actions, appelée avec les paramètres suivants lorsque les entrées liées sont déclenchées : string (actionName), Enum.UserInputState et un objet d'entrée.

createTouchButton: bool

Whether a GUI button should be created for the action sur les appareils d'entrée tactile.

priorityLevel: number

Le niveau de priorité auquel l'action doit être liée (le plus élevé est recommandé avant le plus bas).

inputTypes: Tuple

N'importe quel nombre d'Enum.KeyCode ou Enum.UserInputType représentant les entrées à lier à l'action.

Retours

void

Échantillons de code

ContextActionService BindAction Priorities

local ContextActionService = game:GetService("ContextActionService")

local INPUT_KEY1 = Enum.KeyCode.Q
local INPUT_KEY2 = Enum.KeyCode.E

local function handleThrow(actionName: string, inputState: Enum.UserInputState, inputObject: InputObject)
	if inputState ~= Enum.UserInputState.Begin then
		return Enum.ContextActionResult.Pass
	end
	print(`Action [{actionName}] occurred. KeyCode [{inputObject.KeyCode}] pressed.`)

	return Enum.ContextActionResult.Sink
end

local function handlePunch(actionName: string, inputState: Enum.UserInputState, inputObject: InputObject)
	if inputState ~= Enum.UserInputState.Begin then
		return Enum.ContextActionResult.Pass
	end
	print(`Action [{actionName}] occurred. KeyCode [{inputObject.KeyCode}] pressed.`)

	return Enum.ContextActionResult.Sink
end

-- Without specifying priority, the most recently bound action is called first,
-- so pressing INPUT_KEY1 prints "Punch" and then sinks the input.
ContextActionService:BindAction("DefaultThrow", handleThrow, false, INPUT_KEY1)
ContextActionService:BindAction("DefaultPunch", handlePunch, false, INPUT_KEY1)

-- Here we bind both functions in the same order as above, but with explicitly swapped priorities.
-- That is, we give "Throw" a higher priority of 2 so it will be called first,
-- despite "Punch" still being bound more recently.
-- Pressing INPUT_KEY2 prints "Throw" and then sinks the input.
ContextActionService:BindActionAtPriority("PriorityThrow", handleThrow, false, 2, INPUT_KEY2)
ContextActionService:BindActionAtPriority("PriorityPunch", handlePunch, false, 1, INPUT_KEY2)

BindActivate

void

Notez que le Enum.UserInputType spécifié doit être Keyboard ou Gamepad1 via 2>Gamepad82> pour être valide.

Paramètres

userInputTypeForActivation: Enum.UserInputType

Doit être Keyboard ou Gamepad1 via Gamepad8.

keyCodesForActivation: Tuple

Retours

void

GetAllBoundActionInfo

GetAllBindActioninfo renvoie une table qui mappe tous les noms d'action (celes qui sont initialement passés à BindAction ) à une table renvoyée par GetBoundActionInfo lorsqu'elle est appelée avec le nom d'action lui-même. En utilisant cette fonction, vous pouvez inspecter tous les actions actuellement liées. Ceci est utile

Retours

GetBoundActionInfo

GetBoundActionInfo renvoie une table avec les clés suivantes décrivant une action liée donnant son nom. Pour obtenir les mêmes informations pour toutes les actions à la fois, utilisez GetAllBoundActionInfo .


<tr>
  <td><code>ordre de stackage</code></td>
  <td>number</td>

  <td>
    Décrire l'index de l'action sur le stack (augmentation)
  </td>
</tr>

<tr>
  <td><code>niveau de priorité</code> \*</td>
  <td>number</td>

  <td>
    Décrire le niveau de <code>Class.ContextActionService:BindActionAtPriority()|riorité</code> de l'action
  </td>
</tr>

<tr>
  <td><code>créer un bouton de touche</code></td>
  <td>bulle</td>

  <td>
    Détermine si un bouton de touche doit être créé sur les appareils <code>Class.UserInputService.TouchEnabled|TouchEnabled</code>
  </td>
</tr>

<tr>
  <td><code>types d'entrée</code></td>
  <td>table</td>

  <td>
    Les types d'entrée passés à <code>Class.ContextActionService:BindAction()|BindAction</code> pour lequel cette action se déclencheur
  </td>
</tr>

<tr>
  <td><code>description</code> ^</td>
  <td>chaîne</td>

  <td>
    La description de l'action définie par <code>Class.ContextActionService:SetDescription()|SetDescription</code>
  </td>
</tr>

<tr>
  <td><code>titre</code> †</td>
  <td>chaîne</td>

  <td>
    Titre de l'action défini par <code>Class.ContextActionService:SetTitle()|SetTitle</code>
  </td>
</tr>

<tr>
  <td><code>image</code> †</td>
  <td>chaîne</td>

  <td>
    L'image du bouton de touche de l'action définie par <code>Class.ContextActionService:SetImage() | SetImage</code>
  </td>
</tr>

Nom

Type

Description

Le niveau de priorité sera toujours inclus même si BindActionAtPriority n'est pas utilisé - par défaut, il sera 2000.

^ Indique que ce champ sera nil si la méthode associée n'a pas été appelée pour l'action donnée.

Paramètres

actionName: string

Retours