Critter Class Reference [Server API]

Critter. More...

---

Detailed Description

Critter.

Represents players, as well as NPCs.

List of all members.

Public Member Functions
Scripts and events
bool	SetScript (string@+ script)
	Assigns given script and calls initialization function with firstTime set to true.
uint	GetScriptId ()
	Retrieves the identifier of the script assigned to critter.
void	SetEvent (int eventType, string& funcName)
	Assigns the event handler for given event.
Invoking events
void	EventIdle ()
	Invokes CRITTER_EVENT_IDLE event.
void	EventFinish (bool deleted)
	Invokes CRITTER_EVENT_FINISH event.
void	EventDead (Critter@ killer)
	Invokes CRITTER_EVENT_DEAD event.
void	EventRespawn ()
	Invokes CRITTER_EVENT_RESPAWN event.
void	EventShowCritter (Critter& cr)
	Invokes CRITTER_EVENT_SHOW_CRITTER event.
void	EventHideCritter (Critter& cr)
	Invokes CRITTER_EVENT_HIDE_CRITTER event.
void	EventShowItemOnMap (Item& showItem, bool added, Critter@ dropper)
	Invokes CRITTER_EVENT_SHOW_ITEM_ON_MAP event.
void	EventChangeItemOnMap (Item& item)
	Invokes CRITTER_EVENT_CHANGE_ITEM_ON_MAP event.
void	EventHideItemOnMap (Item& hideItem, bool removed, Critter@ picker)
	Invokes CRITTER_EVENT_HIDE_ITEM_ON_MAP event.
bool	EventAttacked (Critter& attacker)
	Invokes CRITTER_EVENT_ATTACKED event.
void	EventStealing (Critter& thief, bool success, Item& item, uint count)
	Invokes CRITTER_EVENT_STEALING event.
void	EventMessage (Critter& fromCrit, int message, int value)
	Invokes CRITTER_EVENT_MESSAGE event.
bool	EventAttack (Critter& target)
	Invokes CRITTER_EVENT_ATTACK event.
bool	EventUseItem (Item& item, Critter@ onCritter, Item@ onItem, Scenery@ onScenery)
	Invokes CRITTER_EVENT_USE_ITEM event.
bool	EventUseSkill (int skill, Critter@ onCritter, Item@ onItem, Scenery@ onScenery)
	Invokes CRITTER_EVENT_USE_SKILL event.
void	EventDropItem (Item& item)
	Invokes CRITTER_EVENT_DROP_ITEM event.
void	EventMoveItem (Item& item, uint8 fromSlot)
	Invokes CRITTER_EVENT_MOVE_ITEM event.
void	EventKnockout (uint anim2begin, uint anim2idle, uint anim2end, uint lostAp, uint knockDist)
	Invokes CRITTER_EVENT_KNOCKOUT event.
void	EventSmthStealing (Critter& fromCrit, Critter& thief, bool success, Item& item, uint count)
	Invokes CRITTER_EVENT_SMTH_STEALING event.
void	EventSmthAttack (Critter& fromCrit, Critter& target)
	Invokes CRITTER_EVENT_SMTH_ATTACK event.
void	EventSmthAttack (Critter& fromCrit, Critter& target)
	Invokes CRITTER_EVENT_SMTH_ATTACKED event.
void	EventSmthUseItem (Critter& fromCrit, Item& item, Critter@ onCritter, Item@ onItem, Scenery@ onScenery)
	Invokes CRITTER_EVENT_SMTH_USE_ITEM event.
void	EventSmthUseSkill (Critter& fromCrit, int skill, Critter@ onCritter, Item@ onItem, Scenery@ onScenery)
	Invokes CRITTER_EVENT_SMTH_USE_SKILL event.
void	EventSmthDropItem (Critter& fromCrit, Item& item)
	Invokes CRITTER_EVENT_SMTH_DROP_ITEM event.
void	EventSmthMoveItem (Critter& fromCrit, Item& item, uint8 fromSlot)
	Invokes CRITTER_EVENT_SMTH_MOVE_ITEM event.
