Server API

Reference
	Reserved script functions
	Used only in the script main.fos.
Classes
class	Critter
	Critter. More...
class	GameVar
	Represents game variable. More...
class	Item
class	Location
	Location. More...
class	Map
	Represents map. More...
class	NpcPlane
	Reprsents NPC plan. More...
class	ProtoItem
	Represents item prototype. More...
class	Scenery
	Represents scenery object. More...
Time and data
const uint16	__Year
const uint16	__Month
const uint16	__Day
const uint16	__Hour
const uint16	__Minute
const uint16	__Second
const uint16	__FullSecond
const uint16	__TimeMultiplier
Combat
List of global variables that can be used to tweak combat.
uint	__Breaktime
	(?)
uint	__TimeoutTransfer
	(?)
uint	__TimeoutBattle
	(?)
uint	__ApRegeneration
	(?)
uint	__RtApCostCritterWalk
uint	__RtApCostCritterRun
uint	__RtApCostMoveItemContainer
	(?)
uint	__RtApCostMoveItemInventory
	(?)
uint	__RtApCostPickItem
	(?)
uint	__RtApCostDropItem
	(?)
uint	__RtApCostReloadWeapon
	(?)
uint	__RtApCostPickCritter
	(?)
uint	__RtApCostUseItem
	(?)
uint	__RtApCostUseSkill
	(?)
uint	__TbApCostCritterMove
	(?)
uint	__TbApCostMoveItemContainer
	(?)
uint	__TbApCostMoveItemInventory
	(?)
uint	__TbApCostPickItem
	(?)
uint	__TbApCostDropItem
	(?)
uint	__TbApCostReloadWeapon
	(?)
uint	__TbApCostPickCritter
	(?)
uint	__TbApCostUseItem
	(?)
uint	__TbApCostUseSkill
	(?)
uint	__ApCostAimEyes
	(?)
uint	__ApCostAimHead
	(?)
uint	__ApCostAimGroin
	(?)
uint	__ApCostAimTorso
	(?)
uint	__ApCostAimArms
	(?)
uint	__ApCostAimLegs
	(?)
uint	__HitAimEyes
	(?)
uint	__HitAimHead
	(?)
uint	__HitAimGroin
	(?)
uint	__HitAimTorso
	(?)
uint	__HitAimArms
	(?)
uint	__HitAimLegs
	(?)
