Multi Theft Auto: Wiki - User contributions [en]

Modules/IRCEcho/irc onConnecting

2008-02-09T22:39:40Z

VRocker:

__NOTOC__
{{ModuleFunction|IRCEcho}}
This is called when the IRC Module is attempting to connect to a server

==Syntax==
<syntaxhighlight lang="lua">
function irc_onConnecting ( string IP, int Port )
</syntaxhighlight>
===Required arguments===
* '''IP:''' The IP/Hostname of the server you are trying to connect to
* '''Port:''' The Port of the IRC Server you are trying to connect to

==Example==
'''Example 1:''' This script outputs to the server console that it is attempting a connection
<syntaxhighlight lang="lua">
function irc_onConnecting( IP, Port )
outputServerLog( "Connecting to IRC (" .. IP .. ":" .. tostring( Port ) .. ")" )
end
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Callbacks}}

Modules/IRCEcho/irc onConnected

2008-02-09T22:39:12Z

VRocker: New page: __NOTOC__ {{ModuleFunction|IRCEcho}} This is called when the IRC Module has successfully connected to a server ==Syntax== <syntaxhighlight lang="lua"> function irc_onConnected ( ) </syntaxhighlight> ==Example== ...

__NOTOC__
{{ModuleFunction|IRCEcho}}
This is called when the IRC Module has successfully connected to a server

==Syntax==
<syntaxhighlight lang="lua">
function irc_onConnected ( )
</syntaxhighlight>

==Example==
'''Example 1:''' This script outputs that the server has connected to IRC
<syntaxhighlight lang="lua">
function irc_onConnected( )
outputServerLog( "IRC Connected!" )
end
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Callbacks}}

Modules/IRCEcho/irc onConnecting

2008-02-09T22:36:40Z

VRocker:

__NOTOC__
{{ModuleFunction|IRCEcho}}
This is called when the IRC Module is attempting to connect to a server

==Syntax==
<syntaxhighlight lang="lua">
function irc_onConnecting ( string IP, int Port )
</syntaxhighlight>
===Required arguments===
* '''IP:''' The IP/Hostname of the server you are trying to connect to
* '''Port:''' The Port of the IRC Server you are trying to connect to

==Example==
'''Example 1:''' This script can be used from irc, so people can check their rights
<syntaxhighlight lang="lua">
function irc_onConnecting( IP, Port )
outputServerLog( "Connecting to IRC (" .. IP .. ":" .. tostring( Port ) .. ")" )
end
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Callbacks}}

Modules/IRCEcho/irc onConnecting

2008-02-09T22:36:30Z

VRocker:

__NOTOC__
{{ModuleFunction|IRCEcho}}
This is called when the IRC Module is attempting to connect to a server

==Syntax==
<syntaxhighlight lang="lua">
function irc_onConnecting ( string IP, int Port )
</syntaxhighlight>
===Required arguments===
* '''IP:''' The IP/Hostname of the server you are trying to connect to
* '''Port:''' The Port of the IRC Server you are trying to connect to

==Example==
'''Example 1:''' This script can be used from irc, so people can check their rights
<syntaxhighlight lang="lua">
function irc_onConnecting( IP, Port )
outputServerLog( "Connecting to IRC (" .. IP .. ":" .. tostring( Port ) .. ")" )
end
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/irc onConnecting

2008-02-09T22:36:11Z

VRocker: New page: __NOTOC__ {{ModuleFunction|IRCEcho}} This is called when the IRC Module is attempting to connect to a server ==Syntax== <syntaxhighlight lang="lua"> function irc_onConnecting ( string IP, int Port ) </c...

__NOTOC__
{{ModuleFunction|IRCEcho}}
This is called when the IRC Module is attempting to connect to a server

==Syntax==
<syntaxhighlight lang="lua">
function irc_onConnecting ( string IP, int Port )
</syntaxhighlight>
===Required arguments===
* '''IP:''' The IP/Hostname of the server you are trying to connect to
* '''Port:''' The Port of the IRC Server you are trying to connect to