void	EventSmthKnockout (Critter& fromCrit, uint anim2begin, uint anim2idle, uint anim2end, uint lostAp, uint knockDist)
	Invokes CRITTER_EVENT_SMTH_KNOCKOUT event.
bool	EventBarter (Critter& cr, bool attach, uint barterCount)
	Invokes CRITTER_EVENT_BARTER event.
bool	EventTalk (Critter& cr, bool attach, uint talkCount)
	Invokes CRITTER_EVENT_TALK event.
bool	EventPlaneBegin (NpcPlane& plane, uint childIndex, int reason, Critter@ someCr, Item@ someItem)
	Invokes CRITTER_EVENT_PLANE_BEGIN event.
bool	EventPlaneEnd (NpcPlane& plane, uint childIndex, int reason, Critter@ someCr, Item@ someItem)
	Invokes CRITTER_EVENT_PLANE_END event.
bool	EventPlaneRun (NpcPlane& plane, uint childIndex, int reason, uint& p0, uint& p1, uint& p2)
	Invokes CRITTER_EVENT_PLANE_RUN event.
void	EventShowCritter1 (Critter& cr)
	Invokes CRITTER_EVENT_SHOW_CRITTER_1 event.
void	EventShowCritter2 (Critter& cr)
	Invokes CRITTER_EVENT_SHOW_CRITTER_2 event.
void	EventShowCritter3 (Critter& cr)
	Invokes CRITTER_EVENT_SHOW_CRITTER_3 event.
void	EventHideCritter1 (Critter& cr)
	Invokes CRITTER_EVENT_HIDE_CRITTER_1 event.
void	EventHideCritter2 (Critter& cr)
	Invokes CRITTER_EVENT_HIDE_CRITTER_2 event.
void	EventHideCritter3 (Critter& cr)
	Invokes CRITTER_EVENT_HIDE_CRITTER_3 event.
bool	EventGlobalProcess (int type, Critter& cr, Item@ car, uint& x, uint& y, uint& toX, uint& toY, uint& speed, uint& encounterDescriptor, bool& waitForAnswer)
	Invokes CRITTER_EVENT_GLOBAL_PROCESS event.
bool	EventGlobalInvite (Critter& leader, Item@ car, uint encounterDescriptor, int combatMode, uint& mapId, uint16& hexX, uint16& hexY, uint8& dir)
	Invokes CRITTER_EVENT_GLOBAL_INVITE event.
Map
Map	GetMap ()
	Returns a handler to the map object on which the critter is located in.
uint	GetMapId ()
	Retrieves the ID of the map critter is located in.
uint16	GetMapProtoId ()
	Retrieves the ID number of map proto the critter is located in.
int	GetFog (uint16 zoneX, uint16 zoneY)
	Gets fog of the player's worldmap, at given coordinates.
void	SetFog (uint16 zoneX, uint16 zoneY, int fog)
	Sets fog of the player's worldmap, at given coordinates.
