Rodzaj zdarzenia: "openChat", "sendMsg", "recvMsg", "fmtMsgTxt" lub "uninit". Funkcja do obsługi zdarzenia. Rejestruje funkcję handler-a do obsługi zadanego zdarzenia. Obecnie wszystkie skrypty w Unicomie są tworzone zgodnie z pewnym modelem, który zakłada, że:

• Dołączenie nowego skryptu do całości systemu sprowadza się do dopisania linijki include ("nowy_skrypt.lua") do pliku main.lua.
• Inicjalizacja skryptu odbywa się z chwilą wywołania tegoż include()'a, a więc kod inicjalizujący musi znajdować się bezpośrednio w pliku LUA, nie zamknięty w żadnej funkcji.
• Skrypty komunikują się z programem poprzez system handler'ów, które muszą być zarejestrowane właśnie przy użyciu funkcji registerHandler. Handler jest wywoływany z chwilą wystąpienia zdarzenia do obsługi którego został zarejestrowany.

Konstrukcja handler'a zależy od rodzaju obsługiwanego zdarzenia. Idea w wypadku funkcji służących do obrabiania tekstu wiadomości jest bardzo podobna:

sendMsgHandler (acct_id, to_id, acct, to, text, rv1, rv2)
recvMsgHandler (acct_id, from_id, acct, from, text, rv)
fmtMsgTxtHandler (text, level, rv)

i sprowadza się do zwracania albo odpowiednio przemielonego tekstu, albo nil jeśli handler nie chce nic zmieniać. Z kolei funkcja do obsługi uninit nie przyjmuje żadnych parametrów i nie zwraca wartości. Handler openChat jest nieco bardziej zaawansowany i zdecydowanie wymaga osobnego działu. Wszystkie funkcje handler'ów są opisane ze szczegółami w dalszej części tego dokumentu. Funkcja statusChangeHandler (acct_id, ctct_id, acct, ctct, status, desc) obsługuje proste zdarzenie zmiany statusu kogoś na liście kontaktów. Nadrzędny handler zdarzenia "recvMsg" wywoływany przez program, nie powinien być używany z poziomu skryptów. Nadrzędny handler zdarzenia "sendMsg" wywoływany przez program, nie powinien być używany z poziomu skryptów. Nadrzędny handler zdarzenia "uninit" wywoływany przez program, nie powinien być używany z poziomu skryptów. Nadrzędny handler zdarzenia "openChat" wywoływany przez program, nie powinien być używany z poziomu skryptów. Nadrzędny handler zdarzenia "statusChange" wywoływany przez program, nie powinien być używany z poziomu skryptów. Funkcja typu callback tworzona przez użytkownika, musi zostać specjalnie nazwana, aby nie pokrywała się z nazwami innych funkcji w systemie skryptowym. Funkcja typu callback tworzona przez użytkownika, musi zostać specjalnie nazwana, aby nie pokrywała się z nazwami innych funkcji w systemie skryptowym. Funkcja typu callback tworzona przez użytkownika, musi zostać specjalnie nazwana, aby nie pokrywała się z nazwami innych funkcji w systemie skryptowym. Funkcja typu callback tworzona przez użytkownika, musi zostać specjalnie nazwana, aby nie pokrywała się z nazwami innych funkcji w systemie skryptowym. Funkcja typu callback tworzona przez użytkownika, musi zostać specjalnie nazwana, aby nie pokrywała się z nazwami innych funkcji w systemie skryptowym. Funkcja typu callback tworzona przez użytkownika, musi zostać specjalnie nazwana, aby nie pokrywała się z nazwami innych funkcji w systemie skryptowym. Tekst, który zostanie dopisany do programowego dziennika zdarzeń. Dopisuje tekst do okna dziennika zdarzeń oraz do pliku, jesli włączona jest opcja "Loguj do pliku". Wypisuje zawartość stosu LUA. Ta funkcja jest wywoływana również automatycznie w wypadku wystąpienia błędów w callbackach. Zwraca wartość zadanej zmiennej w programie. W zależności od parametru name zwracana jest:

• "version" - wersja Unicoma postaci "x.y.z"
• "os" - bieżący system operacyjny - "linux", "win32" lub "macos"

