OnActionKey - Revision history

BlueMountains at 19:55, 23 February 2022

2022-02-23T19:55:35Z

← Older revision		Revision as of 19:55, 23 February 2022
Line 1:		Line 1:
	{{Info\|Event\|Client\|1.5.5}}		{{Info\|Event\|Client\|1.5.5}}

	{{FuncDescription\|Called when the player pressed a specific key that is an "action". For example the space-bar for jumping.}}		{{FuncDescription\|Called when the player pressed a specific key that is an "action". For example the space-bar for jumping.

			Returning '''false''' in this function cancels the action.}}

	{{FuncSyntax\|OnActionKey(EventType, ActionName, KeyName)}}		{{FuncSyntax\|OnActionKey(EventType, ActionName, KeyName)}}

BlueMountains at 19:17, 23 February 2022

2022-02-23T19:17:09Z

← Older revision		Revision as of 19:17, 23 February 2022
Line 11:		Line 11:

	List of all ActionNames		List of all ActionNames

	[[File:ActionNames.PNG]]		[[File:ActionNames.PNG]]

BlueMountains at 19:16, 23 February 2022

2022-02-23T19:16:54Z

← Older revision		Revision as of 19:16, 23 February 2022
Line 9:		Line 9:
	{{FuncParam\|ActionName\|The name of the action. For example "Jump".}}		{{FuncParam\|ActionName\|The name of the action. For example "Jump".}}
	{{FuncParam\|KeyName\|The name of the key as a string.}}		{{FuncParam\|KeyName\|The name of the key as a string.}}

			List of all ActionNames
			[[File:ActionNames.PNG]]

	== Example ==		== Example ==

BlueMountains at 17:28, 23 February 2022

2022-02-23T17:28:17Z

← Older revision		Revision as of 17:28, 23 February 2022
Line 13:		Line 13:
	<syntaxhighlight lang="Lua">		<syntaxhighlight lang="Lua">
	function OnActionKey(EventType, ActionName, KeyName)		function OnActionKey(EventType, ActionName, KeyName)
	AddPlayerChat(~~key~~)		AddPlayerChat(ActionName)
	if ActionName == "Jump" then		if ActionName == "Jump" then
	return false -- This will cancel the action. In this case the player is unable to jump.		return false -- This will cancel the action. In this case the player is unable to jump.

BlueMountains: Created page with "{{Info|Event|Client|1.5.5}} {{FuncDescription|Called when the player pressed a specific key that is an "action". For example the space-bar for jumping.}} {{FuncSyntax|OnActionKey(EventType, ActionName, KeyName)}} {{FuncParameters}} {{FuncParam|EventType|The input event of type EInputEvent}} {{FuncParam|ActionName|The name of the action. For example "Jump".}} {{FuncParam|KeyName|The name of the key as a string.}} == Example == function OnA..."

2022-02-23T17:27:58Z

Created page with "{{Info|Event|Client|1.5.5}} {{FuncDescription|Called when the player pressed a specific key that is an "action". For example the space-bar for jumping.}} {{FuncSyntax|OnActionKey(EventType, ActionName, KeyName)}} {{FuncParameters}} {{FuncParam|EventType|The input event of type EInputEvent}} {{FuncParam|ActionName|The name of the action. For example "Jump".}} {{FuncParam|KeyName|The name of the key as a string.}} == Example == <syntaxhighlight lang="Lua"> function OnA..."

New page

{{Info|Event|Client|1.5.5}}

{{FuncDescription|Called when the player pressed a specific key that is an "action". For example the space-bar for jumping.}}

{{FuncSyntax|OnActionKey(EventType, ActionName, KeyName)}}

{{FuncParameters}}
{{FuncParam|EventType|The input event of type EInputEvent}}
{{FuncParam|ActionName|The name of the action. For example "Jump".}}
{{FuncParam|KeyName|The name of the key as a string.}}

== Example ==
<syntaxhighlight lang="Lua">
function OnActionKey(EventType, ActionName, KeyName)
AddPlayerChat(key)
if ActionName == "Jump" then
return false -- This will cancel the action. In this case the player is unable to jump.
end
end
AddEvent("OnActionKey", OnActionKey)

</syntaxhighlight>

{{RelatedFunctions}}
{{KeyClientEvents}}