Version: bleeding-edge 🩸

📦 Package

Klasse, die das aktuelle Paket repräsentiert

🗿Static Class

🗿 Static Functions

Returns	Name	Description
	`Export`	Macht jede Variable im globalen Gültigkeitsbereich verfügbar
	`FlushPersistentData`	Schreibt die ausstehenden Änderungen der persistenten Daten sofort auf die Festplatte
string	`GetCompatibilityVersion`	Gibt die Kompatibilitätsversion des Pakets zurück
table of string	`GetDirectories`	Gibt eine Liste aller Verzeichnisse in diesem Paket zurück
table of string	`GetFiles`	Gibt eine Liste aller Dateien in diesem Paket zurück
string	`GetName`	Gibt den Paketnamen/-pfad zurück
table	`GetPersistentData`	Ruft den persistenten Wert von der Festplatte ab
string	`GetTitle`	Gibt den Pakettitel zurück
string	`GetVersion`	Gibt die Paketversion zurück
boolean	`IsUnloading`	Gibt zurück, ob dieses Paket gerade entladen wird
function	`LoadFile`	Kompiliert eine .lua-Datei und gibt eine Funktion zurück, um sie auszuführen
	`ReloadClientFile`	Lädt eine Datei aus dem `Client/`- oder `Shared/`-Ordner neu und sendet die aktualisierte Version an die Clients, wobei das FileReload-Ereignis bei ihnen ausgelöst wird
any	`Require`	Lädt eine .lua-Datei
	`SetPersistentData`	Setzt einen persistenten Wert, der auf der Festplatte gespeichert wird
function	`Subscribe`	Ein Event abonnieren
	`Unsubscribe`	Unsubscribes from all subscribed Events in this Class and in this Package, optionally passing the function to unsubscribe only that callback

Optimal

`Export`

Macht jede Variable im globalen Gültigkeitsbereich verfügbar

Package.Export(variable_name, value)

Parameters

Type	Parameter	Default	Description
string	`variable_name`	Required parameter	Name der zu exportierenden Variable
any	`value`	Required parameter	Wert, der im globalen Gültigkeitsbereich gesetzt werden soll

Slow

`FlushPersistentData`

Schreibt die ausstehenden Änderungen der persistenten Daten sofort auf die Festplatte

Package.FlushPersistentData()

Optimal

`GetCompatibilityVersion`

Gibt die Kompatibilitätsversion des Pakets zurück

local ret = Package.GetCompatibilityVersion()

Returns

Type	Description
string	Die Kompatibilitätsversion des Pakets

Slow

`GetDirectories`

Gibt eine Liste aller Dateien in diesem Paket zurück, optional mit Filtern

local ret = Package.GetDirectories(path_filter?)

Parameters

Type	Parameter	Default	Description
string	`path_filter?`		Path filter

Returns

Type	Description
table of string	List of directories

Slow

`GetFiles`

Gibt eine Liste aller Dateien in diesem Paket zurück, optional mit Filtern

local ret = Package.GetFiles(path_filter?, extension_filter?)

Parameters

Type	Parameter	Default	Description
string or table	`path_filter?`		Path filter
string	`extension_filter?`		Beispiel: `.lua`

Returns

Type	Description
table of string	List of files

Optimal

`GetName`

Gibt den Paketnamen/-pfad zurück

local ret = Package.GetName()

Returns

Type	Description
string	Der Paketname/-pfad

Slow

`GetPersistentData`

Ruft den persistenten Wert von der Festplatte ab

local ret = Package.GetPersistentData(key?)

Parameters

Type	Parameter	Default	Description
string	`key?`		Der Schlüssel, um die Daten abzurufen

Returns

Type	Description
table	Persistente Werte von der Festplatte

`GetTitle`

Gibt den Pakettitel zurück

local ret = Package.GetTitle()

Returns

Type	Description
string	Der Pakettitel

Optimal

`GetVersion`

Gibt die Paketversion zurück

local ret = Package.GetVersion()

Returns

Type	Description
string	Die Paketversion

Optimal

`IsUnloading`

Gibt zurück, ob dieses Paket gerade entladen wird

local ret = Package.IsUnloading()

Returns

Type	Description
boolean	No description provided

Slow

`LoadFile`

Kompiliert eine .lua-Datei und gibt eine Funktion zurück, um sie auszuführen. Verwendet, um Dateien in einer abgesicherten Umgebung zu laden.

Unterstützt die gleichen Searcher wie Package.Require.

local ret = Package.LoadFile(file_path)

Parameters

Type	Parameter	Default	Description
string	`file_path`	Required parameter	Pfad zur zu kompilierenden Skriptdatei

Returns

Type	Description
function	Die kompilierte Funktion zum Ausführen des Skripts, die es dir ermöglicht, eine Umgebungs-Tabelle (env) für das Skript zu übergeben with this format

Package.LoadFile Examples

Loading a .lua file sandboxed
local func = Package.LoadFile("MyScript.lua")

-- Only allows this file to access Console
local my_env = { Console = Console }

local content = func(my_env)

-- Access all global variables set by the script in my_env
my_env.GlobalVariableFromFile...

`ReloadClientFile`

Lädt eine Datei aus dem Client/- oder Shared/-Ordner neu und sendet die aktualisierte Version an die Clients, wobei das FileReload-Ereignis bei ihnen ausgelöst wird.

Die neu geladene Datei wird zwischengespeichert und von neuen verbindenden Clients normal heruntergeladen.

