LoadPak

From Onset Developer Wiki
Revision as of 18:45, 14 December 2020 by BlueMountains (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
LoadPak

Type: Function
Context: Client
Introduced: v1.0

Description

Loads a .pak file.

Syntax

LoadPak(PakName [, RootPath, ContentPath])

Parameters

  • PakName
    The name of the Pak file without extension.
  • RootPath (optional)
    Root name of your content path. For example /TestMod/
  • ContentPath (optional)
    The full path to bind the root path to. For example: ../../../TestProject/Plugins/TestMod/Content/

Since Onset v1.4.0 the RootPath and ContentPath can be omitted. It will be detected automatically.

Return Value

  • Returns true on success. Start the client with the "-dev" parameter switch to enable logging. Useful for errors.

Example

function OnPackageStart()
	local pakname = "TestMod"
	local res = LoadPak(pakname, "/TestMod/", "../../../TestProject/Plugins/TestMod/Content/")
	AddPlayerChat("Loading of "..pakname..": "..tostring(res))

	res = ReplaceObjectModelMesh(42, "/TestMod/SM_Chair")
	AddPlayerChat("ReplaceObjectModelMesh: "..tostring(res))
end
AddEvent("OnPackageStart", OnPackageStart)

See also