Statistics
void	AddScore (int score, int value)
Inventory
uint	GetBagRefreshTime ()
void	SetBagRefreshTime (uint realMinutes)
uint	GetInternalBag (uint16[]@+ pids, uint[]@+ minCounts, uint[]@+ maxCounts, int[]@+ slots)
void	SetInternalBag (uint16[]& pids, uint[]@+ minCounts, uint[]@+ maxCounts, int[]@+ slots)
uint	ItemsCount ()
uint	ItemsWeight ()
uint	ItemsVolume ()
uint	CountItem (uint16 protoId)
Item	GetItem (uint16 protoId, int slot)
Item	GetItemById (uint itemId)
uint	GetItems (int slot, Item@[]@+ items)
uint	GetItemsByType (int type, Item@[]@+ items)
bool	MoveItem (uint objId, uint count, uint8 toSlot)
Item	AddItem (uint16 protoId, uint count)
bool	DeleteItem (uint16 protoId, uint count)
bool	PickItem (uint16 hexX, uint16 hexY, uint16 protoId)
uint16	GetFavoriteItem (int slot)
void	SetFavoriteItem (int slot, uint16 pid)
ProtoItem	GetSlotProto (int slot)
Movement
bool	MoveRandom ()
bool	MoveToDir (uint8 dir)
void	SetDir (uint8 dir)
void	SetHomePos (uint16 hexX, uint16 hexY, uint8 dir)
void	GetHomePos (uint& mapId, uint16& hexX, uint16& hexY, uint8& dir)
bool	TransitToGlobal (bool requestGroup)
bool	TransitToGlobal (Critter@[]& group)
bool	TransitToGlobalGroup (uint critterId)
bool	TransitToHex (uint16 hexX, uint16 hexY, uint8 dir)
bool	TransitToMap (uint mapId, uint16 hexX, uint16 hexY, uint8 dir)
bool	TransitToMap (uint mapId, uint8 entireNum)
Talk
void	Say (uint8 howSay, string@ text)
void	SayMsg (uint8 howSay, uint16 textMsg, uint strNum)
void	SayMsg (uint8 howSay, uint16 textMsg, uint strNum, string& lexems)
Locations
bool	IsKnownLoc (bool byId, uint locNum)
bool	SetKnownLoc (bool byId, uint locNum)
bool	UnsetKnownLoc (bool byId, uint locNum)
Plans
bool	AddPlane (NpcPlane@+ plane)
bool	ErasePlane (uint index)
uint	ErasePlane (int planeType, bool all)
NpcPlane	GetCurPlane ()
uint	GetPlanes (NpcPlane@[]@+ planes)
bool	IsNoPlanes ()
uint	GetPlanes (int identifier, NpcPlane@[]@+ planes)
uint	GetPlanesByExt (uint identifierExt, NpcPlane@[]@+ planes)
uint	GetPlanes (int identifier, uint identifierExt, NpcPlane@[]@+ planes)
void	DropPlanes ()
	Drops all NPC planes.
Notifications
void	SendQuestVar (GameVar& var)
void	SendCombatResult (uint[]& combatResult)
	Sends the results of the combat to players.
void	SetSendParam (uint index, bool enabled)
void	SendMessage (int num, int val, int to)
State
bool	IsFree ()
bool	IsBusy ()
bool	IsDead ()
bool	IsKnockout ()
bool	IsLife ()
void	ToDead (uint anim2, Critter@+ killer)
bool	ToKnockout (uint anim2begin, uint anim2idle, uint anim2end, uint lostAp, uint16 knockHx, uint16 knockHy)
bool	ToLife ()
Animation
void	Animate (uint anim1, uint anim2, Item@+ item, bool clearSequence, bool delayPlay)
bool	ChangeCrType (uint newType)
bool	IsAnim1 (uint index)
void	SetAnims (int cond, uint anim1, uint anim2)
Party
uint	GetFollowGroup (int findType, Critter@[]@+ critters)
Critter	GetFollowLeader ()
Critter[]	GetGlobalGroup ()
Enemy stack
Maximum size of stack – 30.
void	AddEnemyInStack (uint critterId)
void	ChangeEnemyStackSize (uint newSize)
bool	CheckEnemyInStack (uint critterId)
void	ClearEnemyStack ()
void	EraseEnemyFromStack (uint critterId)
void	GetEnemyStack (uint[]& enemyStack)
Holodisks
void	AddHolodiskInfo (uint holodiskNum)
void	EraseHolodiskInfo (uint holodiskNum)
bool	IsHolodiskInfo (uint holodiskNum)
Critter time events
bool	AddTimeEvent (string& funcName, uint duration, int identifier)
bool	AddTimeEvent (string& funcName, uint duration, int identifier, uint rate)
void	ChangeTimeEvent (uint index, uint newDuration, uint newRate)
uint	GetTimeEvents (int identifier, uint[]@+ indexes, uint[]@+ durations, uint[]@+ rates)
uint	GetTimeEvents (int[]& findIdentifiers, int[]@+ identifiers, uint[]@+ indexes, uint[]@+ durations, uint[]@+ rates)
void	EraseTimeEvent (uint index)
uint	EraseTimeEvents (int identifier)
uint	EraseTimeEvents (int[]& identifiers)
Multihex
uint	GetMultihex ()
void	SetMultihex (int value)
Miscellaneous
uint16	GetProtoId ()
bool	IsNpc ()
bool	IsPlayer ()
void	Wait (uint ms)
void	ShowContainer (Critter@+ contCr, Item@+ contItem, uint8 transferType)
uint	GetCritters (bool lookOnMe, int findType, Critter@[]@+ critters)
uint	GetTalkedPlayers (Critter@[]@+ players)
void	DropTimers ()
void	ShowScreen (int screenType, uint param, string& funcName)
void	PlaySound (string& soundName, bool sendSelf)
void	PlaySound (uint8 soundType, uint8 soundTypeExt, uint8 soundId, uint8 soundIdExt, bool sendSelf)
void	RunClientScript (string& funcName, int p0, int p1, int p2, string@+ p3, int[]@+ p4)
void	SetLexems (string@+ lexems)
bool	IsCanWalk ()
bool	IsCanRun ()
bool	IsCanRotate ()
bool	IsCanAim ()
int	GetAccess ()
	Позволяет получить уровень доступа игрока.