Narazie lista ta jest bardzo ograniczona, ale stopniowo będzie rozbudowywana w miarę rosnących mam nadzieję potrzeb. Dane do dopisania do okna "Zbieracza Danych" Typ, na razie 0 - URL lub 1 - email Bieżący status użytkownika. Statusy numerowane są od 0 - Dostępny do 6 - Niedostępny w takiej kolejności jak są w menu statusu. Zwraca bieżący status użytkownika. Status do ustawienia. Statusy są numerowane od 0 - Dostępny do 6 - Niedostępny w takiej kolejności jak są w menu statusu. Ustawia status użytkownika. Bieżący opis Zwraca bieżący opis. Opis do ustawienia. 0 lub 1 - decyduje czy zapisać do historii opisów. Ustawia jednocześnie status oraz opis. 0 - sukces (w sensie przekazane do wykonania), 1 - kontakt nie istnieje, 2 - konto nie istnieje lub jest niepołączone ID konta, z którego będzie wysłana wiadomość ID odbiorcy Treść wiadomości Wysyła podaną wiadomość tekstową do zadanego kontaktu, używając określonego konta. Identyfikatory konta i odbiorcy można uzyskać na przykład z argumentów handlera "recvMsg". Obecnie nie jest sprawdzane czy można wysłać z zadanego konta wiadomość do danego odbiorcy (zgodność protokołów) i zachowanie programu w takiej sytuacji jest nieokreślone, natomiast funkcja będzie zwracać wartość 0, o ile nie wystąpiły inne błędy. Nazwa. Numer protokołu od zera kolejno GG, Jabber, Tlen, UniLAN. Login. Flagi zgodnie ze wzorem (donttrust | (temporary << 1) | (ignore << 2)). ID użytkownika, dostępne na przykład w handlerach sendMsg i recvMsg. Szuka kontaktu o zadanym ID i zwraca jego podstawowe dane. Do obsłużenia flag można użyć funkcji z grupy bit_. ID użytkownika, dostępne na przykład w handlerach sendMsg i recvMsg. Flagi zgodnie ze wzorem (donttrust | (temporary << 1) | (ignore << 2)). Ustawia flagi kontaktu. Do obsłużenia flag można użyć funkcji z grupy bit_. Do obsługi GUI. Do obsługi GUI. Do obsługi GUI. Do obsługi GUI. Do obsługi GUI. Do obsługi GUI. Wstawia zadany kod HTML do okna rozmowy. Nazwa pliku skryptu, który ma zostać przetworzony. Przetwarza zadany skrypt LUA. Nazwa pliku wykonywalnego. 0 lub 1 - określa czy skrypt ma oczekiwać na zakończenie wykonania wskazanej binarki. Dane do zakodowania. Długość danych. Dane do zdekodowania. Ilość milisekund co ile ma być wywoływana funkcja obsługi timeout'u. Nazwa funkcji obsługi timeout'u. Dodaje timeout. Usuwa timeout. Uchwyt do załadowanego kodu. Nazwa pliku z dynamicznym kodem do załadowania. Wskaźnik do symbolu. Uchwyt do dynamicznego kodu. Nazwa symbolu do znalezienia w dynamicznym kodzie. Uchwyt do dynamicznego kodu. Zwalnia uchwyt do dynamicznego kodu. Wartość rejestru EAX po wykonaniu wywołania. Wskaźnik do funkcji w konwencji stdcall. Dowolna ilość argumentów o typach standardowych LUA lub lightweight userdata. To mogą być generalnie stringi, liczby albo wskaźniki. Wywołuje funkcję w konwencji stdcall, tylko x86. Wartość rejestru EAX po wykonaniu wywołania. Wskaźnik do funkcji w konwencji cdecl. Dowolna ilość argumentów o typach standardowych LUA lub lightweight userdata. To mogą być generalnie stringi, liczby albo wskaźniki. Wywołuje funkcję w konwencji cdecl, tylko x86. "Wskaźnik" do zaalokowanej pamięci. Rozmiar pamięci do zaalokowania w bajtach. "Wskaźnik" do zaalokowanej pamięci. Zwalnia pamięć zaalokowaną uprzednio przez funkcję malloc(). Tworzy nowy wskaźnik poprzez dodanie do istniejącego zadanego offsetu w bajtach. Odczytuje wartość wskazywaną przez wskaźnik jako wskaźnik. Zapisuje dane w postaci łańcuchowej (string) o długości length pod adres we wskaźniku. Zapisuje wskaźnik ptr_from pod adres we wskaźniku ptr_to. Zwraca wartość wskazywaną przez wskaźnik jako łańcuch znaków LUA. Zwraca wartość wskazywaną przez wskaźnik jako całkowitą liczbę 32-bitową LUA. Odpowiednik (a | b) w C. Odpowiednik (a & b) w C. Odpowiednik ~a w C. Tworzy wątek. Oczekuje na zakończenie wątka. Odpowiednik wywołania Fl::lock() w FLTK, synchronizuje wątek z wątkiem głównym. Koniecznie trzeba pamiętać o wywołaniu fl_unlock() po wyjściu z sekcji krytycznej!!! Odpowiednik wywołania Fl::unlock() w FLTK, zwalnia mutex odpowiedzialny za synchronizację z wątkiem głównym. Uchwyt do skompilowanego wyrażenia regularnego. Wyrażenie regularne do kompilacji, zgodne ze składnią Perla. Flagi analogicznie jak w dokumentacji PCRE. Zwraca nil jeśli wyrażenie jest niepoprawne lub z innych względów (brak pamięci) nie można go skompilować. W przeciwnym razie zwraca lightuserdata, który następnie można zwolnić zwykłym wywołaniem funkcji free(). Ilość trafień. Tablica offsetów trafień. Uchwyt do skompilowanego wyrażenia regularnego. Badany łańcuch. Długość badanego łańcucha. Offset od którego należy zacząć dopasowywanie. ovector[0] i ovector[1] przechowują początek i koniec trafienia wyrażenia jako całości, zaś pod kolejnymi indeksami są trafienia poszczególnych () w wyrażeniu. Obecnie ilość trafień w sumie jest ograniczona do 15-tu. Jeśli nie ma trafień, ilość trafień przekracza 15-cie lub podczas wyszukiwania wystąpił błąd zwrócone zostanie 0, nil. Uchwyt do skompilowanego wyrażenia regularnego. Zwalnia skompilowane wyrażenie regularne. Zwraca łańcuch znaków zakodowany algorytmem URLencode. Wyświetla okno z wiadomością. Odpowiednik fl_message(). Ustawia tekst w pasku statusu okna wysyłania SMS-ów. Zamienia tekst po angielsku na lokalny język zgodnie z tłumaczeniami w pliku lang.txt. Uchwyt do obiektu Http. Tworzy nowy obiekt Http. Uchwyt do obiektu Http. Zwalnia zasoby obiektu Http. Uchwyt do obiektu Http. Adres serwera HTTP (IP lub FQDN). Metoda zapytania HTTP, 0 - GET, 1 - POST, 2 - RAW. Ścieżka na serwerze HTTP. Dane w wypadku metody POST. Wykonuje zapytanie HTTP i odbiera odpowiedź od serwera. W przypadku metody RAW (nie jest to część standardu HTTP tylko moje wewnętrzne oznaczenie) całe zapytanie do serwera musi być podane jako parametr uri, klasa Http nie ingeruje w treść zapytania.

