DataPacks

2008-03-05T22:49:46Z

DaRk NiGhT: New page: 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 fun...

DataPacks are a way to store and move around various types of data in [[:Category:SourceMod Scripting|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.

=Creating a DataPack=
Creating a DataPack is very simple; all you need is a Handle to write to.
<pawn>new Handle:dataPackHandle = CreateDataPack();</pawn>

For more information on using Handles, see [[Handle API (SourceMod)]].

=DataPack Functions=
On you have created your DataPack, you can use a variety of functions to manage the DataPack.

==WritePackCell==
Syntax:
<pawn>native WritePackCell(Handle:pack, cell);
</pawn>

==WritePackFloat==
This function can be used to write a Float to a DataPack.

Syntax:
<pawn>native WritePackFloat(Handle:pack, Float:val);
</pawn>

==WritePackString==
This function can be used to write a String to a DataPack.

Syntax:
<pawn>native WritePackString(Handle:pack, const String:str[]);
</pawn>

==ReadPackCell==
Syntax:
<pawn>native ReadPackCell(Handle:pack);
</pawn>

==ReadPackFloat==
This function can be used to read a Float from a DataPack.

Syntax:
<pawn>native Float:ReadPackFloat(Handle:pack);
</pawn>

==ReadPackString==
This function can be used to read a String from a DataPack.

Syntax:
<pawn>native ReadPackString(Handle:pack, String:buffer[], maxlen);
</pawn>

==ResetPack==
This function resets your position in the DataPack.

Syntax:
<pawn>native ResetPack(Handle:pack, bool:clear=false);
</pawn>

==GetPackPosition==
This function gets your current position in the DataPack.

Syntax:
<pawn>native GetPackPosition(Handle:pack);
</pawn>

==SetPackPosition==
This function sets your current position in the DataPack.

Syntax:
<pawn>native SetPackPosition(Handle:pack, position);
</pawn>

=Disposing of a DataPack=
To dispose of a DataPack, all you have to do is close its Handle.

Example:
<pawn>CloseHandle(dataPackHandle);
</pawn>

[[Category:SourceMod Scripting]]

AlliedModders Wiki - User contributions [en]

DataPacks