bool	IsSee (Critter& cr)
bool	IsSeenBy (Critter& cr)
bool	IsSee (Item& item)
void	RefreshVisible ()
void	Action (int action, int actionExt, Item@+ item)
Public Attributes
General fields
const uint	Id
	Critter's unique identifier.
const bool	IsNotValid
	Allows to check whether underlying object is valid.
const uint8	CrType
	Critter common animation type.
const uint16	HexX
	Critter's location on the map, X axis.
const uint16	HexY
	Critter's location on the map, Y axis.
const uint16	WorldX
	Critter's position on worldmap, X-coordinate.
const uint16	WorldY
	Critter's position on worldmap, Y-coordinate.
const uint8	Dir
	Critter's direction.
const uint8	Cond
	Current Critter's condition (see Critter basic conditions).
const uint8	CondExt
	Critter's extended condition (see Extended critter conditions).
const uint16	FlagsExt
int	NpcRole
	Value describing role of the npc - usage depends on script.
uint	ShowCritterDist1
	Distance used by following events CRITTER_EVENT_SHOW_CRITTER_1 and CRITTER_EVENT_HIDE_CRITTER_1.
uint	ShowCritterDist2
	Distance used by following events CRITTER_EVENT_SHOW_CRITTER_2 and CRITTER_EVENT_HIDE_CRITTER_2.
uint	ShowCritterDist3
	Distance used by following events CRITTER_EVENT_SHOW_CRITTER_3 and CRITTER_EVENT_HIDE_CRITTER_3.
bool	IsRuning
const uint	Life
const uint	Knockout
const uint	Dead
DataVal	Param
DataRef	ParamBase

---

Member Function Documentation

bool SetScript

(

string@+

script

)

Assigns given script and calls initialization function with firstTime set to true.

Parameters:

script

Script name.

Returns:

true in case of success; false otherwise.

Remarks:

If the script or the funtion can not be found, the new script will not be set.

uint GetScriptId

(

)

Retrieves the identifier of the script assigned to critter.

See _scripts.fos, scripts.lst.

Returns:

Identifier of the script used by critter, 0 if no assigned.

void SetEvent	(	int	eventType,
		string&	funcName
	)

Assigns the event handler for given event.

Parameters:

	eventType	Type of the event (see Critter events).
	funcName	Name of the function that will be attached as event handler.

void EventIdle

(

)

Invokes CRITTER_EVENT_IDLE event.

void EventFinish

(

bool

deleted

)

Invokes CRITTER_EVENT_FINISH event.

void EventDead

(

Critter@

killer

)

Invokes CRITTER_EVENT_DEAD event.

void EventRespawn

(

)

Invokes CRITTER_EVENT_RESPAWN event.

void EventShowCritter

(

Critter&

cr

)

Invokes CRITTER_EVENT_SHOW_CRITTER event.

void EventHideCritter

(

Critter&

cr

)

Invokes CRITTER_EVENT_HIDE_CRITTER event.

