SetTitle

Unsafe

For thread safety, this property is not safe to read in an unsynchronized thread.

Function of:

Description:

SetTitle will set the text shown on a touch button created by ContextActionService/BindAction|BindAction. Specifically, this sets the TextLabel/Text property of a TextLabel within the ImageButton that would be returned by ContextActionService/GetButton|GetButton. If no such bound action exists (e.g. nothing is returned by GetButton), this function does nothing and throws no error.

This function is part of a family of methods that customize the touch button of an action. Others in this family include ContextActionService/SetImage|SetImage and ContextActionService/SetPosition|SetPosition.

Parameters

Name	Type	Default	Description
Name actionName	Type string	Default	Summary The name of the action originally passed to BindAction
Name title	Type string	Default	Summary The text to display on the button

Returns

Return Type	Summary
Return Type void	Summary

Code Samples

ContextActionService Touch Button

This code sample demonstrates binding an “Inspect” action to a touch button created automatically by ContextActionService. The button is customized using ContextActionService/SetImage|SetImage, ContextActionService/SetTitle|SetTitle, ContextActionService/SetDescription|SetDescription and ContextActionService/SetPosition|SetPosition. The button is further customized by using ContextActionService/GetButton|GetButton to get a reference to the ImageButton itself and tinting it green by setting ImageButton/ImageColor3.

Paste this code into a LocalScript placed within StarterPlayerScripts to test it. In Studio, be sure to toggle the touch device emulator in order for the button to actually be created.

			
				ContextActionService Touch Button

				Expected Output
			
				Expand
				
			local ContextActionService = game:GetService("ContextActionService")

local ACTION_INSPECT = "Inspect"
local INPUT_INSPECT = Enum.KeyCode.E
local IMAGE_INSPECT = "rbxassetid://1826746856" -- Image of a speech bubble with ? in it

local function handleAction(actionName, inputState, inputObject)
	if actionName == ACTION_INSPECT and inputState == Enum.UserInputState.End then
		print("Inspecting")
	end
end

-- For touch devices, a button is created on-screen automatically via the 3rd parameter
ContextActionService:BindAction(ACTION_INSPECT, handleAction, true, INPUT_INSPECT)
-- We can use these functions to customize the button:
ContextActionService:SetImage(ACTION_INSPECT, IMAGE_INSPECT)
ContextActionService:SetTitle(ACTION_INSPECT, "Look")
ContextActionService:SetDescription(ACTION_INSPECT, "Inspect something.")
ContextActionService:SetPosition(ACTION_INSPECT, UDim2.new(0, 0, 0, 0))
-- We can manipulate the button directly using ContextActionService:GetButton
local imgButton = ContextActionService:GetButton(ACTION_INSPECT)
if imgButton then -- Remember: non-touch devices won't return anything!
	imgButton.ImageColor3 = Color3.new(.5, 1, .5) -- Tint the ImageButton green
end
		
			When run on a touch-enabled device, a green-tinted button will appear. The message "Inspecting" will be printed when the button is pressed then released, or when the E key is pressed.
		
				Copy Code
			
				Light Theme

SetTitle

Parameters

actionName

title

Returns

void

Code Samples

ContextActionService Touch Button