startResource

Client-side

Server-side

Shared

This page is incomplete! Help wanted!

Please finish this page using the corresponding Old Wiki article.
Go to Contribution guidelines for more information.

This function starts a resource either persistently or as a dependency of the current resource. If you start the resource persistently, the resource will run until stopped either using stopResource or by the server admin. A resource started as a dependency will stop when your resource stops, if no other resources have it as a depdendency. This is the same effect as using an include in your meta.xml file.

Syntax

 startResource ( )

Code Examples

server

This example starts a specified resource with the command; "/resource-start".

function startTheResource ( thePlayer, command, resourceName )
  if ( resourceName ) then -- Check if they specified a resource name
    local resource = getResourceFromName ( resourceName ) -- Get the resource

    local start = startResource ( resource ) -- Start the resource
    if ( start ) then -- If it was successfully started...
      outputChatBox ( resourceName .. " was started successfully.", thePlayer, 255, 0, 0 )
    else -- If it wasn't successfully started...
      outputChatBox ( "This resource doesn't exist.", thePlayer, 255, 0, 0 )
    end
  else -- If they didn't put a resource name...
    outputChatBox ( "Please specify a resource to start.", thePlayer, 255, 0, 0 )
  end
end
addCommandHandler ( "resource-start", startTheResource ) -- Make it trigger when somebody types "/resource-start"

startResource

Syntax

Code Examples

See Also

Resource Functions

Resource Events

Resource Elements

Reference