void EventShowItemOnMap	(	Item&	showItem,
		bool	added,
		Critter@	dropper
	)

Invokes CRITTER_EVENT_SHOW_ITEM_ON_MAP event.

void EventChangeItemOnMap

(

Item&

item

)

Invokes CRITTER_EVENT_CHANGE_ITEM_ON_MAP event.

void EventHideItemOnMap	(	Item&	hideItem,
		bool	removed,
		Critter@	picker
	)

Invokes CRITTER_EVENT_HIDE_ITEM_ON_MAP event.

bool EventAttacked

(

Critter&

attacker

)

Invokes CRITTER_EVENT_ATTACKED event.

void EventStealing	(	Critter&	thief,
		bool	success,
		Item&	item,
		uint	count
	)

Invokes CRITTER_EVENT_STEALING event.

void EventMessage	(	Critter&	fromCrit,
		int	message,
		int	value
	)

Invokes CRITTER_EVENT_MESSAGE event.

bool EventAttack

(

Critter&

target

)

Invokes CRITTER_EVENT_ATTACK event.

bool EventUseItem	(	Item&	item,
		Critter@	onCritter,
		Item@	onItem,
		Scenery@	onScenery
	)

Invokes CRITTER_EVENT_USE_ITEM event.

bool EventUseSkill	(	int	skill,
		Critter@	onCritter,
		Item@	onItem,
		Scenery@	onScenery
	)

Invokes CRITTER_EVENT_USE_SKILL event.

void EventDropItem

(

Item&

item

)

Invokes CRITTER_EVENT_DROP_ITEM event.

void EventMoveItem	(	Item&	item,
		uint8	fromSlot
	)

Invokes CRITTER_EVENT_MOVE_ITEM event.

void EventKnockout	(	uint	anim2begin,
		uint	anim2idle,
		uint	anim2end,
		uint	lostAp,
		uint	knockDist
	)

Invokes CRITTER_EVENT_KNOCKOUT event.

void EventSmthStealing	(	Critter&	fromCrit,
		Critter&	thief,
		bool	success,
		Item&	item,
		uint	count
	)

Invokes CRITTER_EVENT_SMTH_STEALING event.

void EventSmthAttack	(	Critter&	fromCrit,
		Critter&	target
	)

Invokes CRITTER_EVENT_SMTH_ATTACK event.

void EventSmthAttack	(	Critter&	fromCrit,
		Critter&	target
	)

Invokes CRITTER_EVENT_SMTH_ATTACKED event.

void EventSmthUseItem	(	Critter&	fromCrit,
		Item&	item,
		Critter@	onCritter,
		Item@	onItem,
		Scenery@	onScenery
	)

Invokes CRITTER_EVENT_SMTH_USE_ITEM event.

void EventSmthUseSkill	(	Critter&	fromCrit,
		int	skill,
		Critter@	onCritter,
		Item@	onItem,
		Scenery@	onScenery
	)

Invokes CRITTER_EVENT_SMTH_USE_SKILL event.

void EventSmthDropItem	(	Critter&	fromCrit,
		Item&	item
	)

Invokes CRITTER_EVENT_SMTH_DROP_ITEM event.

void EventSmthMoveItem	(	Critter&	fromCrit,
		Item&	item,
		uint8	fromSlot
	)

Invokes CRITTER_EVENT_SMTH_MOVE_ITEM event.

void EventSmthKnockout	(	Critter&	fromCrit,
		uint	anim2begin,
		uint	anim2idle,
		uint	anim2end,
		uint	lostAp,
		uint	knockDist
	)

Invokes CRITTER_EVENT_SMTH_KNOCKOUT event.

bool EventBarter	(	Critter&	cr,
		bool	attach,
		uint	barterCount
	)

Invokes CRITTER_EVENT_BARTER event.

bool EventTalk	(	Critter&	cr,
		bool	attach,
		uint	talkCount
	)

Invokes CRITTER_EVENT_TALK event.

bool EventPlaneBegin	(	NpcPlane&	plane,
		uint	childIndex,
		int	reason,
		Critter@	someCr,
		Item@	someItem
	)