bool	__RtAlwaysRun
bool	__TbAlwaysRun
bool	__AlwaysRun
uint	__AlwaysRunMoveDist
uint	__AlwaysRunUseDist
Worldmap
uint	__GlobalMapWidth
uint	__GlobalMapHeight
uint	__GlobalMapZoneLength
uint	__GlobalMapMaxGroupCount
Miscellaneous
uint	__FixBoyDefaultExperience
uint	__SneakDivider
bool	__FreeExp
bool	__RegulatePvP
bool	__NoAnswerShuffle
bool	__RunOnCombat
bool	__RunOnTransfer
uint	__CritterIdleTick
uint	__LevelCap
bool	__LevelCapAddExperience
uint	__LookNormal
uint	__LookMinimum
int	__DeadHitPoints
uint	__BagRefreshTime
uint	__WisperDist
bool	__CustomItemCost
uint	__AccountPlayTime
bool	__DialogDemandRecheck
uint	__TalkDistance
uint	__ShoutDist
float	__SpritesZoom
float	__SpritesZoomMax
float	__SpritesZoomMin
uint	__DlgTalkMinTime
uint	__DlgBarterMinTime
Look modifiers
int	__LookChecks
uint	__LookDir0
uint	__LookDir1
uint	__LookDir2
uint	__LookDir3
uint	__LookSneakDir0
uint	__LookSneakDir1
uint	__LookSneakDir2
uint	__LookSneakDir3
uint	__LookWeight
int	__MouseX
int	__MouseY
uint	__EncounterTime
General functions
void	Log (string& text)
int	Random (int minimum, int maximum)
bool	StrToInt (string& text, int& result)
string	GetLastError ()
bool	RunDialog (Critter& player, Critter& npc, bool ignoreDistance)
bool	RunDialog (Critter& player, uint16 dialogId, uint16 hexX, uint16 hexY, bool ignoreDistance)
void	RadioMessage (uint16 channel, string& text)
void	RadioMessageMsg (uint16 channel, uint16 textMsg, uint strNum)
void	SetBestScore (int score, Critter@+ player, string& name)
bool	AddTextListener (int sayType, string& firstStr, uint16 parameter, string& scriptName)
void	EraseTextListener (int sayType, string& firstStr, uint16 parameter)
NpcPlane	CreatePlane ()
uint	GetTick ()
void	ViewMap (Map& map, uint look, uint16 hx, uint16 hy, uint8 dir)
uint	GetScriptId (string& scriptName, string& funcDeclaration)
string	GetScriptName (uint scriptId)
Coordinates system
uint	GetCrittersDistantion (Critter& cr1, Critter& cr2)
uint	GetDistantion (uint16 hexX1, uint16 hexY1, uint16 hexX2, uint16 hexY2)
uint8	GetDirection (uint16 fromX, uint16 fromY, uint16 toX, uint16 toY)
uint8	GetOffsetDir (uint16 hx, uint16 hy, uint16 tx, uint16 ty, float offset)
For maps and locations
uint	CreateLocation (uint16 protoId, uint16 worldX, uint16 worldY, Critter@[]@+ critters)
void	DeleteLocation (uint16 locationId)
Location	GetLocation (uint locId)
Location	GetLocationByPid (uint16 locPid, uint skipCount)
uint	GetLocations (uint16 worldX, uint16 worldY, uint radius, Location@[]@+ locations)
Map	GetMap (uint mapId)
Map	GetMapByPid (uint16 mapProtoId, uint skipCount)
uint	GetAllLocations (uint16 pid, Location@[]@+ locations)
uint	GetAllMaps (uint16 pid, Map@[]@+ maps)
For players and critters
uint	GetAllNpc (uint16 pid, Critter@[]@+ npc)
Critter	GetCritter (uint critterId)
Critter	GetPlayer (string& playerName)
uint	GetPlayerId (string& name)
string	GetPlayerName (uint playerId)
void	DeleteNpc (Critter& npc)
bool	SwapCritters (Critter& cr1, Critter& cr2, bool withInventory, bool withVars)
uint	GetGlobalMapCritters (uint16 worldX, uint16 worldY, uint radius, int findType, Critter@[]@+ critters)
bool	SetParameterGetBehaviour (uint index, string& funcName)
bool	SetParameterChangeBehaviour (uint index, string& funcName)
void	SetSendParameter (int index, bool enabled)
void	SetChosenSendParameter (int index, bool enabled)
Game Variables
GameVar	GetGlobalVar (uint16 varId)
GameVar	GetLocalVar (uint16 varId, uint masterId)
GameVar	GetUnicumVar (uint16 varId, uint masterId, uint slaveId)
Items related
uint	GetAllItems (uint16 pid, Item@[]@+ items)
ProtoItem	GetProtoItem (uint16 protoId)
uint	GetBagItems (uint bagId, uint16[]@+ pids, uint[]@+ minCounts, uint[]@+ maxCounts, int[]@+ slots)
void	MoveItem (Item& item, uint count, Critter& toCr)
void	MoveItem (Item& item, uint count, Item& toCont, uint stackId)
void	MoveItem (Item& item, uint count, Map& toMap, uint16 toHx, uint16 toHy)
void	MoveItems (Item@[]& items, Critter& toCr)
void	MoveItem (Item@[]& items, Item& toCont, uint stackId)
void	MoveItems (Item@[]& items, Map& toMap, uint16 toHx, uint16 toHy)
void	DeleteItem (Item& item)
void	DeleteItems (Item@[]& items)
uint	WorldItemCount (uint16 protoId)
Time and time events
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)
uint	GetFullSecond (uint16 year, uint16 month, uint16 day, uint16 hour, uint16 minute, uint16 second)
uint	CreateTimeEvent (uint beginSecond, string& funcName, bool save)
uint	CreateTimeEvent (uint beginSecond, string& funcName, int value, bool save)
uint	CreateTimeEvent (uint beginSecond, string& funcName, uint value, bool save)
uint	CreateTimeEvent (uint beginSecond, string& funcName, int[]& values, bool save)
uint	CreateTimeEvent (uint beginSecond, string& funcName, uint[]& values, bool save)
bool	GetTimeEvent (uint num, uint& duration, uint[]@+ values)
bool	GetTimeEvent (uint num, uint& duration, int[]@+ values)
bool	SetTimeEvent (uint num, uint duration, uint[]@+ values)
bool	SetTimeEvent (uint num, uint duration, int[]@+ values)
bool	EraseTimeEvent (uint num)
Data related
void	EraseAnyData (string& name)
bool	GetAnyData (string& name, int64[]& data)
bool	GetAnyData (string& name, int32[]& data)
bool	GetAnyData (string& name, int16[]& data)
bool	GetAnyData (string& name, int8[]& data)
bool	GetAnyData (string& name, uint64[]& data)
bool	GetAnyData (string& name, uint32[]& data)
bool	GetAnyData (string& name, uint16[]& data)
bool	GetAnyData (string& name, uint8[]& data)
bool	IsAnyData (string& name)
bool	SetAnyData (string& name, int64[]& data)
bool	SetAnyData (string& name, int32[]& data)
bool	SetAnyData (string& name, int16[]& data)
bool	SetAnyData (string& name, int8[]& data)
bool	SetAnyData (string& name, uint64[]& data)
bool	SetAnyData (string& name, uint32[]& data)
bool	SetAnyData (string& name, uint16[]& data)
bool	SetAnyData (string& name, uint8[]& data)
bool	SetAnyData (string& name, int64[]& data, uint dataSize)
bool	SetAnyData (string& name, int32[]& data, uint dataSize)
bool	SetAnyData (string& name, int16[]& data, uint dataSize)
bool	SetAnyData (string& name, int8[]& data, uint dataSize)
bool	SetAnyData (string& name, uint64[]& data, uint dataSize)
bool	SetAnyData (string& name, uint32[]& data, uint dataSize)
bool	SetAnyData (string& name, uint16[]& data, uint dataSize)
bool	SetAnyData (string& name, uint8[]& data, uint dataSize)

