Dokumentacja - Quis Register System 1.0

/*
Quis Register System 1.0
Biblioteka poniżej jest efektem kilku godzin mojej pracy - proszę nie zapominaj o tym i uszanuj moje autorstwo.
Życzę miłego użytkowania biblioteki

Lista opcji konfiguracyjnych:

SHOW_SAVING_TIMES - po dodaniu, będzie wyświetlać w konsoli czas zapisu danych dla poszczególnych graczy (funkcja SavePlayerData).
SHOW_LOADING_TIMES - po dodaniu, będzie wyświetlać w konsoli czas odczytu danych graczy (po wejściu na serwer).
DATABASE - nazwa pliku bazy danych, domyślnie "QuisRegister.db"
PREFIX - prefiks do tabel w bazie danych, domyślnie pusty
C_REGISTERINFO - kolor wiadomości na czacie, po zalogowaniu czy zarejestrowaniu, domyślnie: 0x00C326FF (delikatnie ciemny zielony)
MIN_PASSWORD_LEN - minimalna długość hasła, domyślnie 4

LOGIN_TEXT - tekst wyświetlany w okienku podczas logowania, domyślnie:
                "Wpisz poniżej swoje hasło aby się zalogować:"
REGISTER_TEXT - tekst wyświetlany w okienku podczas rejestrowania się, domyślnie:
                "Witaj na naszym serwerze!\nWpisz poniżej swoje hasło, aby utworzyć swoje konto do gry:"
BAD_PASS_TEXT - tekst wyświetlany w okienku po wpisaniu nieprawidłowego hasła podczas logowania, domyślnie:
                "Podane przez Ciebie hasło jest nieprawidłowe.\nSpróbuj ponownie:"
PASS_TOO_SHORT_TEXT - tekst wyświetlany w okienku po wpisaniu zbyt krótkiego hasła podczas rejestracji, domyślnie:
                "Podane przez Ciebie hasło jest zbyt krótkie (minimum 4 znaki).\nSpróbuj ponownie:"



Jak konfigurować?
Po prostu, wystarczy dodać odpowiednią linijkę nad biblioteką, czyli np. dodanie biblioteki wygląda tak:

#include <QuisRegister>

To jeśli chcemu zmienić tekst do logowania, nad biblioteką wklejamy coś takiego:

#define LOGIN_TEXT "{FFFFFF}Nasz nowy tekst do logowania, będzie biały\nbo można tutaj dodawać kolorowanie."

Czyli kod końcowy będzie wyglądał tak

#define LOGIN_TEXT "{FFFFFF}Nasz nowy tekst do logowania, będzie biały\nbo można tutaj dodawać kolorowanie."
#include <QuisRegister>

Możemy dodawać więcej rzeczy, czyli np. jeśli chcemy jeszcze zeby pokazywał nam się czas zapisu danych graczy,
dodajemy jeszcze taką linijkę (kolejność dodawania tych linijek jest dowolna):

#define SHOW_SAVING_TIMES

Kod końcowy:
#define SHOW_SAVING_TIMES
#define LOGIN_TEXT "{FFFFFF}Nasz nowy tekst do logowania, będzie biały\nbo można tutaj dodawać kolorowanie."
#include <QuisRegister>


Lista funkcji wywoływanych:

OnPlayerLogin(playerid, autologin)
Jest wywoływana po zalogowaniu się gracza, lub po jego rejestracji.
Ma z sobą dwa parametry: id gracza który się zalogował i informację czy logowanie było automatyczne.
"autologin" będzie wynosić "1" (true) jeśli gracz zaloguje się z adresu IP, 0 (false) jeśli zaloguje się przy użyciu hasła.

OnPlayerRegister(playerid)
Jest wywoływana po rejestracji gracza, zaraz po niej jest także wywoływana OnPlayerLogin.
Ma z sobą jeden parametr: id gracza który się zarejestrował.


Lista funkcji:

native IsPlayerLogged(playerid);
Sprawdza czy gracz jest zalogowany, zwraca 1 (true) jeśli tak, 0 (false) jeśli nie.
Przyjmuje jeden argument: id gracza na serwerze (nie w bazie).

native GetPlayerDatabaseID(playerid);
Zwraca unikalny numer ID gracza, pod którym jest zapisany w bazie.
Przyjmuje jeden argument: id gracza na serwerze.

native IsValidPassword(playerid, const password[]);
Sprawdza czy hasło dla danego gracza jest zgodne z hasłem w bazie. Zwraca 1 (true) jeśli tak, 0 (false) jeśli nie.
Przyjmuje dwa argumenty: id gracza na serwerze i hasło które chcemy porównać.

native SetPlayerPassword(playerid, const newpassword[]);
Zmienia graczowi hasło na nowe. Zwraca 0 (false) jeśli gracz nie będzie zalogowany, w przeciwnym wypadku zwraca 1 (true).
Przyjmuje dwa argumenty: id gracza na serwerze i nowe hasło gracza.

native IsPlayerDataSet(playerid, data[]);
Sprawdza czy gracz ma przypisaną wartość do podanej danej. Zwraca 1 (true) jeśli tak, 0 (false) jeśli nie.
Przyjmuje dwa argumenty: id gracza na serwerze i dana którą chcemy sprawdzić.

native SetPlayerDataInt(playerid, const data[], value);
Przypisuje wartość typu INT (1) do podanej danej, dla konkretnego gracza.
Zwraca 0 (false) jeśli gracz nie będzie zalogowany, w przeciwnym wypadku zwraca 1 (true).
Przyjmuje trzy argumenty: id gracza na serwerze, dana do której chcemy przypisać wartość, i wartość (typu INT).

native GetPlayerDataInt(playerid, const data[]);
Pobiera wartość typu INT (1) dla podanej danej, dla konkretnego gracza.
Zwraca przypisaną wartość, jeśli gracz nie będzie zalogowany, funkcja zwróci 0 (false).
Przyjmuje dwa argumenty: id gracza na serwerze, i dana którą chcemy pobrać.

native SetPlayerDataFloat(playerid, const data[], Float:value);
Przypisuje wartość typu FLOAT (3) do podanej danej, dla konkretnego gracza.
Zwraca 0 (false) jeśli gracz nie będzie zalogowany, w przeciwnym wypadku zwraca 1 (true).
Przyjmuje trzy argumenty: id gracza na serwerze, dana do której chcemy przypisać wartość, i wartość (typu FLOAT).

native GetPlayerDataFloat(playerid, const data[], &Float:value);
Pobiera wartość typu FLOAT (3) dla podanej danej, dla konkretnego gracza.
Zwraca 0 (false) jeśli gracz nie będzie zalogowany, w przeciwnym wypadku zwraca 1 (true).
Przyjmuje trzy argumenty: id gracza na serwerze, dana którą chcemy pobrać, i zmienna do jakiej ma zostać przypisana pobrana wartość.

native SetPlayerDataString(playerid, const data[], value[]);
Przypisuje wartość typu STRING (2) do podanej danej, dla konkretnego gracza.
Zwraca 0 (false) jeśli gracz nie będzie zalogowany, w przeciwnym wypadku zwraca 1 (true).
Przyjmuje trzy argumenty: id gracza na serwerze, dana do której chcemy przypisać wartość, i wartość (typu STRING).

native GetPlayerDataString(playerid, const data[], value[], value_size);
Pobiera wartość typu STRING (2) dla podanej danej, dla konkretnego gracza.
Zwraca 0 (false) jeśli gracz nie będzie zalogowany, w przeciwnym wypadku zwraca 1 (true).
Przyjmuje cztery argumenty: id gracza na serwerze, dana którą chcemy pobrać, tablica do której zostanie zapisany pobrany ciąg (STRING) i maksymalna pobrana długość (sizeof tablicy).

native SavePlayerData(playerid);
Zapisuje dane gracza w bazie danych. Wywoływana automatycznie po wyjściu gracza z serwera.
Czas wykonania tej funkcji jest dość długi, dlatego nie należy używać jej zbyt często.
Warto zrobić zapis danych na serwerze co np. 20 minut, ponieważ jeśli ktoś będzie długo grał, i w pewnym momencie
serwer padnie, dane zostaną utracone.
Zwraca 0 (false) jeśli gracz nie będzie zalogowany, w przeciwnym wypadku zwraca 1 (true).
Przyjmuje jeden argument: id gracza na serwerze.

WP_Hash(buffer[], len, const str[])
Służy do kodowania haseł do formatu Whirlpool. Wymaga zainstalowanego pluginu autorstwa Y_Less'a.
Plugin dostępny na forum SA-MPa: http://forum.sa-mp.com/showthread.php?t=65290
Do paczki dorzuciłem najbardziej aktualny plugin na dzień 13/01/2014
Jeśli na forum pojawi się bardziej aktualny to polecam aktualizację, jeśli nie to możesz używać wersji z paczki.
*/