Malicious Hero at 13:47, 21 January 2013

2013-01-21T13:47:49Z

← Older revision		Revision as of 13:47, 21 January 2013
Line 105:		Line 105:
	field names as reference for variables.		field names as reference for variables.
	</syntaxhighlight>		</syntaxhighlight>
	==~~Client~~ Functions==		==Player Usage Functions==
	===showClientBook===		===showClientBook===
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Malicious Hero at 13:47, 21 January 2013

2013-01-21T13:47:25Z

← Older revision		Revision as of 13:47, 21 January 2013
Line 105:		Line 105:
	field names as reference for variables.		field names as reference for variables.
	</syntaxhighlight>		</syntaxhighlight>
			==Client Functions==
	===showClientBook===		===showClientBook===
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

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..."

2013-01-21T02:00:09Z

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..."

New page

==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>

HeroBook - Revision history

Malicious Hero at 13:47, 21 January 2013

Malicious Hero at 13:47, 21 January 2013

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..."