---

Function Documentation

void Log

(

string&

text

)

int Random	(	int	minimum,
		int	maximum
	)

bool StrToInt	(	string&	text,
		int&	result
	)

string GetLastError

(

)

bool RunDialog	(	Critter&	player,
		Critter&	npc,
		bool	ignoreDistance
	)

bool RunDialog	(	Critter&	player,
		uint16	dialogId,
		uint16	hexX,
		uint16	hexY,
		bool	ignoreDistance
	)

void RadioMessage	(	uint16	channel,
		string&	text
	)

void RadioMessageMsg	(	uint16	channel,
		uint16	textMsg,
		uint	strNum
	)

void SetBestScore	(	int	score,
		Critter@+	player,
		string&	name
	)

bool AddTextListener	(	int	sayType,
		string&	firstStr,
		uint16	parameter,
		string&	scriptName
	)

void EraseTextListener	(	int	sayType,
		string&	firstStr,
		uint16	parameter
	)

NpcPlane CreatePlane

(

)

uint GetTick

(

)

void ViewMap	(	Map&	map,
		uint	look,
		uint16	hx,
		uint16	hy,
		uint8	dir
	)

uint GetScriptId	(	string&	scriptName,
		string&	funcDeclaration
	)

string GetScriptName

(

uint

scriptId

)

uint GetCrittersDistantion	(	Critter&	cr1,
		Critter&	cr2
	)

uint GetDistantion	(	uint16	hexX1,
		uint16	hexY1,
		uint16	hexX2,
		uint16	hexY2
	)

uint8 GetDirection	(	uint16	fromX,
		uint16	fromY,
		uint16	toX,
		uint16	toY
	)

uint8 GetOffsetDir	(	uint16	hx,
		uint16	hy,
		uint16	tx,
		uint16	ty,
		float	offset
	)

uint CreateLocation	(	uint16	protoId,
		uint16	worldX,
		uint16	worldY,
		Critter@[]@+	critters
	)

void DeleteLocation

(

uint16

locationId

)

Location GetLocation

(

uint

locId

)

Location GetLocationByPid	(	uint16	locPid,
		uint	skipCount
	)

uint GetLocations	(	uint16	worldX,
		uint16	worldY,
		uint	radius,
		Location@[]@+	locations
	)

Map GetMap

(

uint

mapId

)

Map GetMapByPid	(	uint16	mapProtoId,
		uint	skipCount
	)

uint GetAllLocations	(	uint16	pid,
		Location@[]@+	locations
	)

uint GetAllMaps	(	uint16	pid,
		Map@[]@+	maps
	)

uint GetAllNpc	(	uint16	pid,
		Critter@[]@+	npc
	)

Critter GetCritter

