Multi Theft Auto: Wiki - User contributions [en]

HeroInventory

2013-02-05T21:44:32Z

Malicious Hero:

==Description==
HeroInventory is a new way to expand a roleplay server's features. This resource allows a server to not only archive items; but organize them appropriately! Adding items, and groups are very simple.

community page link[http://community.mtasa.com/index.php?p=resources&s=details&id=6310]

==Notes==
You're able to add items by editing g_items.lua.

==Callbacks==
===onPlayerUseItem===
<syntaxhighlight lang="lua">
bool onPlayerUseItem( int itemID, int itemAmount )
</syntaxhighlight>

* source = player using the item

The callback is found in e_item_use.lua in the folder "events". Examples are shown.

===onPlayerPickupItem===
<syntaxhighlight lang="lua">
bool onPlayerPickupItem( element playerElement, int itemID, string itemDroppedBy )
</syntaxhighlight>

The callback is found in e_item_pickup.lua in the folder "events". Examples are shown.
==Player Functions==
===addPlayerItem===
<syntaxhighlight lang="lua">
bool addPlayerItem ( element playerElement, int itemID, int amount )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
addPlayerItem
@author
Malicious Hero.
@parameters
playerElement - The element you wish to add an item to.
itemID - The item ID; This can be found in g_items.lua.
amount - The amount of the item you want.
@description
This will add an item to a client.
</syntaxhighlight>
===refreshClientGroups===
<syntaxhighlight lang="lua">
bool refreshClientGroups( )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
refreshClientGroups
@author
Malicious Hero.
@parameters

@description
This is not really a function used when exporting; but it's important this command remains
in this resource because without this, groups would not be sync properly.
</syntaxhighlight>

===removeItemFromPlayer===
<syntaxhighlight lang="lua">
bool removeItemFromPlayer( element playerElement, int itemID, [ int amount ] )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
removeItemFromPlayer
@author
Malicious Hero.
@parameters
playerElement - The player.
itemID - The item ID
amount - The amount you wish to remove. You can leave this blank to remove everything.
@description
Use this function to remove an item from a player.
</syntaxhighlight>

===transferPlayerItem===
<syntaxhighlight lang="lua">
bool transferPlayerItem( element playerElement, element targetElement, int itemID, int amount )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
transferPlayerItem
@author
Malicious Hero.
@parameters
playerElement - The player.
targetElement - The target.
itemID - The item ID
amount - The amount you wish to remove. You can leave this blank to remove everything.
@description
Use this function to move one item to another player.
</syntaxhighlight>

===doesPlayerHaveItem===
<syntaxhighlight lang="lua">
bool doesPlayerHaveItem( element playerElement, int itemID)
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
doesPlayerHaveItem
@author
Malicious Hero.
@parameters
playerElement - The player.
itemID - The item ID
@description
Use this function to move one item to another player.
@returns
if returning true, it will return the amount as well.
</syntaxhighlight>

===getPlayerItemAmount===
<syntaxhighlight lang="lua">
bool getPlayerItemAmount( element playerElement, int itemID )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
getPlayerItemAmount
@author
Malicious Hero.
@parameters
playerElement - The player.
itemID - The item ID
@description
Use this function to get a player's item amount
@returns
The amount item. If false, they don't have the item
</syntaxhighlight>
==Group Functions==
===addInventoryGroup===
<syntaxhighlight lang="lua">
bool addInventoryGroup( string group_name, path imagesrc )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
addInventoryGroup
@author
Malicious Hero.
@parameters
group_name - Indicates the group name that you wish to add.
imagesrc - The picture you want to associate with the group.
@description
This will add a inventory group, which will allow the server to create new items.
Please keep in mind that in s_inventory_config.lua, you are able to set the maximum amount
of groups you allow.
</syntaxhighlight>

===removeInventoryGroup===
<syntaxhighlight lang="lua">
bool removeInventoryGroup( string group_name )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
removeInventoryGroup
@author
Malicious Hero.
@parameters
group_name - Indicates the group name that you wish to add.
@description
This will remove an inventory group.
</syntaxhighlight>

HeroInventory

2013-02-05T21:44:17Z

Malicious Hero:

==Description==
HeroInventory is a new way to expand a roleplay server's features. This resource allows a server to not only archive items; but organize them appropriately! Adding items, and groups are very simple.

community page link[http://community.mtasa.com/index.php?p=resources&s=details&id=6310]

==Notes==
You're able to add items by editing g_items.lua.

==Callbacks==
===onPlayerUseItem===
<syntaxhighlight lang="lua">
bool onPlayerUseItem( int itemID, int itemAmount )
</syntaxhighlight>

* source = player using the item

The callback is found in e_item_use.lua in the folder "events". Examples are shown.

===onPlayerUseItem===
<syntaxhighlight lang="lua">
bool onPlayerPickupItem( element playerElement, int itemID, string itemDroppedBy )
</syntaxhighlight>

The callback is found in e_item_pickup.lua in the folder "events". Examples are shown.
==Player Functions==
===addPlayerItem===
<syntaxhighlight lang="lua">
bool addPlayerItem ( element playerElement, int itemID, int amount )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
addPlayerItem
@author
Malicious Hero.
@parameters
playerElement - The element you wish to add an item to.
itemID - The item ID; This can be found in g_items.lua.
amount - The amount of the item you want.
@description
This will add an item to a client.
</syntaxhighlight>
===refreshClientGroups===
<syntaxhighlight lang="lua">
bool refreshClientGroups( )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
refreshClientGroups
@author
Malicious Hero.
@parameters

@description
This is not really a function used when exporting; but it's important this command remains
in this resource because without this, groups would not be sync properly.
</syntaxhighlight>

===removeItemFromPlayer===
<syntaxhighlight lang="lua">
bool removeItemFromPlayer( element playerElement, int itemID, [ int amount ] )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
removeItemFromPlayer
@author
Malicious Hero.
@parameters
playerElement - The player.
itemID - The item ID
amount - The amount you wish to remove. You can leave this blank to remove everything.
@description
Use this function to remove an item from a player.
</syntaxhighlight>

===transferPlayerItem===
<syntaxhighlight lang="lua">
bool transferPlayerItem( element playerElement, element targetElement, int itemID, int amount )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
transferPlayerItem
@author
Malicious Hero.
@parameters
playerElement - The player.
targetElement - The target.
itemID - The item ID
amount - The amount you wish to remove. You can leave this blank to remove everything.
@description
Use this function to move one item to another player.
</syntaxhighlight>

===doesPlayerHaveItem===
<syntaxhighlight lang="lua">
bool doesPlayerHaveItem( element playerElement, int itemID)
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
doesPlayerHaveItem
@author
Malicious Hero.
@parameters
playerElement - The player.
itemID - The item ID
@description
Use this function to move one item to another player.
@returns
if returning true, it will return the amount as well.
</syntaxhighlight>

===getPlayerItemAmount===
<syntaxhighlight lang="lua">
bool getPlayerItemAmount( element playerElement, int itemID )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
getPlayerItemAmount
@author
Malicious Hero.
@parameters
playerElement - The player.
itemID - The item ID
@description
Use this function to get a player's item amount
@returns
The amount item. If false, they don't have the item
</syntaxhighlight>
==Group Functions==
===addInventoryGroup===
<syntaxhighlight lang="lua">
bool addInventoryGroup( string group_name, path imagesrc )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
addInventoryGroup
@author
Malicious Hero.
@parameters
group_name - Indicates the group name that you wish to add.
imagesrc - The picture you want to associate with the group.
@description
This will add a inventory group, which will allow the server to create new items.
Please keep in mind that in s_inventory_config.lua, you are able to set the maximum amount
of groups you allow.
</syntaxhighlight>

===removeInventoryGroup===
<syntaxhighlight lang="lua">
bool removeInventoryGroup( string group_name )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
removeInventoryGroup
@author
Malicious Hero.
@parameters
group_name - Indicates the group name that you wish to add.
@description
This will remove an inventory group.
</syntaxhighlight>

HeroBook

2013-01-21T13:47:49Z

Malicious Hero:

==Description==
It's hell of a lot of work to build tons of GUIs for police manuals or other books on servers. HeroBook is a system that allows ANY user to create a book or a novel rather. The server controls who is able to write a book through exported functions, and the server controls who is able to read what book. Check out HeroInventory, you will be able to integrate this book system into HeroInventory for smoother usage.

==Integrate Into HeroInventory==
More information on HeroInventory can be found here: http://wiki.multitheftauto.com/wiki/HeroInventory

*'''Download an image that will suit the book you're trying to integrate.'''
*'''Add this image into meta.xml'''
<syntaxhighlight lang="lua">
<file src="images/items/BookImageName.png" />
</syntaxhighlight>
*'''Add a new items into 'g_items.lua'''' Below is simply an example.
<syntaxhighlight lang="lua">
{"images/items/BookImageName.png", "LSPD Book", "Books"} -- ITEM ID: 2
</syntaxhighlight>
It should look somewhat like this:
<syntaxhighlight lang="lua">
itemArchive = -- {picture, name, group_name}
{
{"images/items/Hat.png", "Hat", "Clothes"}, -- ITEM ID: 1 - This is an example.
{"images/items/BookImageName.png", "LSPD Book", "Books"} -- ITEM ID: 2
}</syntaxhighlight>
*'''In server/s_item_use.lua, you can now create a reaction to clicking on the book.'''
<syntaxhighlight lang="lua">
if itemID == 2 then
exports["hero-book"]:showClientBook( source, 1 )
end
</syntaxhighlight>
The code above simply shows a created book (Book ID #1). In this example, book ID #1 is a LSPD Book. The client should now be reading the LSPD book.

==Functions==
===deleteBook===
<syntaxhighlight lang="lua">
nil deleteAllBooks( )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
deleteAllBooks
@author
Malicious Hero.
@parameters

@description
This will delete all books.
</syntaxhighlight>
===deleteBook===
<syntaxhighlight lang="lua">
nil deleteBook( int book_id )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
deleteBook
@author
Malicious Hero.
@parameters
book_id - The book's ID.
@description
This will delete a book.
</syntaxhighlight>
===addBook===
<syntaxhighlight lang="lua">
nil addBook( string title, element authorElement, table content )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
addBook
@author
Malicious Hero.
@parameters
title - The title of the book.
authorElement - Not the author's name. The actual element of the player.
content - The content of the book; Which is stored in a table for page reasons.
@description
This will add a book to the SQL database.
</syntaxhighlight>
===updateBook===
<syntaxhighlight lang="lua">
nil updateBook( int book_id, table tableData)
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
updateBook
@author
Malicious Hero.
@parameters
book_id - The book's ID.
tableData - The data of the book. View getBookData for more information.
@description
This will save book data into the SQL database.
</syntaxhighlight>
===getBookData===
<syntaxhighlight lang="lua">
table getBookData( int book_id, string highlight )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
getBookData
@author
Malicious Hero.
@parameters
book_id - The book's ID.
highlight - Searches only one specific piece of the book data.
@description
This will fetch data for a book into table data. Use the SQL
field names as reference for variables.
</syntaxhighlight>
==Player Usage Functions==
===showClientBook===
<syntaxhighlight lang="lua">
nil showClientBook( element playerElement, int book_id )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
showClientBook
@author
Malicious Hero.
@parameters
playerElement - The element you want to edit the book.
book_id - The book's ID.
@description
This will make a client read a book.
</syntaxhighlight>

===clientEditBook===
<syntaxhighlight lang="lua">
nil clientEditBook( element playerElement, int book_id )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
clientEditBook
@author
Malicious Hero.
@parameters
playerElement - The element you want to edit the book.
book_id - The book's ID.
@description
This will make a client edit a book.
</syntaxhighlight>

HeroBook

2013-01-21T13:47:25Z

Malicious Hero:

==Description==
It's hell of a lot of work to build tons of GUIs for police manuals or other books on servers. HeroBook is a system that allows ANY user to create a book or a novel rather. The server controls who is able to write a book through exported functions, and the server controls who is able to read what book. Check out HeroInventory, you will be able to integrate this book system into HeroInventory for smoother usage.

==Integrate Into HeroInventory==
More information on HeroInventory can be found here: http://wiki.multitheftauto.com/wiki/HeroInventory

*'''Download an image that will suit the book you're trying to integrate.'''
*'''Add this image into meta.xml'''
<syntaxhighlight lang="lua">
<file src="images/items/BookImageName.png" />
</syntaxhighlight>
*'''Add a new items into 'g_items.lua'''' Below is simply an example.
<syntaxhighlight lang="lua">
{"images/items/BookImageName.png", "LSPD Book", "Books"} -- ITEM ID: 2
</syntaxhighlight>
It should look somewhat like this:
<syntaxhighlight lang="lua">
itemArchive = -- {picture, name, group_name}
{
{"images/items/Hat.png", "Hat", "Clothes"}, -- ITEM ID: 1 - This is an example.
{"images/items/BookImageName.png", "LSPD Book", "Books"} -- ITEM ID: 2
}</syntaxhighlight>
*'''In server/s_item_use.lua, you can now create a reaction to clicking on the book.'''
<syntaxhighlight lang="lua">
if itemID == 2 then
exports["hero-book"]:showClientBook( source, 1 )
end
</syntaxhighlight>
The code above simply shows a created book (Book ID #1). In this example, book ID #1 is a LSPD Book. The client should now be reading the LSPD book.

==Functions==
===deleteBook===
<syntaxhighlight lang="lua">
nil deleteAllBooks( )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
deleteAllBooks
@author
Malicious Hero.
@parameters

@description
This will delete all books.
</syntaxhighlight>
===deleteBook===
<syntaxhighlight lang="lua">
nil deleteBook( int book_id )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
deleteBook
@author
Malicious Hero.
@parameters
book_id - The book's ID.
@description
This will delete a book.
</syntaxhighlight>
===addBook===
<syntaxhighlight lang="lua">
nil addBook( string title, element authorElement, table content )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
addBook
@author
Malicious Hero.
@parameters
title - The title of the book.
authorElement - Not the author's name. The actual element of the player.
content - The content of the book; Which is stored in a table for page reasons.
@description
This will add a book to the SQL database.
</syntaxhighlight>
===updateBook===
<syntaxhighlight lang="lua">
nil updateBook( int book_id, table tableData)
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
updateBook
@author
Malicious Hero.
@parameters
book_id - The book's ID.
tableData - The data of the book. View getBookData for more information.
@description
This will save book data into the SQL database.
</syntaxhighlight>
===getBookData===
<syntaxhighlight lang="lua">
table getBookData( int book_id, string highlight )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
getBookData
@author
Malicious Hero.
@parameters
book_id - The book's ID.
highlight - Searches only one specific piece of the book data.
@description
This will fetch data for a book into table data. Use the SQL
field names as reference for variables.
</syntaxhighlight>
==Client Functions==
===showClientBook===
<syntaxhighlight lang="lua">
nil showClientBook( element playerElement, int book_id )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
showClientBook
@author
Malicious Hero.
@parameters
playerElement - The element you want to edit the book.
book_id - The book's ID.
@description
This will make a client read a book.
</syntaxhighlight>

===clientEditBook===
<syntaxhighlight lang="lua">
nil clientEditBook( element playerElement, int book_id )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
clientEditBook
@author
Malicious Hero.
@parameters
playerElement - The element you want to edit the book.
book_id - The book's ID.
@description
This will make a client edit a book.
</syntaxhighlight>

HeroBook

2013-01-21T02:00:09Z

Malicious Hero: Created page with "==Description== It's hell of a lot of work to build tons of GUIs for police manuals or other books on servers. HeroBook is a system that allows ANY user to create a book or a nov..."

==Description==
It's hell of a lot of work to build tons of GUIs for police manuals or other books on servers. HeroBook is a system that allows ANY user to create a book or a novel rather. The server controls who is able to write a book through exported functions, and the server controls who is able to read what book. Check out HeroInventory, you will be able to integrate this book system into HeroInventory for smoother usage.

==Integrate Into HeroInventory==
More information on HeroInventory can be found here: http://wiki.multitheftauto.com/wiki/HeroInventory

*'''Download an image that will suit the book you're trying to integrate.'''
*'''Add this image into meta.xml'''
<syntaxhighlight lang="lua">
<file src="images/items/BookImageName.png" />
</syntaxhighlight>
*'''Add a new items into 'g_items.lua'''' Below is simply an example.
<syntaxhighlight lang="lua">
{"images/items/BookImageName.png", "LSPD Book", "Books"} -- ITEM ID: 2
</syntaxhighlight>
It should look somewhat like this:
<syntaxhighlight lang="lua">
itemArchive = -- {picture, name, group_name}
{
{"images/items/Hat.png", "Hat", "Clothes"}, -- ITEM ID: 1 - This is an example.
{"images/items/BookImageName.png", "LSPD Book", "Books"} -- ITEM ID: 2
}</syntaxhighlight>
*'''In server/s_item_use.lua, you can now create a reaction to clicking on the book.'''
<syntaxhighlight lang="lua">
if itemID == 2 then
exports["hero-book"]:showClientBook( source, 1 )
end
</syntaxhighlight>
The code above simply shows a created book (Book ID #1). In this example, book ID #1 is a LSPD Book. The client should now be reading the LSPD book.

==Functions==
===deleteBook===
<syntaxhighlight lang="lua">
nil deleteAllBooks( )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
deleteAllBooks
@author
Malicious Hero.
@parameters

@description
This will delete all books.
</syntaxhighlight>
===deleteBook===
<syntaxhighlight lang="lua">
nil deleteBook( int book_id )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
deleteBook
@author
Malicious Hero.
@parameters
book_id - The book's ID.
@description
This will delete a book.
</syntaxhighlight>
===addBook===
<syntaxhighlight lang="lua">
nil addBook( string title, element authorElement, table content )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
addBook
@author
Malicious Hero.
@parameters
title - The title of the book.
authorElement - Not the author's name. The actual element of the player.
content - The content of the book; Which is stored in a table for page reasons.
@description
This will add a book to the SQL database.
</syntaxhighlight>
===updateBook===
<syntaxhighlight lang="lua">
nil updateBook( int book_id, table tableData)
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
updateBook
@author
Malicious Hero.
@parameters
book_id - The book's ID.
tableData - The data of the book. View getBookData for more information.
@description
This will save book data into the SQL database.
</syntaxhighlight>
===getBookData===
<syntaxhighlight lang="lua">
table getBookData( int book_id, string highlight )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
getBookData
@author
Malicious Hero.
@parameters
book_id - The book's ID.
highlight - Searches only one specific piece of the book data.
@description
This will fetch data for a book into table data. Use the SQL
field names as reference for variables.
</syntaxhighlight>

===showClientBook===
<syntaxhighlight lang="lua">
nil showClientBook( element playerElement, int book_id )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
showClientBook
@author
Malicious Hero.
@parameters
playerElement - The element you want to edit the book.
book_id - The book's ID.
@description
This will make a client read a book.
</syntaxhighlight>

===clientEditBook===
<syntaxhighlight lang="lua">
nil clientEditBook( element playerElement, int book_id )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
clientEditBook
@author
Malicious Hero.
@parameters
playerElement - The element you want to edit the book.
book_id - The book's ID.
@description
This will make a client edit a book.
</syntaxhighlight>

HeroInventory

2013-01-13T23:19:11Z

Malicious Hero:

==Description==
HeroInventory is a new way to expand a roleplay server's features. This resource allows a server to not only archive items; but organize them appropriately! Adding items, and groups are very simple.

==Notes==
You're able to add items by editing g_items.lua.

==Callbacks==
===onPlayerUseItem===
<syntaxhighlight lang="lua">
bool onPlayerUseItem( int itemID, int itemAmount )
</syntaxhighlight>

* source = player using the item

The callback is found in s_item_use.lua in the folder "server". Examples are shown.
==Player Functions==
===addPlayerItem===
<syntaxhighlight lang="lua">
bool addPlayerItem ( element playerElement, int itemID, int amount )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
addPlayerItem
@author
Malicious Hero.
@parameters
playerElement - The element you wish to add an item to.
itemID - The item ID; This can be found in g_items.lua.
amount - The amount of the item you want.
@description
This will add an item to a client.
</syntaxhighlight>
===refreshClientGroups===
<syntaxhighlight lang="lua">
bool refreshClientGroups( )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
refreshClientGroups
@author
Malicious Hero.
@parameters

@description
This is not really a function used when exporting; but it's important this command remains
in this resource because without this, groups would not be sync properly.
</syntaxhighlight>

===removeItemFromPlayer===
<syntaxhighlight lang="lua">
bool removeItemFromPlayer( element playerElement, int itemID, [ int amount ] )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
removeItemFromPlayer
@author
Malicious Hero.
@parameters
playerElement - The player.
itemID - The item ID
amount - The amount you wish to remove. You can leave this blank to remove everything.
@description
Use this function to remove an item from a player.
</syntaxhighlight>

===transferPlayerItem===
<syntaxhighlight lang="lua">
bool transferPlayerItem( element playerElement, element targetElement, int itemID, int amount )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
transferPlayerItem
@author
Malicious Hero.
@parameters
playerElement - The player.
targetElement - The target.
itemID - The item ID
amount - The amount you wish to remove. You can leave this blank to remove everything.
@description
Use this function to move one item to another player.
</syntaxhighlight>

===doesPlayerHaveItem===
<syntaxhighlight lang="lua">
bool doesPlayerHaveItem( element playerElement, int itemID)
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
doesPlayerHaveItem
@author
Malicious Hero.
@parameters
playerElement - The player.
itemID - The item ID
@description
Use this function to move one item to another player.
@returns
if returning true, it will return the amount as well.
</syntaxhighlight>

===getPlayerItemAmount===
<syntaxhighlight lang="lua">
bool getPlayerItemAmount( element playerElement, int itemID )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
getPlayerItemAmount
@author
Malicious Hero.
@parameters
playerElement - The player.
itemID - The item ID
@description
Use this function to get a player's item amount
@returns
The amount item. If false, they don't have the item
</syntaxhighlight>
==Group Functions==
===addInventoryGroup===
<syntaxhighlight lang="lua">
bool addInventoryGroup( string group_name, path imagesrc )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
addInventoryGroup
@author
Malicious Hero.
@parameters
group_name - Indicates the group name that you wish to add.
imagesrc - The picture you want to associate with the group.
@description
This will add a inventory group, which will allow the server to create new items.
Please keep in mind that in s_inventory_config.lua, you are able to set the maximum amount
of groups you allow.
</syntaxhighlight>

===removeInventoryGroup===
<syntaxhighlight lang="lua">
bool removeInventoryGroup( string group_name )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
removeInventoryGroup
@author
Malicious Hero.
@parameters
group_name - Indicates the group name that you wish to add.
@description
This will remove an inventory group.
</syntaxhighlight>

HeroInventory

2013-01-13T20:57:08Z

Malicious Hero:

==Description==
HeroInventory is a new way to expand a roleplay server's features. This resource allows a server to not only archive items; but organize them appropriately! Adding items, and groups are very simple.

==Callbacks==
===onPlayerUseItem===
<syntaxhighlight lang="lua">
bool onPlayerUseItem( int itemID, int itemAmount )
</syntaxhighlight>

* source = player using the item

The callback is found in s_item_use.lua in the folder "server". Examples are shown.
==Player Functions==
===addPlayerItem===
<syntaxhighlight lang="lua">
bool addPlayerItem ( element playerElement, int itemID, int amount )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
addPlayerItem
@author
Malicious Hero.
@parameters
playerElement - The element you wish to add an item to.
itemID - The item ID; This can be found in g_items.lua.
amount - The amount of the item you want.
@description
This will add an item to a client.
</syntaxhighlight>
===refreshClientGroups===
<syntaxhighlight lang="lua">
bool refreshClientGroups( )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
refreshClientGroups
@author
Malicious Hero.
@parameters

@description
This is not really a function used when exporting; but it's important this command remains
in this resource because without this, groups would not be sync properly.
</syntaxhighlight>

===removeItemFromPlayer===
<syntaxhighlight lang="lua">
bool removeItemFromPlayer( element playerElement, int itemID, [ int amount ] )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
removeItemFromPlayer
@author
Malicious Hero.
@parameters
playerElement - The player.
itemID - The item ID
amount - The amount you wish to remove. You can leave this blank to remove everything.
@description
Use this function to remove an item from a player.
</syntaxhighlight>

===transferPlayerItem===
<syntaxhighlight lang="lua">
bool transferPlayerItem( element playerElement, element targetElement, int itemID, int amount )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
transferPlayerItem
@author
Malicious Hero.
@parameters
playerElement - The player.
targetElement - The target.
itemID - The item ID
amount - The amount you wish to remove. You can leave this blank to remove everything.
@description
Use this function to move one item to another player.
</syntaxhighlight>

===doesPlayerHaveItem===
<syntaxhighlight lang="lua">
bool doesPlayerHaveItem( element playerElement, int itemID)
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
doesPlayerHaveItem
@author
Malicious Hero.
@parameters
playerElement - The player.
itemID - The item ID
@description
Use this function to move one item to another player.
@returns
if returning true, it will return the amount as well.
</syntaxhighlight>

===getPlayerItemAmount===
<syntaxhighlight lang="lua">
bool getPlayerItemAmount( element playerElement, int itemID )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
getPlayerItemAmount
@author
Malicious Hero.
@parameters
playerElement - The player.
itemID - The item ID
@description
Use this function to get a player's item amount
@returns
The amount item. If false, they don't have the item
</syntaxhighlight>
==Group Functions==
===addInventoryGroup===
<syntaxhighlight lang="lua">
bool addInventoryGroup( string group_name, path imagesrc )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
addInventoryGroup
@author
Malicious Hero.
@parameters
group_name - Indicates the group name that you wish to add.
imagesrc - The picture you want to associate with the group.
@description
This will add a inventory group, which will allow the server to create new items.
Please keep in mind that in s_inventory_config.lua, you are able to set the maximum amount
of groups you allow.
</syntaxhighlight>

===removeInventoryGroup===
<syntaxhighlight lang="lua">
bool removeInventoryGroup( string group_name )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
removeInventoryGroup
@author
Malicious Hero.
@parameters
group_name - Indicates the group name that you wish to add.
@description
This will remove an inventory group.
</syntaxhighlight>

HeroInventory

2013-01-13T20:51:53Z

Malicious Hero:

==Description==
HeroInventory is a new way to expand a roleplay server's features. This resource allows a server to not only archive items; but organize them appropriately! Adding items, and groups are very simple.

==Player Functions==
===addPlayerItem===
<syntaxhighlight lang="lua">
bool addPlayerItem ( element playerElement, int itemID, int amount )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
addPlayerItem
@author
Malicious Hero.
@parameters
playerElement - The element you wish to add an item to.
itemID - The item ID; This can be found in g_items.lua.
amount - The amount of the item you want.
@description
This will add an item to a client.
</syntaxhighlight>
===refreshClientGroups===
<syntaxhighlight lang="lua">
bool refreshClientGroups( )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
refreshClientGroups
@author
Malicious Hero.
@parameters

@description
This is not really a function used when exporting; but it's important this command remains
in this resource because without this, groups would not be sync properly.
</syntaxhighlight>

===removeItemFromPlayer===
<syntaxhighlight lang="lua">
bool removeItemFromPlayer( element playerElement, int itemID, [ int amount ] )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
removeItemFromPlayer
@author
Malicious Hero.
@parameters
playerElement - The player.
itemID - The item ID
amount - The amount you wish to remove. You can leave this blank to remove everything.
@description
Use this function to remove an item from a player.
</syntaxhighlight>

===transferPlayerItem===
<syntaxhighlight lang="lua">
bool transferPlayerItem( element playerElement, element targetElement, int itemID, int amount )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
transferPlayerItem
@author
Malicious Hero.
@parameters
playerElement - The player.
targetElement - The target.
itemID - The item ID
amount - The amount you wish to remove. You can leave this blank to remove everything.
@description
Use this function to move one item to another player.
</syntaxhighlight>

===doesPlayerHaveItem===
<syntaxhighlight lang="lua">
bool doesPlayerHaveItem( element playerElement, int itemID)
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
doesPlayerHaveItem
@author
Malicious Hero.
@parameters
playerElement - The player.
itemID - The item ID
@description
Use this function to move one item to another player.
@returns
if returning true, it will return the amount as well.
</syntaxhighlight>

===getPlayerItemAmount===
<syntaxhighlight lang="lua">
bool getPlayerItemAmount( element playerElement, int itemID )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
getPlayerItemAmount
@author
Malicious Hero.
@parameters
playerElement - The player.
itemID - The item ID
@description
Use this function to get a player's item amount
@returns
The amount item. If false, they don't have the item
</syntaxhighlight>
==Group Functions==
===addInventoryGroup===
<syntaxhighlight lang="lua">
bool addInventoryGroup( string group_name, path imagesrc )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
addInventoryGroup
@author
Malicious Hero.
@parameters
group_name - Indicates the group name that you wish to add.
imagesrc - The picture you want to associate with the group.
@description
This will add a inventory group, which will allow the server to create new items.
Please keep in mind that in s_inventory_config.lua, you are able to set the maximum amount
of groups you allow.
</syntaxhighlight>

===removeInventoryGroup===
<syntaxhighlight lang="lua">
bool removeInventoryGroup( string group_name )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
removeInventoryGroup
@author
Malicious Hero.
@parameters
group_name - Indicates the group name that you wish to add.
@description
This will remove an inventory group.
</syntaxhighlight>

HeroInventory

2013-01-13T20:43:05Z

Malicious Hero:

==Description==
HeroInventory is a new way to expand a roleplay server's features. This resource allows a server to not only archive items; but organize them appropriately! Adding items, and groups are very simple.

==Functions==
===addPlayerItem===
<syntaxhighlight lang="lua">
bool addPlayerItem ( element playerElement, int itemID, int amount )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
addPlayerItem
@author
Malicious Hero.
@parameters
playerElement - The element you wish to add an item to.
itemID - The item ID; This can be found in g_items.lua.
amount - The amount of the item you want.
@description
This will add an item to a client.
</syntaxhighlight>

HeroInventory

2013-01-13T20:42:45Z

Malicious Hero:

==Description==
HeroInventory is a new way to expand a roleplay server's features. This resource allows a server to not only archive items; but organize them appropriately! Adding items, and groups are very simple.

==Functions==
===addPlayerItem===
<syntaxhighlight lang="lua">
bool addPlayerItem ( element playerElement, int itemID, int amount )
</syntaxhighlight>
<syntaxhighlight lang="lua">
@title
addPlayerItem
@author
Malicious Hero.
@parameters
playerElement - The element you wish to add an item to.
itemID - The item ID; This can be found in g_items.lua.
amount - The amount of the item you want.
@description
This will add an item to a client.
</syntaxhighlight>

HeroInventory

2013-01-13T20:40:47Z

Malicious Hero: Created page with "==Description== HeroInventory is a new way to expand a roleplay server's features. This resource allows a server to not only archive items; but organize them appropriately! Addin..."