StartPackage: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
 
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|Starts a package at runtime. The game will automatically handle downloads for new client files.}}
{{FuncDescription|Starts a package at runtime. The game will automatically handle downloads for new client files.
 
Notice: [[StartPackage]] will first look into the '''autostart''' folder before looking in the '''packages''' folder.}}


{{FuncSyntax|StartPackage(PackageName)}}
{{FuncSyntax|StartPackage(PackageName)}}

Latest revision as of 12:14, 11 January 2021

StartPackage

Type: Function
Context: Server
Introduced: v1.0

Description

Starts a package at runtime. The game will automatically handle downloads for new client files.

Notice: StartPackage will first look into the autostart folder before looking in the packages folder.

Syntax

StartPackage(PackageName)

Parameters

  • PackageName
    The name of the package.

Return Value

  • Returns true on success.

Example

function cmd_restartpack(player, package_)
	StopPackage(package_)

	Delay(500, function()
		StartPackage(package_)
	end)
end
AddCommand("restartpack", cmd_restartpack)

See also