Dane w metodzie POST są wysyłane jako application/x-www-form-urlencoded więc musze być wcześniej potraktowane funkcją url_encode(). Uchwyt do obiektu Http. Adres serwera HTTP (IP lub FQDN). Metoda zapytania HTTP, 0 - GET, 1 - POST, 2 - RAW. Ścieżka na serwerze HTTP. Dane w wypadku metody POST. Maksymalna ilość przekierowań dopuszczana przez parser. Wykonuje zapytanie HTTP i odbiera odpowiedź od serwera oraz używa parsera, aby odczytać ustawione ciasteczka oraz obsłużyć ewentualne przekierowania, ustawia też pole nagłówka Referer. W przypadku metody RAW ta funkcja nie ma sensu, należy używać http_request().

Dane w metodzie POST są wysyłane jako application/x-www-form-urlencoded więc musze być wcześniej potraktowane funkcją url_encode().

W wypadku przekierowań po wykonaniu funkcji dostępny jest nagłówek i treść dokumentu otrzymanego w odpowiedzi tylko na OSTATNIE zapytanie. Treść dokumentu otrzymanego w odpowiedzi na ostatnie zapytanie. Uchwyt do obiektu Http. Zwraca treść dokumentu otrzymanego w odpowiedzi na ostatnie zapytanie. Nagłówek odpowiedzi na ostatnie zapytanie. Uchwyt do obiektu Http. Zwraca nagłówek odpowiedzi na ostatnie zapytanie. Wynik ostatniego zapytania. Błąd wystąpił jeśli wynik jest różny od zera. Uchwyt do obiektu Http. Zwraca wynik ostatniego zapytania. Uchwyt do obiektu Http. Wartość pola nagłówka HTTP Referer. Ustawia wartość pola nagłówka HTTP Referer. Uchwyt do obiektu Http. Usuwa ciasteczka przechowywane w obiekcie Http.