==Example==
'''Example 1:''' This script can be used from irc, so people can check their rights
<syntaxhighlight lang="lua">
function irc_onConnecting( IP, Port )
outputServerLog( "Connecting to IRC (" .. IP .. ":" .. tostring( Port ) .. ")" )
end
</syntaxhighlight>

Modules/IRCEcho

2008-02-09T22:31:31Z

VRocker:

{{Module_Info|
name = MTASA IRC Echo |
version = 2.1 |
author = [[User:VRocker|VRocker]] |
module_website = ''Not available'' |
download_link = [http://liberty-unleashed.co.uk/MTA/IRC%20Echo%20Script%20v2.zip Here] |
license = ''Unlicensed'' |
}}
MTASA IRC Echo is a module that provides an IRC echo for an MTASA server. It is available for both Windows and Linux.

==Installation==
===Windows===
Uncompress the file ml_ircecho.dll into your ''%PROGRAMFILES%\MTA San Andreas\server\mods\deathmatch\modules\'' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module file="ml_ircecho.dll" />
</syntaxhighlight>

===Linux===
Uncompress the file ml_ircecho.so into your ''%MTASERVER%\mods\deathmatch\modules\'' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module file="ml_ircecho.so" />
</syntaxhighlight>

==Functions==
{{Modules/IRCEcho/Functions}}

==Callbacks==
{{Modules/IRCEcho/Callbacks}}

[[Category:Modules]]

Modules/IRCEcho/ircOpen

2008-01-13T15:22:19Z

VRocker:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Opens a connection to the specified IRC Server

==Syntax==
<syntaxhighlight lang="lua">
IRCConnection ircOpen ( string hostname, int port, string nick, string channel, [ string password = ""] )
</syntaxhighlight>
===Required arguments===
* '''hostname:''' The IRC server to connect to
* '''port:''' The IRC server port
* '''nick:''' The nickname you want your bot to connect as
* '''channel:''' The channel you want the bot to join on connect

===Optional arguments===
{{OptionalArg}}
* '''password''': The password to enter the IRC server

===Returns===
Returns a pointer to the IRC connection if successful, otherwise it returns ''nil''

==Example==
'''Example 1:''' This example connects to ''irc.gtanet.com'' on port ''6667'' as ''WikiTest'' and joins ''#Channel''
<syntaxhighlight lang="lua">
szChans = {} --Init an array of channels for storage

function onResourceStart( res )
if res == getThisResource() then -- If the starting resource is this one
ircInit( ) -- Initialize the module for this resource
pIRC = ircOpen( "irc.gtanet.com", 6667, "WikiTest", "#channel" ) -- Open the IRC connection
if pIRC then -- If opening connection was successful
szChans[ pIRC ] = "#channel" -- Add the channel to the table
end
end
end

addEventHandler( "onResourceStart", getRootElement(), onResourceStart )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircInit

2008-01-13T15:21:50Z

VRocker:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Initializes the module for use in the script. Must be ran in the scripts you want to use with the echo

==Syntax==
<syntaxhighlight lang="lua">
function ircInit()
</syntaxhighlight>

==Example==
'''Example 1:''' This example initializes the module on resource startup
<syntaxhighlight lang="lua">
function onResourceStart( res )
if ( res == getThisResource () ) then
ircInit()
outputServerLog( "Initialized IRC for " .. getResourceName( res ) )
end
end

addEventHandler( "onResourceStart", getRootElement(), onResourceStart )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircDisconnect

2008-01-13T15:21:27Z

VRocker:

__NOTOC__
{{ModuleFunction|IRCEcho}}
Disconnects an open IRC Connection

==Syntax==
<syntaxhighlight lang="lua">
function ircDisconnect ( IRCConnection irc )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection you wish to disconnect

==Example==
'''Example 1:''' This example connects to a server on ''ResourceStart'' and disconnects on ''ResourceStop''
<syntaxhighlight lang="lua">
szChans = {} --Init an array of channels for storage

function onResourceStart( res )
if res == getThisResource() then -- If the starting resource is this one
ircInit( ) -- Initialize the module for this resource
pIRC = ircOpen( "irc.gtanet.com", 6667, "WikiTest", "#channel" ) -- Open the IRC connection
if pIRC then -- If opening connection was successful
szChans[ pIRC ] = "#channel" -- Add the channel to the table
end
end
end

function onResourceStop( res )
if res == getThisResource () then -- If the stopping resource is this one
if pIRC then -- If theres an IRC Connection
ircDisconnect( pIRC ) -- Disconnect the connection
szChans[ pIRC ] = nil -- Removes the channel from the array
pIRC = nil -- Set the connection to nil
end
end
end

addEventHandler( "onResourceStart", getRootElement(), onResourceStart )
addEventHandler( "onResourceStop", getRootElement(), onResourceStop )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircDisconnect

2008-01-13T14:41:35Z

VRocker: New page: __NOTOC__ Disconnects an open IRC Connection ==Syntax== <syntaxhighlight lang="lua"> function ircDisconnect ( IRCConnection irc ) </syntaxhighlight> ===Required arguments=== * '''irc:''' The IRCConnection you wish...

__NOTOC__
Disconnects an open IRC Connection

==Syntax==
<syntaxhighlight lang="lua">
function ircDisconnect ( IRCConnection irc )
</syntaxhighlight>
===Required arguments===
* '''irc:''' The IRCConnection you wish to disconnect

==Example==
'''Example 1:''' This example connects to a server on ''ResourceStart'' and disconnects on ''ResourceStop''
<syntaxhighlight lang="lua">
szChans = {} --Init an array of channels for storage

function onResourceStart( res )
if res == getThisResource() then -- If the starting resource is this one
ircInit( ) -- Initialize the module for this resource
pIRC = ircOpen( "irc.gtanet.com", 6667, "WikiTest", "#channel" ) -- Open the IRC connection
if pIRC then -- If opening connection was successful
szChans[ pIRC ] = "#channel" -- Add the channel to the table
end
end
end

function onResourceStop( res )
if res == getThisResource () then -- If the stopping resource is this one
if pIRC then -- If theres an IRC Connection
ircDisconnect( pIRC ) -- Disconnect the connection
szChans[ pIRC ] = nil -- Removes the channel from the array
pIRC = nil -- Set the connection to nil
end
end
end

addEventHandler( "onResourceStart", getRootElement(), onResourceStart )
addEventHandler( "onResourceStop", getRootElement(), onResourceStop )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircOpen

2008-01-13T14:37:53Z

VRocker: /* Syntax */

__NOTOC__
Opens a connection to the specified IRC Server

==Syntax==
<syntaxhighlight lang="lua">
IRCConnection ircOpen ( string hostname, int port, string nick, string channel, [ string password = ""] )
</syntaxhighlight>
===Required arguments===
* '''hostname:''' The IRC server to connect to
* '''port:''' The IRC server port
* '''nick:''' The nickname you want your bot to connect as
* '''channel:''' The channel you want the bot to join on connect

===Optional arguments===
{{OptionalArg}}
* '''password''': The password to enter the IRC server

===Returns===
Returns a pointer to the IRC connection if successful, otherwise it returns ''nil''

==Example==
'''Example 1:''' This example connects to ''irc.gtanet.com'' on port ''6667'' as ''WikiTest'' and joins ''#Channel''
<syntaxhighlight lang="lua">
szChans = {} --Init an array of channels for storage

function onResourceStart( res )
if res == getThisResource() then -- If the starting resource is this one
ircInit( ) -- Initialize the module for this resource
pIRC = ircOpen( "irc.gtanet.com", 6667, "WikiTest", "#channel" ) -- Open the IRC connection
if pIRC then -- If opening connection was successful
szChans[ pIRC ] = "#channel" -- Add the channel to the table
end
end
end

addEventHandler( "onResourceStart", getRootElement(), onResourceStart )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho/ircOpen

2008-01-13T14:34:52Z

VRocker: New page: __NOTOC__ Opens a connection to the specified IRC Server ==Syntax== <syntaxhighlight lang="lua"> handler ircOpen ( string hostname, int port, string nick, string channel, [ string password = ""] ) </cod...

__NOTOC__
Opens a connection to the specified IRC Server

==Syntax==
<syntaxhighlight lang="lua">
handler ircOpen ( string hostname, int port, string nick, string channel, [ string password = ""] )
</syntaxhighlight>
===Required arguments===
* '''hostname:''' The IRC server to connect to
* '''port:''' The IRC server port
* '''nick:''' The nickname you want your bot to connect as
* '''channel:''' The channel you want the bot to join on connect

===Optional arguments===
{{OptionalArg}}
* '''password''': The password to enter the IRC server

===Returns===
Returns a pointer to the IRC connection if successful, otherwise it returns ''nil''

==Example==
'''Example 1:''' This example connects to ''irc.gtanet.com'' on port ''6667'' as ''WikiTest'' and joins ''#Channel''
<syntaxhighlight lang="lua">
szChans = {} --Init an array of channels for storage

function onResourceStart( res )
if res == getThisResource() then -- If the starting resource is this one
ircInit( ) -- Initialize the module for this resource
pIRC = ircOpen( "irc.gtanet.com", 6667, "WikiTest", "#channel" ) -- Open the IRC connection
if pIRC then -- If opening connection was successful
szChans[ pIRC ] = "#channel" -- Add the channel to the table
end
end
end

addEventHandler( "onResourceStart", getRootElement(), onResourceStart )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Modules/IRCEcho

2008-01-13T14:25:51Z

VRocker:

{{Module_Info|
name = MTASA IRC Echo |
version = 2.0 |
author = [[User:VRocker|VRocker]] |
module_website = ''Not available'' |
download_link = [http://liberty-unleashed.co.uk/MTA/IRC%20Echo%20Script%20v2.zip Here] |
license = ''Unlicensed'' |
}}
MTASA IRC Echo is a module that provides an IRC echo for an MTASA server. At the moment it is only available for windows but a linux version will be available soon.

==Installation==
===Windows===
Uncompress the file ml_ircecho.dll into your ''%PROGRAMFILES%\MTA San Andreas\server\mods\deathmatch\modules\'' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module file="ml_ircecho.dll" />
</syntaxhighlight>

==Functions==
{{Modules/IRCEcho/Functions}}

==Callbacks==
{{Modules/IRCEcho/Callbacks}}

[[Category:Modules]]

Modules/IRCEcho/ircInit

2008-01-13T14:25:10Z

VRocker: New page: __NOTOC__ Initializes the module for use in the script. Must be ran in the scripts you want to use with the echo ==Syntax== <syntaxhighlight lang="lua"> function ircInit() </syntaxhighlight> ==Example== '''Examp...

__NOTOC__
Initializes the module for use in the script. Must be ran in the scripts you want to use with the echo

==Syntax==
<syntaxhighlight lang="lua">
function ircInit()
</syntaxhighlight>

==Example==
'''Example 1:''' This example initializes the module on resource startup
<syntaxhighlight lang="lua">
function onResourceStart( res )
if ( res == getThisResource () ) then
ircInit()
outputServerLog( "Initialized IRC for " .. getResourceName( res ) )
end
end

addEventHandler( "onResourceStart", getRootElement(), onResourceStart )
</syntaxhighlight>

==See also==
{{Modules/IRCEcho/Functions}}

Template:Modules/IRCEcho/Callbacks

2008-01-13T14:16:59Z

VRocker: New page: * irc_onConnecting * irc_onConnected * irc_onDisconnected * [[Modules/IRCEch...

* [[Modules/IRCEcho/irc_onConnecting|irc_onConnecting]]
* [[Modules/IRCEcho/irc_onConnected|irc_onConnected]]
* [[Modules/IRCEcho/irc_onDisconnected|irc_onDisconnected]]
* [[Modules/IRCEcho/irc_onFailedConnection|irc_onFailedConnection]]
* [[Modules/IRCEcho/irc_onPrivMsg|irc_onPrivMsg]]
* [[Modules/IRCEcho/irc_onNotice|irc_onNotice]]
* [[Modules/IRCEcho/irc_onJoin|irc_onJoin]]
* [[Modules/IRCEcho/irc_onPart|irc_onPart]]
* [[Modules/IRCEcho/irc_onQuit|irc_onQuit]]
* [[Modules/IRCEcho/irc_onNickChange|irc_onNickChange]]
* [[Modules/IRCEcho/irc_onRaw|irc_onRaw]]

Template:Modules/IRCEcho/Functions

2008-01-13T14:12:52Z

VRocker: New page: * ircInit * ircOpen * ircDisconnect * ircMessage * [[Modules/IRCEch...

Modules/IRCEcho

2008-01-13T14:08:37Z

VRocker:

{{Module_Info|
name = MTASA IRC Echo |
version = 2.0 |
author = [[User:VRocker|VRocker]] |
module_website = ''Not available'' |
download_link = [http://liberty-unleashed.co.uk/MTA/IRC%20Echo%20Script%20v2.zip Here] |
}}
MTASA IRC Echo is a module that provides an IRC echo for an MTASA server. At the moment it is only available for windows but a linux version will be available soon.

==Installation==
===Windows===
Uncompress the file ml_ircecho.dll into your ''%PROGRAMFILES%\MTA San Andreas\server\mods\deathmatch\modules\'' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module file="ml_ircecho.dll" />
</syntaxhighlight>

==Functions==
{{Modules/IRCEcho/Functions}}

==Callbacks==
{{Modules/IRCEcho/Callbacks}}

[[Category:Modules]]

Modules/IRCEcho

2008-01-13T14:05:31Z

VRocker: Initial Page

{{Module_Info|
name = MTASA IRC Echo |
version = 2.0 |
author = [[User:VRocker|VRocker]] |
module_website = ''Not available'' |
download_link = [http://liberty-unleashed.co.uk/MTA/IRC%20Echo%20Script%20v2.zip Here] |
}}
MTASA IRC Echo is a module that provides an IRC echo for an MTASA server. At the moment it is only available for windows but a linux version will be available soon.

==Installation==
===Windows===
Uncompress the file ml_ircecho.dll into your ''%PROGRAMFILES%\MTA San Andreas\server\mods\deathmatch\modules\'' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module file="ml_ircecho.dll" />
</syntaxhighlight>

==Handler functions==
{{Modules/IRCEcho/Handler_functions}}

==Result managing functions==
{{Modules/IRCEcho/Result_functions}}

[[Category:Modules]]

GetResourceState

2008-01-07T01:02:53Z

VRocker:

{{Server function}}
__NOTOC__

This function returns the state of a given reesource
==Syntax==

<syntaxhighlight lang="lua">
string getResourceState ( resource res )
</syntaxhighlight>

===Required Arguments===

*'''res:''' The resource you wish to get the name of.

===Returns===

Returns a string with the resource state in it. <br \>
- false on fail

==Example==
<section class="server" name="Server" show="true">

This example returns the state of a given resource. Syntax: ''/state <Resource Name>''

<syntaxhighlight lang="lua">
function getState( player, command, sz )
if sz then
local bFound = false
local resourceTable = getResources() -- get a table of resources

for resourceKey, resourceValue in ipairs( resourceTable ) do
-- iterate through the table and output each resource's name
local name = getResourceName( resourceValue )
if string.lower( name ) == string.lower( sz ) then
outputChatBox( "Resource State: " .. name .. " is currently " .. getResourceState( resourceValue ), player, 0, 0, 255 )
bFound = true
break
end
end

if bFound ~= true then
outputChatBox( "Error: No resource found named: " .. sz, player, 255, 0, 0 )
end
else
outputChatBox( "Error: You did not specify a resource to check", player, 255, 0, 0 )
end
end

addCommandHandler( "state", getState )
</syntaxhighlight>
</section>

==See Also==
{{Resource functions}}

GetResourceState

2008-01-07T00:59:07Z

VRocker: Added a description and example. May need a list of returns

OnBan

2008-01-07T00:30:53Z

VRocker: /* See Also */

__NOTOC__
{{Server event}}
This event is triggered when an IP address or serial is banned from the server.

==Parameters==
<syntaxhighlight lang="lua">
string theIPOrSerial
</syntaxhighlight>

*'''theIPOrSerial''': The IP address or serial that was banned from the server.

==Source==
The [[event system#Event source|source]] of this event is the [[element]] that was responsible for the banning. If no responsible was specified, the source is the global root element.

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the requested ban is not performed.

==Example==

This example does...

<syntaxhighlight lang="lua">
root = getRootElement()

function announceBan( sz )
if getElementType( source ) then --Check if a player banned the IP/Serial
outputChatBox( getClientName( source ) .. " banned " .. sz ) --Output to the chatbox saying the player has banned the IP/Serial
end
end

addEventHandler( "onBan", root, announceBan ) --Adds the event handler for 'onBan'
</syntaxhighlight>

==See Also==
{{Event_functions}}

OnUnban

2008-01-07T00:30:32Z

VRocker: /* See Also */

__NOTOC__
{{Server event}}
This event is triggered when an IP address or serial is unbanned from the server.

==Parameters==
<syntaxhighlight lang="lua">
string theIPOrSerial
</syntaxhighlight>

*'''theIPOrSerial''': The IP address or serial that was unbanned from the server.

==Source==
The [[event system#Event source|source]] of this event is the [[element]] that was responsible for the unbanning. If no responsible was specified, the source is the global root element.

==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the requested unban is not performed.

==Example==

This example does...

<syntaxhighlight lang="lua">
root = getRootElement()

function announceUnban( sz )
if getElementType( source ) then --Check if a player unbanned the IP/Serial
outputChatBox( getClientName( source ) .. " unbanned " .. sz ) --Output to the chatbox saying the player has unbanned the IP/Serial
end
end

addEventHandler( "onUnban", root, announceUnban ) --Adds the event handler for 'onUnban'
</syntaxhighlight>

==See Also==
{{Event_functions}}

OnUnban

2008-01-07T00:30:14Z

VRocker: Added an example

OnBan

2008-01-07T00:28:45Z

VRocker: Added a small example announcing the ban

EngineLoadTXD

2008-01-06T16:54:19Z

VRocker: removed enginePreloadModel from the example since it doesn't exist

{{Client function}}
__NOTOC__
This function loads a RenderWare Texture Dictionary (TXD) file into GTA. The texture dictionary can then be used to provide textures.

This is a client side function. Be sure to transfer your TXD file by including it in the meta file.

==Syntax==
<syntaxhighlight lang="lua">
txd engineLoadTXD ( string txd_file )
</syntaxhighlight>

===Required Arguments===
*'''txd_file:''' The relative path to the txd file you want to load

===Returns===
Returns a [[TXD]] if the file was loaded, ''false'' otherwise.

==Example==
'''Example 1:''' This example loads a combination of a custom DFF and TXD file to replace the Euros vehicle in-game. The collisions are embedded inside the DFF file.
<syntaxhighlight lang="lua">
outputChatBox ( "> replacing the euros vehicle" )

txd = engineLoadTXD ( "data/euros.txd" )
engineImportTXD ( txd, 587 )
dff = engineLoadDFF ( "data/euros.dff", 587 )
engineReplaceModel ( dff, 587 )
</syntaxhighlight>

'''Example 2:''' This example loads a combination of custom DFF, TXD and COL files to replace an in-game model of a set of floors.
<syntaxhighlight lang="lua">
outputChatBox ( "> loading floor objects" )
txd_floors = engineLoadTXD ( "models/office_floors.txd" )
engineImportTXD ( txd_floors, 3781 )
col_floors = engineLoadCOL ( "models/office_floors.col" )
dff_floors = engineLoadDFF ( "models/office_floors.dff", 0 )
engineImportCOL ( col_floors, 3781 )
engineReplaceModel ( dff_floors, 3781 )
</syntaxhighlight>

==See Also==
{{Engine_functions}}

CreateColCircle

2008-01-05T23:27:06Z

VRocker: Fixed the syntax in the example (Removed fZ)

__NOTOC__
{{Server client function}}
This function creates a collision circle. This is a shape that has a position and a radius and infinite height that you can use to detect a player's presence. Events will be triggered when a player enters or leaves it.

==Syntax==
<syntaxhighlight lang="lua">
colshape createColCircle ( float fX, float fY, float radius )
</syntaxhighlight>

===Required Arguments===
*'''fX:''' The collision circle's center point's X axis position
*'''fY:''' The collision circle's center point's Y axis position
*'''radius''' The radius of the collision circle

===Returns===
Returns a [[colshape]] element if successful, ''false'' if invalid arguments were passed to the function.

==Example==
<section name="Server" class="server" show="true">
This example displays a chat message when a player enters the colshape and allows the colshape to be created using a console function ''set_zone''.
<syntaxhighlight lang="lua">
theZone = false

function shapeHit ( thePlayer )
outputChatBox ( getClientName ( thePlayer ) .. " is in the zone!" ) -- display a message in everyone's chat box
end

function setZone ( playerSource, commandName, fX, fY )
if ( fY and fX ) then -- check we've got all 3 args we need
local tempCol = createColCircle ( fX, fY, 10.0 ) -- create a col
if ( tempCol == false ) then -- did the col get created successfully?
outputConsole ( "Syntax is: set_zone <X> <Y>" ) -- inform the user what the valid syntax is
else
if ( theZone ~= false ) then -- did we already have a zone?
destroyElement ( theZone ) -- if so, destroy it
else
addEventHandler ( "onColShapeHit", theZone, shapeHit ) -- add a handler for the onColShapeHit event
end
theZone = tempCol -- and store the new zone we've made
outputChatBox ( "Zone has moved!" ) -- and tell everyone
end
end
end
addCommandHandler ( "set_zone", setZone ) -- add a console function called set_zone that will trigger the function setZone
</syntaxhighlight>
</section>

==See Also==
{{Collision shape functions}}
[[Category:Needs_More_Examples]]

CreateColCircle

2008-01-05T23:26:43Z

VRocker: Fixed the syntax in the example (Removed fZ)

__NOTOC__
{{Server client function}}
This function creates a collision circle. This is a shape that has a position and a radius and infinite height that you can use to detect a player's presence. Events will be triggered when a player enters or leaves it.

==Syntax==
<syntaxhighlight lang="lua">
colshape createColCircle ( float fX, float fY, float radius )
</syntaxhighlight>

===Required Arguments===
*'''fX:''' The collision circle's center point's X axis position
*'''fY:''' The collision circle's center point's Y axis position
*'''radius''' The radius of the collision circle

===Returns===
Returns a [[colshape]] element if successful, ''false'' if invalid arguments were passed to the function.

==Example==
<section name="Server" class="server" show="true">
This example displays a chat message when a player enters the colshape and allows the colshape to be created using a console function ''set_zone''.
<syntaxhighlight lang="lua">
theZone = false

function shapeHit ( thePlayer )
outputChatBox ( getClientName ( thePlayer ) .. " is in the zone!" ) -- display a message in everyone's chat box
end

function setZone ( playerSource, commandName, fX, fY, fZ )
if ( fZ and fY and fX ) then -- check we've got all 3 args we need
local tempCol = createColCircle ( fX, fY, 10.0 ) -- create a col
if ( tempCol == false ) then -- did the col get created successfully?
outputConsole ( "Syntax is: set_zone <X> <Y> <Z>" ) -- inform the user what the valid syntax is
else
if ( theZone ~= false ) then -- did we already have a zone?
destroyElement ( theZone ) -- if so, destroy it
else
addEventHandler ( "onColShapeHit", theZone, shapeHit ) -- add a handler for the onColShapeHit event
end
theZone = tempCol -- and store the new zone we've made
outputChatBox ( "Zone has moved!" ) -- and tell everyone
end
end
end
addCommandHandler ( "set_zone", setZone ) -- add a console function called set_zone that will trigger the function setZone
</syntaxhighlight>
</section>

==See Also==
{{Collision shape functions}}
[[Category:Needs_More_Examples]]