Invokes CRITTER_EVENT_PLANE_BEGIN event.

bool EventPlaneEnd	(	NpcPlane&	plane,
		uint	childIndex,
		int	reason,
		Critter@	someCr,
		Item@	someItem
	)

Invokes CRITTER_EVENT_PLANE_END event.

bool EventPlaneRun	(	NpcPlane&	plane,
		uint	childIndex,
		int	reason,
		uint&	p0,
		uint&	p1,
		uint&	p2
	)

Invokes CRITTER_EVENT_PLANE_RUN event.

void EventShowCritter1

(

Critter&

cr

)

Invokes CRITTER_EVENT_SHOW_CRITTER_1 event.

void EventShowCritter2

(

Critter&

cr

)

Invokes CRITTER_EVENT_SHOW_CRITTER_2 event.

void EventShowCritter3

(

Critter&

cr

)

Invokes CRITTER_EVENT_SHOW_CRITTER_3 event.

void EventHideCritter1

(

Critter&

cr

)

Invokes CRITTER_EVENT_HIDE_CRITTER_1 event.

void EventHideCritter2

(

Critter&

cr

)

Invokes CRITTER_EVENT_HIDE_CRITTER_2 event.

void EventHideCritter3

(

Critter&

cr

)

Invokes CRITTER_EVENT_HIDE_CRITTER_3 event.

bool EventGlobalProcess	(	int	type,
		Critter&	cr,
		Item@	car,
		uint&	x,
		uint&	y,
		uint&	toX,
		uint&	toY,
		uint&	speed,
		uint&	encounterDescriptor,
		bool&	waitForAnswer
	)

Invokes CRITTER_EVENT_GLOBAL_PROCESS event.

bool EventGlobalInvite	(	Critter&	leader,
		Item@	car,
		uint	encounterDescriptor,
		int	combatMode,
		uint&	mapId,
		uint16&	hexX,
		uint16&	hexY,
		uint8&	dir
	)

Invokes CRITTER_EVENT_GLOBAL_INVITE event.

Map GetMap

(

)

Returns a handler to the map object on which the critter is located in.

Returns:

Handler to the Map object in case of success, otherwise – null.

uint GetMapId

(

)

Retrieves the ID of the map critter is located in.

Returns:

Map's ID. In case of failure (e.g. critter on worldmap) – 0.

uint16 GetMapProtoId

(

)

Retrieves the ID number of map proto the critter is located in.

Returns:

Map's proto ID. In case of failure (e.g. critter on worldmap) – 0.

int GetFog	(	uint16	zoneX,
		uint16	zoneY
	)

Gets fog of the player's worldmap, at given coordinates.

Parameters:

zoneX,zoneY

Coordinates.

Returns:

Fog type, see Global map fog.

See also:

SetFog

void SetFog	(	uint16	zoneX,
		uint16	zoneY,
		int	fog
	)

Sets fog of the player's worldmap, at given coordinates.

Parameters:

	zoneX,zoneY	Coordinates.
	fog	Fog type, see Global map fog.

See also:

GetFog

void AddScore	(	int	score,
		int	value
	)

uint GetBagRefreshTime

(

)

void SetBagRefreshTime

(

uint

realMinutes

)

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

void SetInternalBag	(	uint16[]&	pids,
		uint[]@+	minCounts,
		uint[]@+	maxCounts,
		int[]@+	slots
	)

uint ItemsCount

(

)

uint ItemsWeight

(

)

uint ItemsVolume

(

)

uint CountItem

(

uint16

protoId

)

Item GetItem	(	uint16	protoId,
		int	slot
	)

Item GetItemById

(

uint

itemId

)

uint GetItems	(	int	slot,
		Item@[]@+	items
	)

uint GetItemsByType	(	int	type,
		Item@[]@+	items
	)

bool MoveItem	(	uint	objId,
		uint	count,
		uint8	toSlot
	)

Item AddItem	(	uint16	protoId,
		uint	count
	)

bool DeleteItem	(	uint16	protoId,
		uint	count
	)

bool PickItem	(	uint16	hexX,
		uint16	hexY,
		uint16	protoId
	)

