Reference |
| Reserved script functions for client |
Classes |
class | CritterCl |
| Limited-functionality equivalent of Critter class. More...
|
class | ItemCl |
| Limited-functionality equivalent of Item class. More...
|
class | ProtoItem |
| Represents item prototype. More...
|
Variables |
bool | __HideCursor = false |
uint8 | __RoofAlpha |
bool | __DisableLMenu |
bool | __DisableMouseEvents |
bool | __DisableKeyboardEvents |
string | __PlayerOffAppendix |
uint | __DamageHitDelay |
int | __RunModMul = 1 |
int | __RunModDiv = 1 |
int | __RunModAdd = 0 |
bool | __DiLeft |
bool | __DiRight |
bool | __DiUp |
bool | __DiDown |
bool | __DiMleft |
bool | __DiMright |
bool | __DiMup |
bool | __DiMdown |
bool | __ShowGroups |
bool | __DebugInfo |
int | __FlushVal |
int | __BaseTex |
int | __ScreenClear |
int | __Light |
int | __ScrollDelay |
int | __ScrollStep |
bool | __MouseScroll |
bool | __ScrollCheck |
int | __MouseSpeed |
bool | __GlobalSound |
string | __MasterPath |
| Path to master.dat.
|
string | __CritterPath |
| Path to critter.dat.
|
string | __FoPatchPath |
string | __FoDataPath |
string | __Name |
string | __Pass |
uint | __TextDelay |
bool | __MsgboxInvert |
int | __ChangeLang |
uint8 | __DefaultCombatMode |
bool | __MessNotify |
bool | __SoundNotify |
int | __IndicatorType |
uint | __DoubleClickTime |
bool | __ShowTile |
| Tiles visibility.
|
bool | __ShowRoof |
| Roofs visibility.
|
bool | __ShowItem |
| Items visibility.
|
bool | __ShowScen |
| Scenery visibility.
|
bool | __ShowWall |
| Walls visibility.
|
bool | __ShowCrit |
| Critters visibility.
|
bool | __ShowFast |
| Fast-objects visibility.
|
bool | __ShowPlayerNames |
| Players names visibility.
|
bool | __ShowNpcNames |
| NPCs names visibility.
|
bool | __ShowCritId |
| Critters names visibility.
|
bool | __HidePassword |
bool | __GmapActive |
bool | __GmapWait |
float | __GmapZoom |
int | __GmapOffsetX |
int | __GmapOffsetY |
int __GmapGroupX int | __GmapGroupY |
int | __GmapMoveX |
int | __GmapMoveY |
float | __GmapSpeedX |
float | __GmapSpeedY |
string | __ClientPath |
| Path to client folder.
|
string | __ServerPath |
| Path to server folder.
|
bool | __ConsoleActive |
int | __CombatMessagesType |
uint | __Anim2CombatBegin |
uint | __Anim2CombatIdle |
uint | __Anim2CombatEnd |
uint | __CritterFidgetTime |
Network settings |
|
string | __Host |
| Game server hostname.
|
uint | __Port |
| Game server port number.
|
uint | __ProxyType |
| Proxy type.
|
string | __ProxyHost |
| Proxy hostname.
|
uint | __ProxyPort |
| Proxy port number.
|
string | __ProxyUser |
| Proxy login.
|
string | __ProxyPass |
| Proxy password.
|
Video settings |
|
const int | __ScreenWidth |
| Screen width.
|
const int | __ScreenHeight |
| Screen height.
|
bool | __FullScr |
| Full screen.
|
bool | __VSync |
| VSync.
|
int | __Sleep |
| Sleep.
|
bool | __AlwaysOnTop |
| Always on top.
|
General |
|
CritterCl | GetChosen () |
bool | IsTurnBased () |
| (?)
|
uint16 | GetCurrentMapPid () |
| (?)
|
uint | GetChosenActions (uint[]@ actions) |
void | SetChosenActions (uint[]@ actions) |
string | GetLastError () |
void | Log (string& text) |
bool | StrToInt (string& text, int& result) |
int | Random (int minimum, int maximum) |
ItemCl | GetItem (uint itemId) |
ProtoItem | GetProtoItem (uint16 protoId) |
void | Message (string& msg) |
void | Message (int textMsg, uint strNum) |
void | Message (string& msg, int type) |
void | Message (int textMsg, uint strNum, int type) |
bool | LoadDat (string& datName) |
uint | GetTick () |
void | RunServerScript (string& funcName, int p0, int p1, int p2, string@+ p3, int[]@+ p4) |
void | RunServerScriptUnsafe (string& funcName, int p0, int p1, int p2, string@+ p3, int[]@+ p4) |
int | GetFog (uint16 zoneX, uint16 zoneY) |
| Gets fog of the player's worldmap, at given coordinates.
|
string | GetIfaceIniStr (string& key) |
void | WaitPing () |
String manipulation |
|
string | GetMsgStr (int textMsg, uint strNum) |
string | GetMsgStr (int textMsg, uint strNum, uint skipCount) |
uint | GetMsgStrNumUpper (int textMsg, uint strNum) |
uint | GetMsgStrNumLower (int textMsg, uint strNum) |
uint | GetMsgStrCount (int textMsg, uint strNum) |
bool | IsMsgStr (int textMsg, uint strNum) |
string | ReplaceText (const string& text, const string& replace, const string& str) |
string | ReplaceText (const string& text, const string& replace, int i) |
string | FormatTags (const string& text, const string@+ lexems) |
bool | LoadFont (int font, string& fontFileName) |
void | SetDefaultFont (int font, uint color) |
Coordinates system |
|
uint8 | GetDirection (uint16 fromX, uint16 fromY, uint16 toX, uint16 toY) |
uint | GetDistantion (uint16 hexX1, uint16 hexY1, uint16 hexX2, uint16 hexY2) |
uint | GetCrittersDistantion (CritterCl& cr1, CritterCl& cr2) |
void | MoveHexByDir (uint16& hexX, uint16& hexY, uint8 dir, uint steps) |
void | GetHexCoord (uint16 fromHx, uint16 fromHy, uint16& toHx, uint16& toHy, float angle, uint dist) |
uint | GetPathLength (uint16 fromHx, uint16 fromHy, uint16 toHx, uint16 toHy, uint cut) |
uint | GetPathLength (CritterCl& cr, uint16 toHx, uint16 toHy, uint cut) |
uint8 | GetOffsetDir (uint16 hx, uint16 hy, uint16 tx, uint16 ty, float offset) |
| (?)
|
For visual and audio effects |
|
void | FlushScreen (uint fromColor, uint toColor, uint timeMs) |
void | PlaySound (string& soundName) |
void | PlaySound (uint8 soundType, uint8 soundTypeExt, uint8 soundId, uint8 soundIdExt) |
void | QuakeScreen (uint noise, uint ms) |
void | PlayMusic (string& musicName, uint pos, uint repeat) |
void | PlayVideo (string& videoName, bool canStop) |
Time |
|
uint | GetFullSecond (uint16 year, uint16 month, uint16 day, uint16 hour, uint16 minute, uint16 second) |
void | GetTime (uint16& year, uint16& month, uint16& day_of_week, uint16& day, uint16& hour, uint16& minute, uint16& second, uint16& milliseconds) |
void | GetGameTime (uint fullSecond, uint16& year, uint16& month, uint16& dayOfWeek, uint16& day, uint16& hour, uint16& minute, uint16& second) |
Graphics |
|
uint | LoadSprite (string& name, int pathIndex) |
uint | LoadSprite (uint nameHash, uint8 dir) |
int | GetSpriteWidth (uint sprId, int sprIndex) |
int | GetSpriteHeight (uint sprId, int sprIndex) |
uint | GetSpriteCount (uint sprId) |
void | DrawSprite (uint sprId, int sprIndex, int x, int y, uint color) |
void | DrawSprite (uint sprId, int sprIndex, int x, int y, int w, int h, bool scratch, bool center, uint color) |
void | DrawText (string& text, int x, int y, int w, int h, uint color, int font, int flags) |
void | DrawPrimitive (int primitiveType, int[]& data) |
void | DrawMapSprite (uint16 hx, uint16 hy, uint16 effectPid, uint sprId, int sprIndex, int offsX, int offsY) |
void | DrawCritter2d (uint crType, uint anim1, uint anim2, uint8 dir, int l, int t, int r, int b, bool scratch, bool center, uint color) |
void | DrawCritter3d (uint instance, uint crType, uint anim1, uint anim2, int[]@+ layers, float[]@+ position, uint color) |
Screen |
|
bool | GetHexPos (uint16 hx, uint16 hy, int& x, int& y) |
bool | GetMonitorHex (int x, int y, uint16& hx, uint16& hy) |
CritterCl | GetMonitorCritter (int x, int y) |
ItemCl | GetMonitorItem (int x, int y) |
void | LockScreenScroll (CritterCl@+ cr) |
void | MoveScreen (uint16 hexX, uint16 hexY, uint speed) |
void | ShowScreen (int screen, int p0, int p1, int p2) |
void | HideScreen (int screen, int p0, int p1, int p2) |
void | GetHardcodedScreenPos (int screen, int& x, int& y) |
void | DrawHardcodedScreen (int screen) |
int | GetKeybLang () |
For mouse cursors |
|
int | GetCurrentCursor () |
int | GetLastCursor () |
void | ChangeCursor (int cursor) |
For critters |
|
CritterCl | GetCritter (uint critterId) |
uint | GetCrittersHex (uint16 hexX, uint16 hexY, uint radius, int findType, CritterCl@[]@+ critters) |
uint | GetCritters (uint16 pid, int findType, CritterCl@[]@+ critters) |
uint | GetCrittersPath (uint16 fromHx, uint16 fromHy, uint16 toHx, uint16 toHy, float angle, uint dist, int findType, CritterCl@[]@+ critters) |
uint | GetCrittersPath (uint16 fromHx, uint16 fromHy, uint16 toHx, uint16 toHy, float angle, uint dist, int findType, CritterCl@[]@+ critters, uint16& preBlockHx, uint16& preBlockHy, uint16& blockHx, uint16& blockHy) |