(

uint

critterId

)

Critter GetPlayer

(

string&

playerName

)

uint GetPlayerId

(

string&

name

)

string GetPlayerName

(

uint

playerId

)

void DeleteNpc

(

Critter&

npc

)

bool SwapCritters	(	Critter&	cr1,
		Critter&	cr2,
		bool	withInventory,
		bool	withVars
	)

uint GetGlobalMapCritters	(	uint16	worldX,
		uint16	worldY,
		uint	radius,
		int	findType,
		Critter@[]@+	critters
	)

bool SetParameterGetBehaviour	(	uint	index,
		string&	funcName
	)

bool SetParameterChangeBehaviour	(	uint	index,
		string&	funcName
	)

void SetSendParameter	(	int	index,
		bool	enabled
	)

void SetChosenSendParameter	(	int	index,
		bool	enabled
	)

GameVar GetGlobalVar

(

uint16

varId

)

GameVar GetLocalVar	(	uint16	varId,
		uint	masterId
	)

GameVar GetUnicumVar	(	uint16	varId,
		uint	masterId,
		uint	slaveId
	)

uint GetAllItems	(	uint16	pid,
		Item@[]@+	items
	)

ProtoItem GetProtoItem

(

uint16

protoId

)

uint GetBagItems	(	uint	bagId,
		uint16[]@+	pids,
		uint[]@+	minCounts,
		uint[]@+	maxCounts,
		int[]@+	slots
	)

void MoveItem	(	Item&	item,
		uint	count,
		Critter&	toCr
	)

void MoveItem	(	Item&	item,
		uint	count,
		Item&	toCont,
		uint	stackId
	)

void MoveItem	(	Item&	item,
		uint	count,
		Map&	toMap,
		uint16	toHx,
		uint16	toHy
	)

void MoveItems	(	Item@[]&	items,
		Critter&	toCr
	)

void MoveItem	(	Item@[]&	items,
		Item&	toCont,
		uint	stackId
	)

void MoveItems	(	Item@[]&	items,
		Map&	toMap,
		uint16	toHx,
		uint16	toHy
	)

void DeleteItem

(

Item&

item

)

void DeleteItems

(

Item@[]&

items

)

uint WorldItemCount

(

uint16

protoId

)

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
	)

uint GetFullSecond	(	uint16	year,
		uint16	month,
		uint16	day,
		uint16	hour,
		uint16	minute,
		uint16	second
	)

uint CreateTimeEvent	(	uint	beginSecond,
		string&	funcName,
		bool	save
	)

uint CreateTimeEvent	(	uint	beginSecond,
		string&	funcName,
		int	value,
		bool	save
	)

uint CreateTimeEvent	(	uint	beginSecond,
		string&	funcName,
		uint	value,
		bool	save
	)

uint CreateTimeEvent	(	uint	beginSecond,
		string&	funcName,
		int[]&	values,
		bool	save
	)

uint CreateTimeEvent	(	uint	beginSecond,
		string&	funcName,
		uint[]&	values,
		bool	save
	)

bool GetTimeEvent	(	uint	num,
		uint&	duration,
		uint[]@+	values
	)

bool GetTimeEvent	(	uint	num,
		uint&	duration,
		int[]@+	values
	)

bool SetTimeEvent	(	uint	num,
		uint	duration,
		uint[]@+	values
	)

bool SetTimeEvent	(	uint	num,
		uint	duration,
		int[]@+	values
	)

bool EraseTimeEvent

(

uint

num

)

void EraseAnyData

(

string&

name

)

bool GetAnyData	(	string&	name,
		int64[]&	data
	)

bool GetAnyData	(	string&	name,
		int32[]&	data
	)

bool GetAnyData	(	string&	name,
		int16[]&	data
	)

bool GetAnyData	(	string&	name,
		int8[]&	data
	)

bool GetAnyData	(	string&	name,
		uint64[]&	data
	)

bool GetAnyData	(	string&	name,
		uint32[]&	data
	)

bool GetAnyData	(	string&	name,
		uint16[]&	data
	)

bool GetAnyData	(	string&	name,
		uint8[]&	data
	)

bool IsAnyData

(

string&

name

)

bool SetAnyData	(	string&	name,
		int64[]&	data
	)

bool SetAnyData	(	string&	name,
		int32[]&	data
	)

bool SetAnyData	(	string&	name,
		int16[]&	data
	)