uint16 GetFavoriteItem

(

int

slot

)

void SetFavoriteItem	(	int	slot,
		uint16	pid
	)

ProtoItem GetSlotProto

(

int

slot

)

bool MoveRandom

(

)

bool MoveToDir

(

uint8

dir

)

void SetDir

(

uint8

dir

)

void SetHomePos	(	uint16	hexX,
		uint16	hexY,
		uint8	dir
	)

void GetHomePos	(	uint&	mapId,
		uint16&	hexX,
		uint16&	hexY,
		uint8&	dir
	)

bool TransitToGlobal

(

bool

requestGroup

)

bool TransitToGlobal

(

Critter@[]&

group

)

bool TransitToGlobalGroup

(

uint

critterId

)

bool TransitToHex	(	uint16	hexX,
		uint16	hexY,
		uint8	dir
	)

bool TransitToMap	(	uint	mapId,
		uint16	hexX,
		uint16	hexY,
		uint8	dir
	)

bool TransitToMap	(	uint	mapId,
		uint8	entireNum
	)

void Say	(	uint8	howSay,
		string@	text
	)

void SayMsg	(	uint8	howSay,
		uint16	textMsg,
		uint	strNum
	)

void SayMsg	(	uint8	howSay,
		uint16	textMsg,
		uint	strNum,
		string&	lexems
	)

bool IsKnownLoc	(	bool	byId,
		uint	locNum
	)

bool SetKnownLoc	(	bool	byId,
		uint	locNum
	)

bool UnsetKnownLoc	(	bool	byId,
		uint	locNum
	)

bool AddPlane

(

NpcPlane@+

plane

)

bool ErasePlane

(

uint

index

)

uint ErasePlane	(	int	planeType,
		bool	all
	)

NpcPlane GetCurPlane

(

)

uint GetPlanes

(

NpcPlane@[]@+

planes

)

bool IsNoPlanes

(

)

uint GetPlanes	(	int	identifier,
		NpcPlane@[]@+	planes
	)

uint GetPlanesByExt	(	uint	identifierExt,
		NpcPlane@[]@+	planes
	)

uint GetPlanes	(	int	identifier,
		uint	identifierExt,
		NpcPlane@[]@+	planes
	)

void DropPlanes

(

)

Drops all NPC planes.

void SendQuestVar

(

GameVar&

var

)

void SendCombatResult

(

uint[]&

combatResult

)

Sends the results of the combat to players.

Parameters:

combatResult

Result to send. First uint should be equal the combatResult length, then it should be followed by any number of records (for their definition, look in combat_msg.fos).

Remarks:

Only for players.

void SetSendParam	(	uint	index,
		bool	enabled
	)

void SendMessage	(	int	num,
		int	val,
		int	to
	)

bool IsFree

(

)

bool IsBusy

(

)

bool IsDead

(

)

bool IsKnockout

(

)

bool IsLife

(

)

void ToDead	(	uint	anim2,
		Critter@+	killer
	)

bool ToKnockout	(	uint	anim2begin,
		uint	anim2idle,
		uint	anim2end,
		uint	lostAp,
		uint16	knockHx,
		uint16	knockHy
	)

bool ToLife

(

)

void Animate	(	uint	anim1,
		uint	anim2,
		Item@+	item,
		bool	clearSequence,
		bool	delayPlay
	)

See also:

animation2d_process

animation3d_process

bool ChangeCrType

(

uint

newType

)

bool IsAnim1

(

uint

index

)

void SetAnims	(	int	cond,
		uint	anim1,
		uint	anim2
	)

uint GetFollowGroup	(	int	findType,
		Critter@[]@+	critters
	)

Critter GetFollowLeader

(

)

Critter [] GetGlobalGroup

(

)

void AddEnemyInStack

(

uint

critterId

)

void ChangeEnemyStackSize

(

uint

newSize

)

bool CheckEnemyInStack

(

uint

critterId

)

void ClearEnemyStack

(

)

void EraseEnemyFromStack

(

uint

critterId

)

void GetEnemyStack

(

uint[]&

enemyStack

)