Beachte, dass diese Methode den Hauptnetzwerklane verwendet. Daher wird sie in Produktionsumgebungen nicht für häufige oder große Dateien empfohlen, da sie Netzwerküberlastung und Lags verursachen kann. Sie ist hauptsächlich für Entwicklungszwecke gedacht, um eine schnellere Iteration an Client-Dateien zu ermöglichen, ohne das gesamte Paket neu laden zu müssen.

Package.ReloadClientFile(file_path)

Parameters

Type	Parameter	Default	Description
string	`file_path`	Required parameter	Der Dateipfad relativ zum Paketstamm

`Require`

Lädt eine .lua-Datei. Beachte, dass diese Methode das Ergebnis zwischenspeichert, sodass weitere Aufrufe den zwischengespeicherten Wert zurückgeben.

Wir unterstützen derzeit 5 Searcher, die in folgender Reihenfolge durchsucht werden:
Relativ zu aktuellem-Dateipfad/
Relativ zu aktuellem-Paket/Client/ oder aktuellem-Paket/Server/ (je nach deiner Seite)
Relativ zu aktuellem-Paket/Shared/
Relativ zu aktuellem-Paket/
Relativ zu Packages/
Hinweis: Clients laden nur Ordner Client/ und Shared/ herunter und haben nur Zugriff darauf.

local ret = Package.Require(file_path, force_load?)

Parameters

Type	Parameter	Default	Description
string	`file_path`	Required parameter	Pfad zur zu ladenden Skriptdatei
boolean	`force_load?`	`false`	Ob das Laden dieser Datei erzwungen werden soll, auch wenn sie bereits geladen wurde

Returns

Type	Description
any	Beliebige Rückgabewerte der eingebundenen Datei

`SetPersistentData`

Setzt einen persistenten Wert, der auf der Festplatte gespeichert wird. Beachte, dass der tatsächliche Schreibvorgang auf die Festplatte verzögert erfolgt und möglicherweise nicht sofort geschieht.

Package.SetPersistentData(key, value)

Parameters

Type	Parameter	Default	Description
string	`key`	Required parameter	Schlüssel, um Daten zu indizieren. Er kann durch '.' getrennt werden, um ein untergeordnetes Element zu setzen.
any	`value`	Required parameter	Wert, der unter dem Schlüssel gesetzt werden soll

`Subscribe`

Ein Event abonnieren

local ret = Package.Subscribe(event_name, callback)

Parameters

Type	Parameter	Default	Description
string	`event_name`	Required parameter	Event, das abonniert werden soll
function	`callback`	Required parameter	Callback, der beim Auftreten des Events ausgeführt werden soll

Returns

Type	Description
function	Die Callback-Funktion

Optimal

`Unsubscribe`

Unsubscribes from all subscribed Events in this Class and in this Package, optionally passing the function to unsubscribe only that callback

Package.Unsubscribe(event_name, callback?)

Parameters

Type	Parameter	Default	Description
string	`event_name`	Required parameter	Event, das deabonniert werden soll
function	`callback?`	`nil`	Optionaler Callback, der spezifisch deabonniert werden soll

🚀 Events

	Name	Description
	`FileReload`	Wird aufgerufen, wenn eine Datei direkt vom Server über Package.ReloadClientFile() neu geladen wird
	`Load`	Wird aufgerufen, wenn dieses Paket geladen wird
	`Unload`	Wird aufgerufen, wenn dieses Paket entladen wird

`FileReload`

Wird aufgerufen, wenn eine Datei direkt vom Server über Package.ReloadClientFile() neu geladen wird.

Du kannst den Pfad verwenden, um die Datei zur Laufzeit mit Package.Require(path, true) neu zu laden

Package.Subscribe("FileReload", function(file_path)
	-- FileReload was called
end)

Arguments

Type	Argument	Description
string	`file_path`	Der Dateipfad

`Load`

Wird aufgerufen, wenn dieses Paket geladen wird.

Dieses Event wird je nach Situation unterschiedlich ausgelöst:
Wenn der Server startet oder du package reload all ausführst, wird das Event erst ausgelöst, nachdem ALLE Pakete geladen wurden.
In allen anderen Fällen (package load/reload oder Package.Load/Reload) wird das Event sofort nach dem Laden/Neuladen des Pakets ausgelöst.

Package.Subscribe("Load", function()
	-- Load was called
end)

`Unload`

Wird aufgerufen, wenn dieses Paket entladen wird

Package.Subscribe("Unload", function()
	-- Unload was called
end)

🗿 Static Functions​

Export​

Parameters

FlushPersistentData​

GetCompatibilityVersion​

Returns

GetDirectories​

Parameters

Returns

GetFiles​

Parameters

Returns

GetName​

Returns

GetPersistentData​

Parameters

Returns

GetTitle​

Returns

GetVersion​

Returns

IsUnloading​

Returns

LoadFile​

Parameters

Returns

ReloadClientFile​

Parameters

Require​

Parameters

Returns

SetPersistentData​

Parameters

Subscribe​

Parameters

Returns

Unsubscribe​

Parameters

🚀 Events​

FileReload​

Arguments

Load​

Unload​

🗿 Static Functions

`Export`

`FlushPersistentData`

`GetCompatibilityVersion`

`GetDirectories`

`GetFiles`

`GetName`

`GetPersistentData`

`GetTitle`

`GetVersion`

`IsUnloading`

`LoadFile`

`ReloadClientFile`

`Require`

`SetPersistentData`

`Subscribe`

`Unsubscribe`

🚀 Events

`FileReload`

`Load`

`Unload`