bool SetAnyData	(	string&	name,
		int8[]&	data
	)

bool SetAnyData	(	string&	name,
		uint64[]&	data
	)

bool SetAnyData	(	string&	name,
		uint32[]&	data
	)

bool SetAnyData	(	string&	name,
		uint16[]&	data
	)

bool SetAnyData	(	string&	name,
		uint8[]&	data
	)

bool SetAnyData	(	string&	name,
		int64[]&	data,
		uint	dataSize
	)

bool SetAnyData	(	string&	name,
		int32[]&	data,
		uint	dataSize
	)

bool SetAnyData	(	string&	name,
		int16[]&	data,
		uint	dataSize
	)

bool SetAnyData	(	string&	name,
		int8[]&	data,
		uint	dataSize
	)

bool SetAnyData	(	string&	name,
		uint64[]&	data,
		uint	dataSize
	)

bool SetAnyData	(	string&	name,
		uint32[]&	data,
		uint	dataSize
	)

bool SetAnyData	(	string&	name,
		uint16[]&	data,
		uint	dataSize
	)

bool SetAnyData	(	string&	name,
		uint8[]&	data,
		uint	dataSize
	)

---

Variable Documentation

const uint16 __Year

const uint16 __Month

const uint16 __Day

const uint16 __Hour

const uint16 __Minute

const uint16 __Second

const uint16 __FullSecond

const uint16 __TimeMultiplier

uint __Breaktime

(?)

uint __TimeoutTransfer

(?)

uint __TimeoutBattle

(?)

uint __ApRegeneration

(?)

uint __RtApCostCritterWalk

uint __RtApCostCritterRun

uint __RtApCostMoveItemContainer

(?)

uint __RtApCostMoveItemInventory

(?)

uint __RtApCostPickItem

(?)

uint __RtApCostDropItem

(?)

uint __RtApCostReloadWeapon

(?)

uint __RtApCostPickCritter

(?)

uint __RtApCostUseItem

(?)

uint __RtApCostUseSkill

(?)

uint __TbApCostCritterMove

(?)

uint __TbApCostMoveItemContainer

(?)

uint __TbApCostMoveItemInventory

(?)

uint __TbApCostPickItem

(?)

uint __TbApCostDropItem

(?)

uint __TbApCostReloadWeapon

(?)

uint __TbApCostPickCritter

(?)

uint __TbApCostUseItem

(?)

uint __TbApCostUseSkill

(?)

uint __ApCostAimEyes

(?)

uint __ApCostAimHead

(?)

uint __ApCostAimGroin

(?)

uint __ApCostAimTorso

(?)

uint __ApCostAimArms

(?)

uint __ApCostAimLegs

(?)

uint __HitAimEyes

(?)

uint __HitAimHead

(?)

uint __HitAimGroin

(?)

uint __HitAimTorso

(?)

uint __HitAimArms

(?)

uint __HitAimLegs

(?)

bool __RtAlwaysRun

bool __TbAlwaysRun

bool __AlwaysRun

uint __AlwaysRunMoveDist

uint __AlwaysRunUseDist

uint __GlobalMapWidth

uint __GlobalMapHeight

uint __GlobalMapZoneLength

uint __GlobalMapMaxGroupCount

uint __FixBoyDefaultExperience

uint __SneakDivider

bool __FreeExp

bool __RegulatePvP

bool __NoAnswerShuffle

bool __RunOnCombat

bool __RunOnTransfer

uint __CritterIdleTick

uint __LevelCap

bool __LevelCapAddExperience

uint __LookNormal

uint __LookMinimum

int __DeadHitPoints

uint __BagRefreshTime

See also:

Critter::GetBagRefreshTime

Critter::SetBagRefreshTime

uint __WisperDist

bool __CustomItemCost

uint __AccountPlayTime

bool __DialogDemandRecheck

uint __TalkDistance

See also:

ST_TALK_DISTANCE

uint __ShoutDist

float __SpritesZoom

float __SpritesZoomMax

float __SpritesZoomMin

uint __DlgTalkMinTime

uint __DlgBarterMinTime

int __LookChecks

uint __LookDir0

uint __LookDir1

uint __LookDir2

uint __LookDir3

uint __LookSneakDir0

uint __LookSneakDir1

uint __LookSneakDir2

uint __LookSneakDir3

uint __LookWeight

int __MouseX

int __MouseY

uint __EncounterTime