ScriptingExamples/BasicCommand

2018-12-27T17:13:13Z

Bluesn0w:

{{DISPLAYTITLE:Basic Command}}
== Description ==

This code adds a red chat message to the chat box when any player types /text

== Code ==

All examples below do the same thing, in terms of adding the chat message when the command is typed.<br>
Two examples are shown for each supported scripting language, 1 with a global function, 1 with a lambda function. Lambda functions are favoured.<br>
All examples below are server-side code, not client-side code.

'''JavaScript - Global Function'''

{{JSCode|1=function textCommand(command, args, client) {
message('This text is displayed in the chatbox when /text is typed ingame.', COLOUR_RED);
};
addCommandHandler('text', textCommand);}}

'''JavaScript - Lambda Function'''

{{JSCode|1=addCommandHandler('text', function(command, args, client) {
message('This text is displayed in the chatbox when /text is typed ingame.', COLOUR_RED);
});}}

'''Squirrel - Global Function'''

{{SquirrelCode|1=function textCommand(command, args, client) {
message('This text is displayed in the chatbox when /text is typed ingame.', COLOUR_RED);
};
addCommandHandler('text', textCommand);}}

'''Squirrel - Lambda Function'''

{{SquirrelCode|1=addCommandHandler('text', function(command, args, client) {
message('This text is displayed in the chatbox when /text is typed ingame.', COLOUR_RED);
});}}

'''Lua - Global Function'''

{{LuaCode|1=function textCommand(command, args, client)
message('This text is displayed in the chatbox when /text is typed ingame.', COLOUR_RED)
end
addCommandHandler('text', textCommand)}}

'''Lua - Lambda Function'''

{{LuaCode|1=addCommandHandler('text', function(command, args, client)
message('This text is displayed in the chatbox when /text is typed ingame.', COLOUR_RED)
end)}}

== Notes ==

The code uses [[addCommandHandler|addCommandHandler]], which is a shared function, shared means that the functionality is available both server-side and client-side.<br>
The code uses COLOUR_RED which is a server define, see [[Server/Defines#Colour_Defines|Server Colour Defines]].

GTA Connected - User contributions [en]

ScriptingExamples/BasicCommand