DataPacks
From AMWiki
DataPacks are a way to store and move around various types of data in SourceMod Scripting. Since some things are not possible in SourcePawn, such as a function consuming a String, DataPacks help us get these Strings and other items where they need to go.
Contents |
[edit] Creating a DataPack
Creating a DataPack is very simple; all you need is a Handle to write to.
new Handle:dataPackHandle = CreateDataPack();
For more information on using Handles, see Handle API (SourceMod).
[edit] DataPack Functions
On you have created your DataPack, you can use a variety of functions to manage the DataPack.
[edit] WritePackCell
Syntax:
native WritePackCell(Handle:pack, cell);
[edit] WritePackFloat
This function can be used to write a Float to a DataPack.
Syntax:
native WritePackFloat(Handle:pack, Float:val);
[edit] WritePackString
This function can be used to write a String to a DataPack.
Syntax:
native WritePackString(Handle:pack, const String:str[]);
[edit] ReadPackCell
Syntax:
native ReadPackCell(Handle:pack);
[edit] ReadPackFloat
This function can be used to read a Float from a DataPack.
Syntax:
native Float:ReadPackFloat(Handle:pack);
[edit] ReadPackString
This function can be used to read a String from a DataPack.
Syntax:
native ReadPackString(Handle:pack, String:buffer[], maxlen);
[edit] ResetPack
This function resets your position in the DataPack.
Syntax:
native ResetPack(Handle:pack, bool:clear=false);
[edit] GetPackPosition
This function gets your current position in the DataPack.
Syntax:
native GetPackPosition(Handle:pack);
[edit] SetPackPosition
This function sets your current position in the DataPack.
Syntax:
native SetPackPosition(Handle:pack, position);
[edit] Disposing of a DataPack
To dispose of a DataPack, all you have to do is close its Handle.
Example:
CloseHandle(dataPackHandle);