void AddHolodiskInfo

(

uint

holodiskNum

)

void EraseHolodiskInfo

(

uint

holodiskNum

)

bool IsHolodiskInfo

(

uint

holodiskNum

)

bool AddTimeEvent	(	string&	funcName,
		uint	duration,
		int	identifier
	)

bool AddTimeEvent	(	string&	funcName,
		uint	duration,
		int	identifier,
		uint	rate
	)

void ChangeTimeEvent	(	uint	index,
		uint	newDuration,
		uint	newRate
	)

uint GetTimeEvents	(	int	identifier,
		uint[]@+	indexes,
		uint[]@+	durations,
		uint[]@+	rates
	)

uint GetTimeEvents	(	int[]&	findIdentifiers,
		int[]@+	identifiers,
		uint[]@+	indexes,
		uint[]@+	durations,
		uint[]@+	rates
	)

void EraseTimeEvent

(

uint

index

)

uint EraseTimeEvents

(

int

identifier

)

uint EraseTimeEvents

(

int[]&

identifiers

)

uint GetMultihex

(

)

void SetMultihex

(

int

value

)

uint16 GetProtoId

(

)

bool IsNpc

(

)

bool IsPlayer

(

)

void Wait

(

uint

ms

)

void ShowContainer	(	Critter@+	contCr,
		Item@+	contItem,
		uint8	transferType
	)

uint GetCritters	(	bool	lookOnMe,
		int	findType,
		Critter@[]@+	critters
	)

uint GetTalkedPlayers

(

Critter@[]@+

players

)

void DropTimers

(

)

void ShowScreen	(	int	screenType,
		uint	param,
		string&	funcName
	)

void PlaySound	(	string&	soundName,
		bool	sendSelf
	)

void PlaySound	(	uint8	soundType,
		uint8	soundTypeExt,
		uint8	soundId,
		uint8	soundIdExt,
		bool	sendSelf
	)

void RunClientScript	(	string&	funcName,
		int	p0,
		int	p1,
		int	p2,
		string@+	p3,
		int[]@+	p4
	)

void SetLexems

(

string@+

lexems

)

bool IsCanWalk

(

)

bool IsCanRun

(

)

bool IsCanRotate

(

)

bool IsCanAim

(

)

int GetAccess

(

)

Позволяет получить уровень доступа игрока.

Returns:

Уровень доступа игрока (см. Access levels).

bool IsSee

(

Critter&

cr

)

bool IsSeenBy

(

Critter&

cr

)

bool IsSee

(

Item&

item

)

void RefreshVisible

(

)

void Action	(	int	action,
		int	actionExt,
		Item@+	item
	)

See also:

critter_action

---

Member Data Documentation

const uint Id

Critter's unique identifier.

See also:

GetCritter(uint)

const bool IsNotValid

Allows to check whether underlying object is valid.

const uint8 CrType

Critter common animation type.

const uint16 HexX

Critter's location on the map, X axis.

const uint16 HexY

Critter's location on the map, Y axis.

const uint16 WorldX

Critter's position on worldmap, X-coordinate.

const uint16 WorldY

Critter's position on worldmap, Y-coordinate.

const uint8 Dir

Critter's direction.

const uint8 Cond

Current Critter's condition (see Critter basic conditions).

const uint8 CondExt

Critter's extended condition (see Extended critter conditions).

const uint16 FlagsExt

int NpcRole

Value describing role of the npc - usage depends on script.

See also:

Map::GetNpc

uint ShowCritterDist1

Distance used by following events CRITTER_EVENT_SHOW_CRITTER_1 and CRITTER_EVENT_HIDE_CRITTER_1.

uint ShowCritterDist2

Distance used by following events CRITTER_EVENT_SHOW_CRITTER_2 and CRITTER_EVENT_HIDE_CRITTER_2.

uint ShowCritterDist3

Distance used by following events CRITTER_EVENT_SHOW_CRITTER_3 and CRITTER_EVENT_HIDE_CRITTER_3.

bool IsRuning

const uint Life

const uint Knockout

const uint Dead

DataVal Param

DataRef ParamBase