Built-in definitions for Nox Script. More...

Enumerations
enum	AudioEvent
	Audio events. More...

enum	Class
	Class names. More...

enum	DamageType
	Damange types. More...

enum	Effect
	Effects. More...

enum	Enchant
	Enchants. More...

enum	Direction
	Facing directions. More...

enum	Spell
	Spell names. More...

enum	Subclass
	Subclass names. More...

Functions
object	Wall (int x, int y)
	Get a pointer to a wall by its wall coordinates. More...

void	WallOpen (object wall)
	Open a wall. More...

void	WallGroupOpen (object wallGroup)
	Open walls in a group. More...

void	WallClose (object wall)
	Close a wall. More...

void	WallGroupClose (object wallGroup)
	Close walls in a group. More...

void	WallToggle (object wall)
	Toggle a wall. More...

void	WallGroupToggle (object wallGroup)
	Toggle walls in a group. More...

void	WallBreak (object wall)
	Breaks a wall. More...

void	WallGroupBreak (object wallGroup)
	Breaks walls in a group. More...

int	SecondTimer (int seconds, function callback)
	Create a timer with delay in seconds. More...

int	FrameTimer (int frames, function callback)
	Create a timer with delay in frames. More...

void	Move (int id, object waypoint)
	Move an object to a waypoint. More...

void	GroupMove (object objectGroup, object waypoint)
	Move objects in a group to a waypoint. More...

void	LookAtDirection (int id, int direction)
	Cause object to look in a direction. More...

void	GroupLookAtDirection (object objectGroup, int direction)
	Cause objects in a group to look in a direction. More...

void	ObjectOn (int id)
	Enable an object. More...

void	ObjectGroupOn (object objectGroup)
	Enable objects in a group. More...

void	WayPointOn (object waypoint)
	Enable a waypoint. More...

void	WayPointGroupOn (object waypointGroup)
	Enable waypoints in a group. More...

void	ObjectOff (int id)
	Disable an object. More...

void	ObjectGroupOff (object objectGroup)
	Disable objects in a group. More...

void	WayPointOff (object waypoint)
	Disable a waypoint. More...

void	WayPointGroupOff (object waypointGroup)
	Disable waypoints in a group. More...

void	ObjectToggle (int id)
	Toggle whether object is disabled. More...

void	ObjectGroupToggle (object objectGroup)
	Toggle whether objects in group are disabled. More...

void	WayPointToggle (object waypoint)
	Toggle whether waypoint is disabled. More...

void	WayPointGroupToggle (object waypointGroup)
	Toggle whether objects in group are disabled. More...

void	Delete (int id)
	Delete an object. More...

void	GroupDelete (object objectGroup)
	Delete objects in a group. More...

void	Wander (int id)
	Cause an object to wander. More...

void	GroupWander (object objectGroup)
	Cause objects in a group to wander. More...

void	GoBackHome (int id)
	Cause object to move to its starting location. More...

void	AudioEvent (string audio, object waypoint)
	Play an audio event at a location. More...

void	Print (string message)
	Display a localized string. More...

void	PrintToAll (string message)
	Display a localized string to everyone. More...

void	Chat (int id, string message)
	Cause an object to say a localized string. More...

void	StopScript (any value)
	Exit current script function. More...

void	UnlockDoor (int id)
	Unlock a door. More...

void	LockDoor (int id)
	Lock a door. More...

int	IsObjectOn (int id)
	Get whether object is enabled. More...

int	IsWaypointOn (object waypoint)
	Get whether waypoint is enabled. More...

int	IsLocked (int id)
	Get whether object is locked. More...

float	RandomFloat (float min, float max)
	Random number (float). More...

int	Random (int min, int max)
	Random number (int). More...

int	SecondTimerWithArg (int seconds, any argument, function callback)
	Create a timer with delay in seconds with an argument. More...

int	FrameTimerWithArg (int frames, any argument, function callback)
	Create a timer with delay in frames with an argument. More...

string	IntToString (int number)
	Convert an integer to a string. More...

string	FloatToString (float number)
	Convert a float to a string. More...

int	CreateObject (string type, object waypoint)
	Create an object at a location. More...

void	Damage (int target, int source, int amount, int type)
	Damages an object. More...

void	GroupDamage (object targetGroup, int source, int amount, int type)
	Damages objects in a group. More...

int	CreateMover (int id, object waypoint, float speed)
	Creates a Mover for an object. More...

void	GroupCreateMover (object objectGroup, object waypoint, float speed)
	Creates a Mover for every object in a group. More...

int	AwardSpell (int id, string spell)
	Award spell level to object. More...

void	GroupAwardSpell (object objectGroup, string spell)
	Award spell level to objects in a group. More...

void	Enchant (int id, string enchant, float duration)
	Grant object an enchantment. More...

void	GroupEnchant (int id, string enchant, float duration)
	Grant objects in a group an enchantment. More...

int	GetHost ()
	Get host's player object. More...

int	Object (string name)
	Lookup an object by name. More...

float	GetObjectX (int id)
	Get object X coordinate. More...

float	GetWaypointX (object waypoint)
	Get waypoint X coordinate. More...

float	GetObjectY (int id)
	Get object Y coordinate. More...

float	GetWaypointY (object waypoint)
	Get waypoint Y coordinate. More...

float	GetObjectZ (int id)
	Get object Z coordinate. More...

int	GetDirection (int id)
	Get object direction. More...

void	MoveObject (int id, float x, float y)
	Set an object's location. More...

void	MoveWaypoint (object waypoint, float x, float y)
	Set a waypoint's location. More...

void	Raise (int id, float z)
	Set an object's Z coordinate. More...

void	LookWithAngle (int id, int angle)
	Set an object's direction. More...

void	PushObjectTo (int id, float x, float y)
	Push an object to a location. More...

void	PushObject (int id, float magnitude, float x, float y)
	Push an object from a vector and magnitude. More...

int	GetLastItem (int id)
	Get object's last inventory item. More...

int	GetPreviousItem (int id)
	Get previous inventory item. More...

int	HasItem (int holder, int item)
	Get whether the item is in the object's inventory. More...

int	GetHolder (int item)
	Get the holder of an item. More...

int	Pickup (int id, int item)
	Cause object to pickup an item. More...

int	Drop (int id, int item)
	Cause object to drop an item. More...

int	HasClass (int id, string className)
	Get whether object has a class. More...

int	HasEnchant (int id, string enchant)
	Get whether object has an enchant. More...

void	EnchantOff (int id, string enchant)
	Remove enchant from an object. More...

int	CurrentHealth (int id)
	Get object's health. More...

int	MaxHealth (int id)
	Get object's maximum health. More...

void	RestoreHealth (int id, int amount)
	Restore object's health. More...

float	Distance (float x1, float y1, float x2, float y2)
	Calculate distance between two locations. More...

int	IsVisibleTo (int object1, int object2)
	Gets whether an object can see another object. More...

int	GetCharacterData (int idx)
	Get character data. More...

void	LookAtObject (int id, int target)
	Set direction of object so it is looking at another object. More...

void	Walk (int id, float x, float y)
	Causes an object to walk to a location. More...

void	GroupWalk (object objectGroup, float x, float y)
	Causes objects in a group to walk to a location. More...

int	CancelTimer (int id)
	Cancel a timer. More...

void	Effect (string effect, float x1, float y1, float x2, float y2)
	Trigger an effect. More...

void	SetOwner (int owner, int target)
	Set the owner of an object. More...

void	GroupSetOwner (int owner, object targets)
	Set the owner of objects in a group. More...

void	SetOwners (object owners, int target)
	Set the objects in a group as owners of target. More...

void	GroupSetOwners (object owners, object targets)
	Set the objects in a group as owners of target. More...

int	IsOwnedBy (int id, int target)
	Get whether target is owned by object. More...

int	GroupIsOwnedBy (int id, object target)
	Get whether any object in target group is owned by object. More...

int	IsOwnedByAny (object objectGroup, int target)
	Get whether target is owned by any object in the group. More...

int	GroupIsOwnedByAny (object objectGroup, object target)
	Get whether any object in target is owned by any object in the group. More...

void	ClearOwner (int id)
	Clear the owner of an object. More...

object	Waypoint (string name)
	Lookup waypoint by name. More...

object	WaypointGroup (string name)
	Lookup waypoint group by name. More...

object	ObjectGroup (string name)
	Lookup object group by name. More...

object	WallGroup (string name)
	Lookup wall group by name. More...

void	ChatTimerSeconds (int id, string message, int duration)
	Cause an object to say a localized string for duration in seconds. More...

void	ChatTimer (int id, string message, int duration)
	Cause an object to say a localized string for duration in frames. More...

void	DestroyChat (int id)
	Destroys object's speech bubble. More...

void	DestroyEveryChat ()
	Destroys all speech bubbles. More...

void	SetQuestStatus (int status, string name)
	Set quest status (int). More...

void	SetQuestStatusFloat (float status, string name)
	Set quest status (float). More...

int	GetQuestStatus (string name)
	Get quest status (int). More...

float	GetQuestStatusFloat (string name)
	Get quest status (int). More...

void	ResetQuestStatus (string name)
	Delete quest status. More...

int	IsTrigger (int id)
	Get whether object is SELF. More...

int	IsCaller (int id)
	Get whether object is OTHER. More...

void	SetDialog (int id, string type, function start, function end)
	Setup a conversation with object. More...

void	CancelDialog (int id)
	Cancel a conversation with object. More...

void	StoryPic (int id, string name)
	Assigns a picture to a conversation. More...

void	TellStory (string audio, string story)
	Causes the telling of a story. More...

void	StartDialog (int npc, int other)
	Starts a conversation between two objects. More...

void	CastSpellObjectObject (string spell, int source, int target)
	Casts a spell from source to target. More...

void	CastSpellObjectLocation (string spell, int source, float x, float y)
	Casts a spell from source to target. More...

void	CastSpellLocationObject (string spell, float x, float y, int target)
	Casts a spell from source to target. More...

void	CastSpellLocationLocation (string spell, float x1, float y1, float x2, float y2)
	Casts a spell from source to target. More...

void	UnBlind ()
	Unblind the host. More...

void	Blind ()
	Blind the host. More...

void	WideScreen (int value)

int	GetElevatorStatus (int id)
	Get elevator status. More...

void	CreatureGuard (int id, float x1, float y1, float x2, float y2, float distance)
	Cause a creature to guard a location. More...

void	CreatureGroupGuard (object objectGroup, float x1, float y1, float x2, float y2, float distance)
	Cause creatures in a group to guard a location. More...

void	CreatureHunt (int id)
	Cause creature to hunt. More...

void	CreatureGroupHunt (object objectGroup)
	Cause creatures in a group to hunt. More...

void	CreatureIdle (int id)
	Cause creature to idle. More...

void	CreatureGroupIdle (object objectGroup)
	Cause creatures in a group to idle. More...

void	CreatureFollow (int id, int target)
	Cause creature to follow an object. More...

void	CreatureGroupFollow (object objectGroup, int target)
	Cause creatures in a group to follow an object. More...

void	AggressionLevel (int id, float level)
	Set creature's aggression level. More...

void	GroupAggressionLevel (object objectGroup, float level)
	Set group of creature's aggression level. More...

void	HitLocation (int id, float x, float y)
	Melee attack a location. More...

void	GroupHitLocation (object objectGroup, float x, float y)
	Melee attack a location. More...

void	HitFarLocation (int id, float x, float y)
	Ranged attack a location. More...

void	GroupHitFarLocation (object objectGroup, float x, float y)
	Ranged attack a location. More...

void	SetRoamFlag (int id, int flags)
	Set roaming flags. More...

void	GroupSetRoamFlag (object objectGroup, int flags)
	Set roaming flags. More...

void	Attack (int id, int target)
	Attack an object. More...

void	GroupAttack (object objectGroup, int target)
	Attack an object. More...

void	JournalEntry (int id, string message, int type)
	Add entry to player's journal. More...

void	JournalDelete (int id, string message)
	Delete entry from player's journal. More...

void	JournalEdit (int id, string message, int type)
	Edit entry in player's journal. More...

void	RetreatLevel (int id, float percent)
	Set when creature retreats due to low health. More...

void	GroupRetreatLevel (object objectGroup, float percent)
	Set when creature retreats due to low health. More...

void	ResumeLevel (int id, float percent)
	Set when creature resumes due to health. More...

void	GroupResumeLevel (object objectGroup, float percent)
	Set when creature resumes due to health. More...

void	RunAway (int id, int target, int duration)
	Cause creature to run away from target. More...

void	GroupRunAway (object objectGroup, int target, int duration)
	Cause creatures to run away from target. More...

void	PauseObject (int id, int duration)
	Pause an object temporarily. More...

void	GroupPauseObject (object objectGroup, int duration)
	Pause objects of a group temporarily. More...

int	IsAttackedBy (int id1, int id2)
	Get whether object1 is being attacked by object2. More...

int	GetGold (int id)
	Get amount of gold for player object. More...

void	ChangeGold (int id, int delta)
	Change amount of gold for player object. More...

int	GetAnswer (int id)
	Get answer from conversation. More...

void	GiveXp (int id, float xp)
	Grant experience to a player. More...

int	HasSubclass (int id, string subclass)
	Get whether object has subclass. More...

void	AutoSave ()
	Trigger an autosave. Only solo games. More...

void	Music (int music, int volume)
	Plays music. More...

void	StartupScreen (int arg1)
	Show startup screen to host. More...

int	IsTalking ()
	Get whether host is talking. More...

int	GetTrigger ()
	Get SELF if valid. More...

int	GetCaller ()
	Get OTHER if valid. More...

void	MakeFriendly (int id)
	Set object friendly with host. More...

void	MakeEnemy (int id)
	Unset object as friendly. More...

void	BecomePet (int id)
	Set object as pet of host. More...

void	BecomeEnemy (int id)
	Unset object as pet of host. More...

int	Unknownb8 (int id)

int	Unknownb9 (int id)

void	SetHalberd (int upgrade)
	Upgrade host's oblivion staff. More...

void	DeathScreen (int which)
	Show death screen. More...

void	Frozen (int id, int frozen)
	Set frozen status of an object. More...

void	NoWallSound (int noWallSound)
	Set no wall sound flag. More...

void	SetCallback (int id, int idx, function callback)
	Set a callback on an object. More...

void	DeleteObjectTimer (int id, int delay)
	Delete object after a delay. More...

void	TrapSpells (int id, string spell1, string spell2, string spell3)
	Set spells on a bomber. More...

int	IsTrading ()
	Get whether the host is currently trading. More...

void	ClearMessages (int id)
	Clear messages on player's screen. More...

void	SetShopkeeperText (int id, string text)
	Set shopkeeper text. More...

void	Unknownc4 ()

int	IsSummoned (int id)
	Gets whether object is a summoned creature. More...

void	ZombieStayDown (int id)
	Set zombie to stay down. More...

void	ZombieGroupStayDown (object objectGroup)
	Set group of zombies to stay down. More...

void	RaiseZombie (int id)
	Raise a zombie. Also clears stay down state. More...

void	RaiseZombieGroup (object objectGroup)
	Raise a zombie. Also clears stay down state. More...

void	MusicPushEvent ()

void	MusicPopEvent ()

void	MusicEvent ()

int	IsGameBall (int id)
	Get whether object is a GameBall. More...

int	IsCrown (int id)
	Get whether object is a Crown. More...

void	EndGame (int type)
	End of game. More...

void	ImmediateBlind ()
	Immediately blind the host. More...

void	ChangeScore (int id, int score)
	Change player object's score. More...

int	GetScore (int id)
	Get player object's score. More...

Variables
const int	FALSE = 0
	FALSE value. More...

const int	TRUE = 1
	TRUE value. More...

const int	SELF = -2
	SELF object id. More...

const int	OTHER = -1
	OTHER object id. More...

Detailed Description

Built-in definitions for Nox Script.

Enumeration Type Documentation

enum AudioEvent

Audio events.

 {
     AnchorCast,
     AnchorOn,
     AnchorOff,
     BlindCast,
     BlindOn,
     BlindOff,
     BlinkCast,
     BurnCast,
     CleansingFlameCast,
     ChannelLifeCast,
     ChannelLifeEffect,
     ChannelLifeStop,
     CancelCast,
     CharmCast,
     CharmSuccess,
     CharmFailure,
     ConfuseCast,
     ConfuseOn,
     ConfuseOff,
     CounterspellCast,
     CurePoisonCast,
     CurePoisonEffect,
     DeathCast,
     DeathOn,
     DeathOff,
     DeathTimer,
     DeathRayCast,
     DetonateGlyphCast,
     DrainManaCast,
     EarthquakeCast,
     EnergyBoltCast,
     FearCast,
     FearOn,
     FearOff,
     ForceOfNatureCast,
     ForceOfNatureReflect,
     ForceOfNatureRelease,
     GlyphCast,
     GlyphDetonate,
     FireballCast,
     FireballExplode,
     FirewalkCast,
     FirewalkOn,
     FirewalkOff,
     FirewalkFlame,
     FistCast,
     FistHit,
     ForceFieldCast,
     FrostCast,
     FrostOn,
     FrostOff,
     FumbleCast,
     FumbleEffect,
     GreaterHealCast,
     GreaterHealEffect,
     GreaterHealStop,
     HasteCast,
     HasteOn,
     HasteOff,
     InfravisionCast,
     InfravisionOn,
     InfraVisionOff,
     InversionCast,
     InvisibilityCast,
     InvisibilityOn,
     InvisibilityOff,
     InvulnerabilityCast,
     InvulnerabilityOn,
     InvulnerabilityOff,
     InvulnerableEffect,
     LesserHealCast,
     LesserHealEffect,
     LightCast,
     LightOn,
     LightOff,
     LightningCast,
     LockCast,
     ManaBombCast,
     ManaBombEffect,
     MarkCast,
     MagicMissileCast,
     MagicMissileDetonate,
     MeteorCast,
     MeteorShowerCast,
     MeteorHit,
     MoonglowCast,
     MoonglowOn,
     MoonglowOff,
     NullifyCast,
     NullifyOn,
     NullifyOff,
     PhantomCast,
     PixieSwarmCast,
     PixieHit,
     PlasmaCast,
     PoisonCast,
     PoisonEffect,
     ProtectionFromFireCast,
     ProtectionFromFireOn,
     ProtectionFromFireOff,
     ProtectionFromFireEffect,
     ProtectionFromPoisonCast,
     ProtectionFromPoisonOn,
     ProtectionFromPoisonOff,
     ProtectionFromPoisonEffec,
     ProtectionFromElectricity,
     ProtectionFromElectricity,
     ProtectionFromElectricity,
     ProtectionFromElectricity,
     ProtectionFromMagicCast,
     ProtectionFromMagicOn,
     ProtectionFromMagicOff,
     ProtectionFromMagicEffect,
     PullCast,
     PushCast,
     ReflectiveShieldCast,
     ReflectiveShieldOn,
     ReflectiveShieldOff,
     ReflectiveShieldEffect,
     RegenerationOn,
     RegenerationOff,
     RunCast,
     RunOn,
     RunOff,
     ShieldCast,
     ShieldOn,
     ShieldOff,
     ShieldRepelled,
     ShockCast,
     ShockOn,
     ShockOff,
     Shocked,
     SlowCast,
     SlowOn,
     SlowOff,
     StunCast,
     StunOn,
     StunOff,
     SummonCast,
     SwapCast,
     TagCast,
     TagOn,
     TagOff,
     TeleportOut,
     TeleportIn,
     TeleportToMarkerCast,
     TeleportToMarkerEffect,
     TeleportPopCast,
     TeleportToTargetCast,
     TelekinesisCast,
     TelekinesisOn,
     TelekinesisOff,
     ToxicCloudCast,
     TriggerGlyphCast,
     TurnUndeadCast,
     TurnUndeadEffect,
     VampirismCast,
     VampirismOn,
     VampirismOff,
     DrainHealth,
     VillainCast,
     VillainOn,
     VillainOff,
     WallCast,
     WallOn,
     WallOff,
     BerserkerChargeInvoke,
     BerserkerCrash,
     BerserkerChargeOn,
     BerserkerChargeOff,
     WarcryInvoke,
     WarcryOn,
     WarcryOff,
     HarpoonInvoke,
     HarpoonOn,
     HarpoonOff,
     TreadLightlyInvoke,
     TreadLightlyOn,
     TreadLightlyOff,
     EyeOfTheWolfInvoke,
     EyeOfTheWolfOn,
     EyeOfTheWolfOff,
     SpellPhonemeUp,
     SpellPhonemeUpRight,
     SpellPhonemeRight,
     SpellPhonemeDownRight,
     SpellPhonemeDown,
     SpellPhonemeDownLeft,
     SpellPhonemeLeft,
     SpellPhonemeUpLeft,
     FemaleSpellPhonemeUp,
     FemaleSpellPhonemeUpRight,
     FemaleSpellPhonemeRight,
     FemaleSpellPhonemeDownRig,
     FemaleSpellPhonemeDown,
     FemaleSpellPhonemeDownLef,
     FemaleSpellPhonemeLeft,
     FemaleSpellPhonemeUpLeft,
     NPCSpellPhonemeUp,
     NPCSpellPhonemeUpRight,
     NPCSpellPhonemeRight,
     NPCSpellPhonemeDownRight,
     NPCSpellPhonemeDown,
     NPCSpellPhonemeDownLeft,
     NPCSpellPhonemeLeft,
     NPCSpellPhonemeUpLeft,
     NPCFemaleSpellPhonemeUp,
     NPCFemaleSpellPhonemeUpRi,
     NPCFemaleSpellPhonemeRigh,
     NPCFemaleSpellPhonemeDown,
     NPCFemaleSpellPhonemeDown,
     NPCFemaleSpellPhonemeDown,
     NPCFemaleSpellPhonemeLeft,
     NPCFemaleSpellPhonemeUpLe,
     FireballWand,
     SmallFireballWand,
     FlareWand,
     LightningWand,
     DepletedWand,
     Ricochet,
     WeaponEffectFire,
     WeaponEffectElectricity,
     PermanentFizzle,
     ManaEmpty,
     Lock,
     Unlock,
     ElevEnable,
     ElevDisable,
     OpenWoodenDoor,
     MoveWoodenDoor,
     CloseWoodenDoor,
     WoodenDoorLocked,
     OpenGate,
     MoveGate,
     CloseGate,
     GateLocked,
     OpenWoodenGate,
     CloseWoodenGate,
     OpenHeavyWoodenDoor,
     CloseHeavyWoodenDoor,
     ElevStoneUp,
     ElevStoneDown,
     ElevWoodUp,
     ElevWoodDown,
     ElevMechUp,
     ElevMechDown,
     ElevLavaUp,
     ElevLavaDown,
     ElevGreenUp,
     ElevGreenDown,
     ElevLOTDUp,
     ElevLOTDDown,
     Gear1,
     Gear2,
     Gear3,
     SmallRockMove,
     MediumRockMove,
     LargeRockMove,
     BoulderMove,
     WalkOnSnow,
     WalkOnStone,
     WalkOnDirt,
     WalkOnWood,
     WalkOnWater,
     WalkOnMud,
     RunOnSnow,
     RunOnStone,
     RunOnDirt,
     RunOnWood,
     RunOnWater,
     RunOnMud,
     PlayerFallThud,
     BarrelMove,
     BlackPowderBurn,
     FireExtinguish,
     PolypExplode,
     PowderBarrelExplode,
     BarrelBreak,
     WaterBarrelBreak,
     LOTDBarrelBreak,
     WineCaskBreak,
     BarrelStackBreak,
     CoffinBreak,
     WaspHiveBreak,
     WorkstationBreak,
     CrushLight,
     CrushMedium,
     CrushHard,
     SentryRayHitWall,
     SentryRayHit,
     DeathRayKill,
     TauntLaugh,
     TauntShakeFist,
     TauntPoint,
     FlagPickup,
     FlagDrop,
     FlagRespawn,
     FlagCapture,
     TreasurePickup,
     TreasureDrop,
     GameOver,
     ServerOptionsChange,
     CamperAlarm,
     PlayerEliminated,
     CrownChange,
     HumanMaleEatFood,
     HumanMaleEatApple,
     HumanMaleDrinkJug,
     HumanMaleHurtLight,
     HumanMaleHurtMedium,
     HumanMaleHurtHeavy,
     HumanMaleHurtPoison,
     HumanMaleDie,
     HumanMaleExertionLight,
     HumanMaleExertionHeavy,
     HumanFemaleEatFood,
     HumanFemaleEatApple,
     HumanFemaleDrinkJug,
     HumanFemaleHurtLight,
     HumanFemaleHurtMedium,
     HumanFemaleHurtHeavy,
     HumanFemaleHurtPoison,
     HumanFemaleDie,
     HumanFemaleExertionLight,
     HumanFemaleExertionHeavy,
     MonsterEatFood,
     BatMove,
     BatRecognize,
     BatBite,
     BatDie,
     SmallSpiderMove,
     SmallSpiderIdle,
     SmallSpiderRecognize,
     SmallSpiderBite,
     SmallSpiderDie,
     LargeSpiderMove,
     LargeSpiderIdle,
     LargeSpiderRecognize,
     LargeSpiderBite,
     LargeSpiderSpit,
     WebGooHit,
     LargeSpiderDie,
     SkeletonMove,
     SkeletonRecognize,
     SkeletonHitting,
     SkeletonMissing,
     SkeletonAttackInit,
     SkeletonDie,
     SkeletonLordMove,
     SkeletonLordRecognize,
     SkeletonLordHitting,
     SkeletonLordMissing,
     SkeletonLordAttackInit,
     SkeletonLordDie,
     BomberRecognize,
     BomberSummon,
     BomberMove,
     BomberDie,
     DemonRecognize,
     DemonTaunt,
     DemonSpellInit,
     DemonMove,
     DemonHurt,
     DemonDie,
     GruntTaunt,
     GruntIdle,
     GruntBowTwang,
     GruntRecognize,
     GruntMove,
     GruntAttackInit,
     GruntHitting,
     GruntMissing,
     GruntHurt,
     GruntDie,
     OgreBruteTaunt,
     OgreBruteIdle,
     OgreBruteListen,
     OgreBruteAttackInit,
     OgreBruteMeleeMiss,
     OgreBruteEngage,
     OgreBruteRecognize,
     OgreBruteMove,
     OgreBruteHurt,
     OgreBruteMeleeHit,
     OgreBruteDie,
     OgreWarlordTaunt,
     OgreWarlordIdle,
     OgreWarlordListen,
     OgreWarlordAttackInit,
     OgreWarlordMeleeMiss,
     OgreWarlordEngage,
     OgreWarlordRecognize,
     OgreWarlordThrow,
     OgreWarlordMove,
     OgreWarlordHurt,
     OgreWarlordMeleeHit,
     OgreWarlordDie,
     ScorpionMove,
     ScorpionIdle,
     ScorpionRecognize,
     ScorpionStingHit,
     ScorpionStingMiss,
     ScorpionAttackInit,
     ScorpionHurt,
     ScorpionDie,
     LeechMove,
     LeechIdle,
     LeechRecognize,
     LeechHitting,
     LeechMissing,
     LeechAttackInit,
     LeechHurt,
     LeechDie,
     ZombieMove,
     ZombieIdle,
     ZombieRecognize,
     ZombieHitting,
     ZombieMissing,
     ZombieAttackInit,
     ZombieHurt,
     ZombieDie,
     VileZombieMove,
     VileZombieIdle,
     VileZombieRecognize,
     VileZombieHitting,
     VileZombieMissing,
     VileZombieAttackInit,
     VileZombieHurt,
     VileZombieDie,
     BearMove,
     BearRecognize,
     BearHitting,
     BearMissing,
     BearAttackInit,
     BearHurt,
     BearDie,
     WolfMove,
     WolfIdle,
     WolfRecognize,
     WolfHitting,
     WolfMissing,
     WolfAttackInit,
     WolfHurt,
     WolfDie,
     PlantRecognize,
     PlantHitting,
     PlantMissing,
     PlantAttackInit,
     PlantHurt,
     PlantDie,
     MimicMove,
     MimicIdle,
     MimicRecognize,
     MimicAttackInit,
     MimicHitting,
     MimicMissing,
     MimicHurt,
     MimicDie,
     MechGolemRecognize,
     MechGolemHitting,
     MechGolemMissing,
     MechGolemMove,
     MechGolemAttackInit,
     MechGolemHurt,
     MechGolemDie,
     ImpMove,
     ImpRecognize,
     ImpSteal,
     ImpShoot,
     ImpDie,
     GolemRecognize,
     GolemMove,
     GolemHitting,
     GolemMissing,
     GolemHurt,
     GolemDie,
     TowerRecognize,
     TowerShoot,
     SkullRecognize,
     SkullShoot,
     GhostMove,
     GhostRecognize,
     GhostHitting,
     GhostHurt,
     GhostDie,
     WizardTalkable,
     WizardMove,
     WizardRecognize,
     WizardEngage,
     WizardRetreat,
     WizardHurt,
     WizardDie,
     WaspMove,
     WaspIdle,
     WaspRecognize,
     WaspSting,
     WaspDie,
     EmberDemonMove,
     EmberDemonTaunt,
     EmberDemonRecognize,
     EmberDemonHitting,
     EmberDemonMissing,
     EmberDemonThrow,
     EmberDemonHurt,
     EmberDemonDie,
     UrchinMove,
     UrchinTaunt,
     UrchinIdle,
     UrchinRecognize,
     UrchinThrow,
     UrchinHurt,
     UrchinFlee,
     UrchinDie,
     UrchinShamanMove,
     UrchinShamanTaunt,
     UrchinShamanIdle,
     UrchinShamanRecognize,
     UrchinShamanHurt,
     UrchinShamanFlee,
     UrchinShamanDie,
     ArcherMove,
     ArcherTaunt,
     ArcherIdle,
     ArcherRetreat,
     ArcherRecognize,
     ArcherMissileInit,
     ArcherShoot,
     ArcherHurt,
     ArcherDie,
     SwordsmanMove,
     SwordsmanTaunt,
     SwordsmanIdle,
     SwordsmanRecognize,
     SwordsmanHitting,
     SwordsmanMissing,
     SwordsmanRetreat,
     SwordsmanAttackInit,
     SwordsmanHurt,
     SwordsmanDie,
     BeholderMove,
     BeholderIdle,
     BeholderRecognize,
     BeholderAttackInit,
     BeholderHurt,
     BeholderDie,
     DryadMove,
     DryadTaunt,
     DryadRecognize,
     DryadHurt,
     DryadDie,
     EvilCherubMove,
     EvilCherubTaunt,
     EvilCherubIdle,
     EvilCherubMissileInit,
     EvilCherubRecognize,
     EvilCherubShoot,
     EvilCherubHurt,
     EvilCherubDie,
     FishDie,
     FrogDie,
     FrogRecognize,
     HecubahTaunt,
     HecubahTalkable,
     HecubahMove,
     HecubahRecognize,
     HecubahAttackInit,
     HecubahHurt,
     HecubahDie,
     HecubahDieFrame0A,
     HecubahDieFrame0B,
     HecubahDieFrame98,
     HecubahDieFrame194,
     HecubahDieFrame283,
     HecubahDieFrame439,
     NecromancerTaunt,
     NecromancerTalkable,
     NecromancerMove,
     NecromancerRecognize,
     NecromancerEngage,
     NecromancerRetreat,
     NecromancerAttackInit,
     NecromancerHurt,
     NecromancerDie,
     LichMove,
     LichRecognize,
     LichAttackInit,
     LichHurt,
     LichDie,
     FlyingGolemMove,
     FlyingGolemRecognize,
     FlyingGolemShoot,
     FlyingGolemHurt,
     FlyingGolemDie,
     NPCIdle,
     NPCTalkable,
     NPCRecognize,
     NPCRetreat,
     NPCHurt,
     NPCDie,
     MaidenIdle,
     MaidenTalkable,
     MaidenFlee,
     MaidenHurt,
     MaidenDie,
     RatDie,
     ShadeMove,
     ShadeRecognize,
     ShadeAttackInit,
     ShadeHurt,
     ShadeDie,
     WeirdlingMove,
     WillOWispMove,
     WillOWispIdle,
     WillOWispRecognize,
     WillOWispEngage,
     WillOWispHurt,
     WillOWispDie,
     TrollMove,
     TrollIdle,
     TrollRecognize,
     TrollHurt,
     TrollAttackInit,
     TrollFlatus,
     TrollDie,
     MaleNPC1Idle,
     MaleNPC1Talkable,
     MaleNPC1Recognize,
     MaleNPC1Engage,
     MaleNPC1Retreat,
     MaleNPC1Hurt,
     MaleNPC1AttackInit,
     MaleNPC1Die,
     MaleNPC2Idle,
     MaleNPC2Talkable,
     MaleNPC2Recognize,
     MaleNPC2Engage,
     MaleNPC2Retreat,
     MaleNPC2Hurt,
     MaleNPC2AttackInit,
     MaleNPC2Die,
     Maiden1Talkable,
     Maiden1Idle,
     Maiden1Recognize,
     Maiden1Retreat,
     Maiden1Hurt,
     Maiden1AttackInit,
     Maiden1Die,
     Maiden2Idle,
     Maiden2Talkable,
     Maiden2Recognize,
     Maiden2Retreat,
     Maiden2Hurt,
     Maiden2AttackInit,
     Maiden2Die,
     HorvathTalkable,
     HorvathEngage,
     HorvathHurt,
     HorvathDie,
     Wizard1Idle,
     Wizard1Talkable,
     Wizard1Recognize,
     Wizard1Engage,
     Wizard1Retreat,
     Wizard1Hurt,
     Wizard1AttackInit,
     Wizard1Die,
     Wizard2Idle,
     Wizard2Talkable,
     Wizard2Recognize,
     Wizard2Engage,
     Wizard2Retreat,
     Wizard2Hurt,
     Wizard2AttackInit,
     Wizard2Die,
     FireKnight1Idle,
     FireKnight1Talkable,
     FireKnight1Recognize,
     FireKnight1Engage,
     FireKnight1Retreat,
     FireKnight1Hurt,
     FireKnight1AttackInit,
     FireKnight1Die,
     FireKnight2Idle,
     FireKnight2Talkable,
     FireKnight2Recognize,
     FireKnight2Engage,
     FireKnight2Retreat,
     FireKnight2Hurt,
     FireKnight2AttackInit,
     FireKnight2Die,
     Guard1Idle,
     Guard1Talkable,
     Guard1Recognize,
     Guard1Engage,
     Guard1Retreat,
     Guard1Hurt,
     Guard1AttackInit,
     Guard1Die,
     Guard2Idle,
     Guard2Talkable,
     Guard2Recognize,
     Guard2Engage,
     Guard2Retreat,
     Guard2Hurt,
     Guard2AttackInit,
     Guard2Die,
     WoundedNPCIdle,
     WoundedNPCTalkable,
     WoundedNPCRecognize,
     WoundedNPCRetreat,
     WoundedNPCHurt,
     WoundedNPCAttackInit,
     WoundedNPCDie,
     HorrendousTalkable,
     HorrendousRecognize,
     HorrendousRetreat,
     HorrendousHurt,
     HorrendousAttackInit,
     HorrendousDie,
     PotionUse,
     RestoreHealth,
     RestoreMana,
     SecretWallOpen,
     SecretWallClose,
     SecretWallEarthOpen,
     SecretWallEarthClose,
     SecretWallMetalOpen,
     SecretWallMetalClose,
     SecretWallStoneOpen,
     SecretWallStoneClose,
     SecretWallWoodOpen,
     SecretWallWoodClose,
     TriggerPressed,
     TriggerReleased,
     PotionBreak,
     WallDestroyed,
     WallDestroyedStone,
     WallDestroyedWood,
     WallDestroyedMetal,
     ChestOpen,
     CryptChestOpen,
     SackChestOpen,
     EggBreak,
     ButtonPress,
     ButtonRelease,
     LeverToggle,
     SwitchToggle,
     ChainPull,
     ShortBellsUp,
     LongBellsUp,
     LongBellsDown,
     BigBell,
     MetallicBong,
     Chime,
     BigGong,
     SmallGong,
     MysticChant,
     TripleChime,
     Clank1,
     Clank2,
     Clank3,
     MapOpen,
     MapClose,
     BookOpen,
     BookClose,
     PageTurn,
     InventoryOpen,
     InventoryClose,
     InventoryPickup,
     InventoryDrop,
     SpellPickup,
     SpellDrop,
     SpellPopOffBook,
     TrapEditorOpen,
     TrapEditorClose,
     ChangeSpellbar,
     ExpandSpellbar,
     CollapseSpellbar,
     CreatureCageAppears,
     CreatureCageHides,
     ShopRepairItem,
     MetalArmorPickup,
     MetalArmorDrop,
     MetalArmorBreak,
     LeatherArmorPickup,
     LeatherArmorDrop,
     LeatherArmorBreak,
     WoodenArmorPickup,
     WoodenArmorDrop,
     WoodenArmorBreak,
     ClothArmorPickup,
     ClothArmorDrop,
     ClothArmorBreak,
     ShoesPickup,
     ShoesDrop,
     MetalWeaponBreak,
     WoodWeaponBreak,
     KeyPickup,
     KeyDrop,
     AmuletPickup,
     AmuletDrop,
     TrapPickup,
     TrapDrop,
     BookPickup,
     BookDrop,
     ScrollPickup,
     ScrollDrop,
     WandPickup,
     WandDrop,
     PotionPickup,
     PotionDrop,
     MeatPickup,
     MeatDrop,
     ApplePickup,
     AppleDrop,
     ShroomPickup,
     ShroomDrop,
     SpectaclesPickup,
     SpectaclesDrop,
     MetalWeaponPickup,
     WoodenWeaponPickup,
     MetalWeaponDrop,
     WoodenWeaponDrop,
     BearTrapTriggered,
     PoisonTrapTriggered,
     StoneHitStone,
     StoneHitEarth,
     StoneHitWood,
     StoneHitMetal,
     StoneHitFlesh,
     WoodHitStone,
     WoodHitEarth,
     WoodHitWood,
     WoodHitMetal,
     WoodHitFlesh,
     MetalHitStone,
     MetalHitEarth,
     MetalHitWood,
     MetalHitMetal,
     MetalHitFlesh,
     FleshHitStone,
     FleshHitEarth,
     FleshHitWood,
     FleshHitMetal,
     FleshHitFlesh,
     DiamondHitStone,
     DiamondHitEarth,
     DiamondHitWood,
     DiamondHitMetal,
     DiamondHitFlesh,
     HitStoneBreakable,
     HitEarthBreakable,
     HitWoodBreakable,
     HitMetalBreakable,
     HitMagicBreakable,
     HitMetalShield,
     PunchMissing,
     LongswordMissing,
     SwordMissing,
     HammerMissing,
     AxeMissing,
     MaceMissing,
     BowEmpty,
     CrossBowEmpty,
     BowShoot,
     CrossBowShoot,
     ArrowTrapShoot,
     GreatSwordReflect,
     ChakramThrow,
     ChakramCatch,
     ChakramFallToGround,
     StaffBlock,
     NextWeapon,
     HeartBeat,
     GenerateTick,
     SummonClick,
     SummonComplete,
     SummonAbort,
     ManaClick,
     LevelUp,
     JournalEntryAdd,
     SecretFound,
     EarthRumbleMajor,
     EarthRumbleMinor,
     ElectricalArc1,
     FloorSpikesUp,
     FloorSpikesDown,
     SpikeBlockMove,
     BoulderRoll,
     ArcheryContestBegins,
     HorrendousIsKilled,
     StaffOblivionAchieve1,
     StaffOblivionAchieve2,
     StaffOblivionAchieve3,
     StaffOblivionAchieve4,
     FireGrate,
     MechGolemPowerUp,
     ShellSelect,
     ShellClick,
     ShellSlideIn,
     ShellSlideOut,
     ShellMouseBoom,
     NoCanDo,
     BallThrow,
     BallGrab,
     BallBounce,
     BallHitGoal,
     HarpoonBroken,
     HarpoonReel,
     MonsterGeneratorDie,
     MonsterGeneratorHurt,
     MonsterGeneratorSpawn,
     PlayerExit,
     AwardLife,
     SoulGateTouch,
     QuestRespawn,
     QuestFinalDeath,
     QuestPlayerJoinGame,
     QuestStatScreen,
     QuestIntroScreen,
     QuestPlayerExitGame,
     QuestLockedChest,
     StoneDoorOpen,
     StoneDoorClose,
     DiamondPickup,
     DiamondDrop,
     EnableSharedKeyMode,
 };

enum Class

Class names.

 {
     MISSILE,
     MONSTER,
     PLAYER,
     OBSTACLE,
     FOOD,
     EXIT,
     KEY,
     DOOR,
     INFO_BOOK,
     TRIGGER,
     TRANSPORTER,
     HOLE,
     WAND,
     FIRE,
     ELEVATOR,
     ELEVATOR_SHAFT,
     DANGEROUS,
     MONSTERGENERATOR,
     READABLE,
     LIGHT,
     SIMPLE,
     COMPLEX,
     IMMOBILE,
     VISIBLE_ENABLE,
     WEAPON,
     ARMOR,
     NOT_STACKABLE,
     TREASURE,
     FLAG,
     CLIENT_PERSIST,
     CLIENT_PREDICT,
     PICKUP
 };

enum DamageType

Damange types.

 {
     DAMAGE_BLADE = 0,
     DAMAGE_FLAME = 1,
     DAMAGE_CRUSH = 2,
     DAMAGE_IMPALE = 3,
     DAMAGE_DRAIN = 4,
     DAMAGE_POISON = 5,
     DAMAGE_DISPEL_UNDEAD = 6,
     DAMAGE_EXPLOSION = 7,
     DAMAGE_BITE = 8,
     DAMAGE_ELECTRIC = 9,
     DAMAGE_CLAW = 10,
     DAMAGE_IMPACT = 11,
     DAMAGE_LAVA = 12,
     DAMAGE_DEATH_MAGIC = 13,
     DAMAGE_PLASMA = 14,
     DAMAGE_MANA_BOMB = 15,
     DAMAGE_ZAP_RAY = 16,
     DAMAGE_AIRBORNE_ELECTRIC = 17,
 };

enum Direction

Facing directions.

 {
     NW = 0,
     N = 1,
     NE = 2,
     W = 3,
     E = 5,
     SW = 6,
     S = 7,
     SE = 8
 };

enum Effect

Effects.

 {
     PARTICLEFX,
     PLASMA,
     SUMMON,
     SUMMON_CANCEL,
     SHIELD,
     BLUE_SPARKS,
     YELLOW_SPARKS,
     CYAN_SPARKS,
     VIOLET_SPARKS,
     EXPLOSION,
     LESSER_EXPLOSION,
     COUNTERSPELL_EXPLOSION,
     THIN_EXPLOSION,
     TELEPORT,
     SMOKE_BLAST,
     DAMAGE_POOF,
     LIGHTNING,
     ENERGY_BOLT,
     CHAIN_LIGHTNING_BOLT,
     DRAIN_MANA,
     CHARM,
     GREATER_HEAL,
     MAGIC,
     SPARK_EXPLOSION,
     DEATH_RAY,
     SENTRY_RAY,
     RICOCHET,
     JIGGLE,
     GREEN_BOLT,
     GREEN_EXPLOSION,
     WHITE_FLASH,
     GENERATING_MAP,
     ASSEMBLING_MAP,
     POPULATING_MAP,
     DURATION_SPELL,
     DELTAZ_SPELL_START,
     TURN_UNDEAD,
     ARROW_TRAP,
     VAMPIRISM,
     MANA_BOMB_CANCEL,
 };

enum Enchant

Enchants.

 {
     ENCHANT_INVISIBLE,
     ENCHANT_MOONGLOW,
     ENCHANT_BLINDED,
     ENCHANT_CONFUSED,
     ENCHANT_SLOWED,
     ENCHANT_HELD,
     ENCHANT_DETECTING,
     ENCHANT_ETHEREAL,
     ENCHANT_RUN,
     ENCHANT_HASTED,
     ENCHANT_VILLAIN,
     ENCHANT_AFRAID,
     ENCHANT_BURNING,
     ENCHANT_VAMPIRISM,
     ENCHANT_ANCHORED,
     ENCHANT_LIGHT,
     ENCHANT_DEATH,
     ENCHANT_PROTECT_FROM_FIRE,
     ENCHANT_PROTECT_FROM_POISON,
     ENCHANT_PROTECT_FROM_MAGIC,
     ENCHANT_PROTECT_FROM_ELECTRICITY,
     ENCHANT_INFRAVISION,
     ENCHANT_SHOCK,
     ENCHANT_INVULNERABLE,
     ENCHANT_TELEKINESIS,
     ENCHANT_FREEZE,
     ENCHANT_SHIELD,
     ENCHANT_REFLECTIVE_SHIELD,
     ENCHANT_CHARMING,
     ENCHANT_ANTI_MAGIC,
     ENCHANT_CROWN,
     ENCHANT_SNEAK
 };

enum Spell

Spell names.

 {
     SPELL_INVALID,
     SPELL_ANCHOR,
     SPELL_ARACHNAPHOBIA,
     SPELL_BLIND,
     SPELL_BLINK,
     SPELL_BURN,
     SPELL_CANCEL,
     SPELL_CHAIN_LIGHTNING_BOLT,
     SPELL_CHANNEL_LIFE,
     SPELL_CHARM,
     SPELL_CLEANSING_FLAME,
     SPELL_CLEANSING_MANA_FLAME,
     SPELL_CONFUSE,
     SPELL_COUNTERSPELL,
     SPELL_CURE_POISON,
     SPELL_DEATH,
     SPELL_DEATH_RAY,
     SPELL_DETECT_MAGIC,
     SPELL_DETONATE,
     SPELL_DETONATE_GLYPHS,
     SPELL_DISENCHANT_ALL,
     SPELL_TURN_UNDEAD,
     SPELL_DRAIN_MANA,
     SPELL_EARTHQUAKE,
     SPELL_LIGHTNING,
     SPELL_EXPLOSION,
     SPELL_FEAR,
     SPELL_FIREBALL,
     SPELL_FIREWALK,
     SPELL_FIST,
     SPELL_FORCE_FIELD,
     SPELL_FORCE_OF_NATURE,
     SPELL_FREEZE,
     SPELL_FUMBLE,
     SPELL_GLYPH,
     SPELL_GREATER_HEAL,
     SPELL_HASTE,
     SPELL_INFRAVISION,
     SPELL_INVERSION,
     SPELL_INVISIBILITY,
     SPELL_INVULNERABILITY,
     SPELL_LESSER_HEAL,
     SPELL_LIGHT,
     SPELL_CHAIN_LIGHTNING,
     SPELL_LOCK,
     SPELL_MARK,
     SPELL_MARK_1,
     SPELL_MARK_2,
     SPELL_MARK_3,
     SPELL_MARK_4,
     SPELL_MAGIC_MISSILE,
     SPELL_SHIELD,
     SPELL_METEOR,
     SPELL_METEOR_SHOWER,
     SPELL_MOONGLOW,
     SPELL_NULLIFY,
     SPELL_MANA_BOMB,
     SPELL_PHANTOM,
     SPELL_PIXIE_SWARM,
     SPELL_PLASMA,
     SPELL_POISON,
     SPELL_PROTECTION_FROM_ELECTRICITY,
     SPELL_PROTECTION_FROM_FIRE,
     SPELL_PROTECTION_FROM_MAGIC,
     SPELL_PROTECTION_FROM_POISON,
     SPELL_PULL,
     SPELL_PUSH,
     SPELL_OVAL_SHIELD,
     SPELL_RESTORE_HEALTH,
     SPELL_RESTORE_MANA,
     SPELL_RUN,
     SPELL_SHOCK,
     SPELL_SLOW,
     SPELL_SMALL_ZAP,
     SPELL_STUN,
     SPELL_SUMMON_BAT,
     SPELL_SUMMON_BLACK_BEAR,
     SPELL_SUMMON_BEAR,
     SPELL_SUMMON_BEHOLDER,
     SPELL_SUMMON_BOMBER,
     SPELL_SUMMON_CARNIVOROUS_PLANT,
     SPELL_SUMMON_ALBINO_SPIDER,
     SPELL_SUMMON_SMALL_ALBINO_SPIDER,
     SPELL_SUMMON_EVIL_CHERUB,
     SPELL_SUMMON_EMBER_DEMON,
     SPELL_SUMMON_GHOST,
     SPELL_SUMMON_GIANT_LEECH,
     SPELL_SUMMON_IMP,
     SPELL_SUMMON_MECHANICAL_FLYER,
     SPELL_SUMMON_MECHANICAL_GOLEM,
     SPELL_SUMMON_MIMIC,
     SPELL_SUMMON_OGRE,
     SPELL_SUMMON_OGRE_BRUTE,
     SPELL_SUMMON_OGRE_WARLORD,
     SPELL_SUMMON_SCORPION,
     SPELL_SUMMON_SHADE,
     SPELL_SUMMON_SKELETON,
     SPELL_SUMMON_SKELETON_LORD,
     SPELL_SUMMON_SPIDER,
     SPELL_SUMMON_SMALL_SPIDER,
     SPELL_SUMMON_SPITTING_SPIDER,
     SPELL_SUMMON_STONE_GOLEM,
     SPELL_SUMMON_TROLL,
     SPELL_SUMMON_URCHIN,
     SPELL_SUMMON_WASP,
     SPELL_SUMMON_WILLOWISP,
     SPELL_SUMMON_WOLF,
     SPELL_SUMMON_BLACK_WOLF,
     SPELL_SUMMON_WHITE_WOLF,
     SPELL_SUMMON_ZOMBIE,
     SPELL_SUMMON_VILE_ZOMBIE,
     SPELL_SUMMON_DEMON,
     SPELL_SUMMON_LICH,
     SPELL_SUMMON_DRYAD,
     SPELL_SUMMON_URCHIN_SHAMAN,
     SPELL_SWAP,
     SPELL_TAG,
     SPELL_TELEPORT_OTHER_TO_MARK_1,
     SPELL_TELEPORT_OTHER_TO_MARK_2,
     SPELL_TELEPORT_OTHER_TO_MARK_3,
     SPELL_TELEPORT_OTHER_TO_MARK_4,
     SPELL_TELEPORT_POP,
     SPELL_TELEPORT_TO_MARK_1,
     SPELL_TELEPORT_TO_MARK_2,
     SPELL_TELEPORT_TO_MARK_3,
     SPELL_TELEPORT_TO_MARK_4,
     SPELL_TELEPORT_TO_TARGET,
     SPELL_TELEKINESIS,
     SPELL_TOXIC_CLOUD,
     SPELL_TRIGGER_GLYPH,
     SPELL_VAMPIRISM,
     SPELL_VILLAIN,
     SPELL_WALL,
     SPELL_WINK,
     SPELL_SUMMON_CREATURE,
     SPELL_MARK_LOCATION,
     SPELL_TELEPORT_TO_MARKER
 };

enum Subclass

Subclass names.

 {
     HELMET,
     SHIELD,
     BREASTPLATE,
     ARM_ARMOR,
     PANTS,
     BOOTS,
     SHIRT,
     LEG_ARMOR,
     BACK,
     FLAG,
     QUIVER,
     CROSSBOW,
     ARROW,
     BOLT,
     CHAKRAM,
     SHURIKEN,
     SWORD,
     LONG_SWORD,
     GREAT_SWORD,
     MACE,
     OGRE_AXE,
     HAMMER,
     STAFF,
     STAFF_SULPHOROUS_FLARE,
     STAFF_SULPHOROUS_SHOWER,
     STAFF_LIGHTNING,
     STAFF_FIREBALL,
     STAFF_TRIPLE_FIREBALL,
     STAFF_FORCE_OF_NATURE,
     STAFF_DEATH_RAY,
     STAFF_OBLIVION_HALBERD,
     STAFF_OBLIVION_HEART,
     STAFF_OBLIVION_WIERDLING,
     STAFF_OBLIVION_ORB,
     SMALL_MONSTER,
     MEDIUM_MONSTER,
     LARGE_MONSTER,
     SHOPKEEPER,
     NPC,
     FEMALE_NPC,
     UNDEAD,
     MONITOR,
     MIGRATE,
     IMMUNE_POISON,
     IMMUNE_FIRE,
     IMMUNE_ELECTRICITY,
     IMMUNE_FEAR,
     BOMBER,
     NO_TARGET,
     NO_SPELL_TARGET,
     HAS_SOUL,
     WARCRY_STUN,
     LOOK_AROUND,
     WOUNDED_NPC,
     SIMPLE,
     APPLE,
     POTION,
     HEALTH_POTION,
     MANA_POTION,
     CURE_POISON_POTION,
     MUSHROOM,
     HASTE_POTION,
     INVISIBILITY_POTION,
     SHIELD_POTION,
     FIRE_PROTECT_POTION,
     SHOCK_PROTECT_POTION,
     POISON_PROTECT_POTION,
     INVULNERABILITY_POTION,
     INFRAVISION_POTION,
     VAMPIRISM_POTION,
     HEAVY,
     LAVA,
     GATE,
     VISIBLE_OBELISK,
     INVISIBLE_OBELISK,
     TECH,
     LOTD,
     USEABLE,
     CHEST_NW,
     CHEST_NE,
     CHEST_SE,
     CHEST_SW,
     STONE_DOOR,
     SPELL_BOOK,
     FIELD_GUIDE,
     ABILITY_BOOK,
     MISSILE_COUNTERSPELL,
     MAGIC,
     GENERATOR_NW,
     GENERATOR_NE,
     GENERATOR_SE,
     GENERATOR_SW,
     QUEST_EXIT,
     QUEST_WARP_EXIT,
     FLESH,
     CLOTH,
     ANIMAL_HIDE,
     WOOD,
     METAL,
     STONE,
     EARTH,
     LIQUID,
     GLASS,
     PAPER,
     SNOW,
     MUD,
     MAGIC,
     DIAMOND,
     NONE,
 };

Function Documentation

void AggressionLevel	(	int	id,
		float	level
	)

Set creature's aggression level.

This will set a creature's aggression level. The most commonly used value is 0.83.

Parameters

id	an object id
level	aggression level

void Attack	(	int	id,
		int	target
	)

Attack an object.

Parameters

id	an object id
target	an object id

void AudioEvent	(	string	audio,
		object	waypoint
	)

Play an audio event at a location.

Parameters

audio	a audio event name AudioEvent
waypoint	a waypoint object

void AutoSave ( )

Trigger an autosave. Only solo games.

int AwardSpell	(	int	id,
		string	spell
	)

Award spell level to object.

This will raise the spell level of the object. If the object can not cast this spell then it will have no effect.

Parameters

id	an object id
spell	a spell name Spell

Returns: success as TRUE or FALSE

void BecomeEnemy ( int id )

Unset object as pet of host.

Parameters

id	an object id

void BecomePet ( int id )

Set object as pet of host.

Parameters

id	an object id

void Blind ( )

Blind the host.

void CancelDialog ( int id )

Cancel a conversation with object.

Parameters

id	an object id

int CancelTimer ( int id )

Cancel a timer.

Parameters

id	a timer id

Returns: success as TRUE or FALSE

void CastSpellLocationLocation	(	string	spell,
		float	x1,
		float	y1,
		float	x2,
		float	y2
	)

Casts a spell from source to target.

Parameters

spell	a spell name Spell
x1	source x coordinate
y1	source y coordinate
x2	target x coordinate
y2	target y coordinate

void CastSpellLocationObject	(	string	spell,
		float	x,
		float	y,
		int	target
	)

Casts a spell from source to target.

Parameters

spell	a spell name Spell
x	source x coordinate
y	source y coordinate
target	an object id

void CastSpellObjectLocation	(	string	spell,
		int	source,
		float	x,
		float	y
	)

Casts a spell from source to target.

Parameters

spell	a spell name Spell
source	an object id
x	target x coordinate
y	target y coordinate

void CastSpellObjectObject	(	string	spell,
		int	source,
		int	target
	)

Casts a spell from source to target.

Example usage: CastSpellOn("SPELL_DEATH_RAY", Object("CruelDude"), GetHost())

Parameters

spell	a spell name Spell
source	an object id
target	an object id

void ChangeGold	(	int	id,
		int	delta
	)

Change amount of gold for player object.

Parameters

id	an object id
delta	amount to add (can be negative)

void ChangeScore	(	int	id,
		int	score
	)

Change player object's score.

Parameters

id	an object id
score	score delta

void Chat	(	int	id,
		string	message
	)

Cause an object to say a localized string.

This will display a localized string in a speech bubble. If the string is not in the string database, it will instead print an error message with "MISSING:".

Parameters

id	an object id
message	a string

void ChatTimer	(	int	id,
		string	message,
		int	duration
	)

Cause an object to say a localized string for duration in frames.

This will display a localized string in a speech bubble. If the string is not in the string database, it will instead print an error message with "MISSING:".

Parameters

id	an object id
message	a string
duration	in frames

void ChatTimerSeconds	(	int	id,
		string	message,
		int	duration
	)

Cause an object to say a localized string for duration in seconds.

This will display a localized string in a speech bubble. If the string is not in the string database, it will instead print an error message with "MISSING:".

Parameters

id	an object id
message	a string
duration	in seconds

void ClearMessages ( int id )

Clear messages on player's screen.

Parameters

id	an object id

void ClearOwner ( int id )

Clear the owner of an object.

Parameters

id	an object id

int CreateMover	(	int	id,
		object	waypoint,
		float	speed
	)

Creates a Mover for an object.

Parameters

id	an object id
waypoint	destination waypoint
speed	move speed

Returns: object id of new Mover

int CreateObject	(	string	type,
		object	waypoint
	)

Create an object at a location.

This will create an object given a type and a starting location.

Example usage: int spider = CreateObject("SmallAlbinoSpider", Waypoint("SpiderHole"))

Parameters

type	an object type string
waypoint	a waypoint object

Returns: an object id

void CreatureFollow	(	int	id,
		int	target
	)

Cause creature to follow an object.

This will cause a creature to follow target, and it won't attack anything unless disrupted or instructed to.

Parameters

id	an object id
target	an object id

void CreatureGroupFollow	(	object	objectGroup,
		int	target
	)

Cause creatures in a group to follow an object.

This will cause the creatures to follow target, and they won't attack anything unless disrupted or instructed to.

Parameters

objectGroup	an object group object
target	an object id

void CreatureGroupGuard	(	object	objectGroup,
		float	x1,
		float	y1,
		float	x2,
		float	y2,
		float	distance
	)

Cause creatures in a group to guard a location.

This is the same as CreatureGuard but applies to creatures in a group.

Parameters

objectGroup	an object group object
x1	x coordinate to guard from
y1	y coordinate to guard from
x2	x coordinate to watch
y2	y coordinate to watch
distance	distance from (x2,y2) to attack

void CreatureGroupHunt ( object objectGroup )

Cause creatures in a group to hunt.

Parameters

objectGroup an object group object

void CreatureGroupIdle ( object objectGroup )

Cause creatures in a group to idle.

Parameters

objectGroup an object group object

void CreatureGuard	(	int	id,
		float	x1,
		float	y1,
		float	x2,
		float	y2,
		float	distance
	)

Cause a creature to guard a location.

This will cause a creature to move to a location, guard a nearby location, and attack any enemies that move within range of the guarded location.

Parameters

id	an object id
x1	x coordinate to guard from
y1	y coordinate to guard from
x2	x coordinate to watch
y2	y coordinate to watch
distance	distance from (x2,y2) to attack

void CreatureHunt ( int id )

Cause creature to hunt.

Parameters

id	an object id

void CreatureIdle ( int id )

Cause creature to idle.

Parameters

id	an object id

int CurrentHealth ( int id )

Get object's health.

Parameters

id	an object id

Returns: health

void Damage	(	int	target,
		int	source,
		int	amount,
		int	type
	)

Damages an object.

This will damage the target with a given source object, amount, and damage type.

Parameters

target	an object id that receives damage
source	an object id as source of damange
amount	amount of damage
type	type of damange DamageType

void DeathScreen ( int which )

Show death screen.

Parameters

which the screen to show (1 - 11)

void Delete ( int id )

Delete an object.

Parameters

id	an object id

void DeleteObjectTimer	(	int	id,
		int	delay
	)

Delete object after a delay.

Parameters

id	an object id
delay	number of frames

void DestroyChat ( int id )

Destroys object's speech bubble.

Parameters

id	an object id

void DestroyEveryChat ( )

Destroys all speech bubbles.

float Distance	(	float	x1,
		float	y1,
		float	x2,
		float	y2
	)

Calculate distance between two locations.

Parameters

x1
y1
x2
y2

Returns: distance

int Drop	(	int	id,
		int	item
	)

Cause object to drop an item.

Parameters

id	an object id
item	an object id to drop

Returns: success as TRUE or FALSE

void Effect	(	string	effect,
		float	x1,
		float	y1,
		float	x2,
		float	y2
	)

Trigger an effect.

This will trigger an effect from point (x1,y1) to (x2,y2). Some effects only have one point, in which case (x2,y2) is ignored.

Parameters

effect	an effect name Effect
x1
y1
x2
y2

void Enchant	(	int	id,
		string	enchant,
		float	duration
	)

Grant object an enchantment.

This will grant an object an enchantment of a specified duration. If the enchantment name is incorrect, the game may crash.

Parameters

id	an object id
enchant	an enchantment name Enchant
duration	in seconds

void EnchantOff	(	int	id,
		string	enchant
	)

Remove enchant from an object.

Parameters

id	an object id
enchant	an enchant name Enchant

void EndGame ( int type )

End of game.

Parameters

type	one of 0=Warrior, 1=Wizard, 2=Conjurer

string FloatToString ( float number )

Convert a float to a string.

This will convert a float to a string, and add the string to the string table temporarily.

Parameters

number a float number

Returns: a string

int FrameTimer	(	int	frames,
		function	callback
	)

Create a timer with delay in frames.

This will create a timer that calls the given script function after a delay given in frames.

Parameters

frames	delay
callback	a script function

Returns: timer id

int FrameTimerWithArg	(	int	frames,
		any	argument,
		function	callback
	)

Create a timer with delay in frames with an argument.

This will create a timer that calls the given script function after a delay given in frames. The given argument will be passed into the script function.

Parameters

frames	delay
argument	function argument
callback	a script function

Returns: timer id

void Frozen	(	int	id,
		int	frozen
	)

Set frozen status of an object.

Parameters

id	an object id
frozen	either TRUE (1) or FALSE (0)

int GetAnswer ( int id )

Get answer from conversation.

Parameters

id	an object id

Returns: result (0=Goodbye, 1=Yes, 2=No)

int GetCaller ( )

Get OTHER if valid.

Returns: an object id, or 0

int GetCharacterData ( int idx )

Get character data.

FIXME

Get information about the loaded character.

Parameters

idx	what to return (0-5)

Returns: value

int GetDirection ( int id )

Get object direction.

See the description of LookWithAngle.

Parameters

id	a object id

Returns

int GetElevatorStatus ( int id )

Get elevator status.

Parameters

id	an object id

Returns: status, or -1 if invalid object

int GetGold ( int id )

Get amount of gold for player object.

Parameters

id	an object id

Returns: amount of gold

int GetHolder ( int item )

Get the holder of an item.

This will return the object id that contains the item in its inventory.

Parameters

item	an object id

Returns: an object id of the holder

int GetHost ( )

Get host's player object.

This will return the host's player object id. The host is the player with a player id of 31.

Returns: an object id

int GetLastItem ( int id )

Get object's last inventory item.

This will return the object id of the last item in the object's inventory. If the inventory is empty, it will return 0.

This is used with GetPreviousItem to iterate through an object's inventory.

Parameters

id	an object id

Returns: an object id, or 0

float GetObjectX ( int id )

Get object X coordinate.

Parameters

id	an object id

Returns: x coordinate

float GetObjectY ( int id )

Get object Y coordinate.

Parameters

id	an object id

Returns: y coordinate

float GetObjectZ ( int id )

Get object Z coordinate.

Parameters

id	a object id

Returns: z coordinate

int GetPreviousItem ( int id )

Get previous inventory item.

This will return the object id of the previous item in the inventory from the given object id. If the specified object id is not in an inventory, or there are no more items in the inventory, it will return 0;

This is used with GetLastItem to iterate through an object's inventory.

Parameters

id	an object id

Returns: an object id, or 0

int GetQuestStatus ( string name )

Get quest status (int).

Parameters

name	quest name

Returns: quest status

float GetQuestStatusFloat ( string name )

Get quest status (int).

Parameters

name	quest name

Returns: quest status

int GetScore ( int id )

Get player object's score.

Parameters

id	an object id

Returns: score

int GetTrigger ( )

Get SELF if valid.

Returns: an object id, or 0

float GetWaypointX ( object waypoint )

Get waypoint X coordinate.

Parameters

waypoint a waypoint object

Returns: x coordinate

float GetWaypointY ( object waypoint )

Get waypoint Y coordinate.

Parameters

waypoint a waypoint object

Returns: y coordinate

void GiveXp	(	int	id,
		float	xp
	)

Grant experience to a player.

Parameters

id	an object id
xp	experience to gain

void GoBackHome ( int id )

Cause object to move to its starting location.

Parameters

id	an object id

void GroupAggressionLevel	(	object	objectGroup,
		float	level
	)

Set group of creature's aggression level.

This will set a group of creature's aggression level. The most commonly used value is 0.83.

Parameters

objectGroup	an object group object
level	aggression level

void GroupAttack	(	object	objectGroup,
		int	target
	)

Attack an object.

Parameters

objectGroup	an object group object
target	an object id

void GroupAwardSpell	(	object	objectGroup,
		string	spell
	)

Award spell level to objects in a group.

This will raise the spell level of the objects in the group. If an object can not cast this spell then it will have no effect on that object.

Parameters

objectGroup	an object group object
spell	a spell name Spell

void GroupCreateMover	(	object	objectGroup,
		object	waypoint,
		float	speed
	)

Creates a Mover for every object in a group.

Parameters

objectGroup	an object group object
waypoint	destination waypoint
speed	move speed

void GroupDamage	(	object	targetGroup,
		int	source,
		int	amount,
		int	type
	)

Damages objects in a group.

This will damage the target objects with a given source object, amount, and damage type.

Parameters

targetGroup	an object group object that receives damage
source	an object id as source of damange
amount	amount of damage
type	type of damange DamageType

void GroupDelete ( object objectGroup )

Delete objects in a group.

Parameters

objectGroup an object group object

void GroupEnchant	(	int	id,
		string	enchant,
		float	duration
	)

Grant objects in a group an enchantment.

This will grant the objects in a group an enchantment of a specified duration. If the enchantment name is incorrect, the game may crash.

Parameters

id	an object id
enchant	an enchantment name Enchant
duration	in seconds

void GroupHitFarLocation	(	object	objectGroup,
		float	x,
		float	y
	)

Ranged attack a location.

Parameters

objectGroup	an object group object
x	x coordinate
y	y coordinate

void GroupHitLocation	(	object	objectGroup,
		float	x,
		float	y
	)

Melee attack a location.

Parameters

objectGroup	an object group object
x	x coordinate
y	y coordinate

int GroupIsOwnedBy	(	int	id,
		object	target
	)

Get whether any object in target group is owned by object.

Parameters

id	an object id
target	an object group object

Returns: TRUE or FALSE

int GroupIsOwnedByAny	(	object	objectGroup,
		object	target
	)

Get whether any object in target is owned by any object in the group.

Parameters

objectGroup	an object group object
target	an object group object

Returns: TRUE or FALSE

void GroupLookAtDirection	(	object	objectGroup,
		int	direction
	)

Cause objects in a group to look in a direction.

Parameters

objectGroup	an object group object
direction	see Direction

void GroupMove	(	object	objectGroup,
		object	waypoint
	)

Move objects in a group to a waypoint.

This moves the objects in a group to a waypoint. The objects must be movable or attached to a "Mover". If the waypoint is linked, the objects will continue to move once they reach the first waypoint.

Parameters

objectGroup	an object group object
waypoint	a waypoint object

void GroupPauseObject	(	object	objectGroup,
		int	duration
	)

Pause objects of a group temporarily.

Parameters

objectGroup	an object group object
duration	number of frames

void GroupResumeLevel	(	object	objectGroup,
		float	percent
	)

Set when creature resumes due to health.

This will cause the creatures to stop retreating if its health is above the specified percentage.

Parameters

objectGroup	an object group object
percent	health ratio (0.0 - 1.0)

void GroupRetreatLevel	(	object	objectGroup,
		float	percent
	)

Set when creature retreats due to low health.

This will cause the creatures to retreat if its health falls below the specified percentage.

Parameters

objectGroup	an object group object
percent	low health ratio (0.0 - 1.0)

void GroupRunAway	(	object	objectGroup,
		int	target,
		int	duration
	)

Cause creatures to run away from target.

Parameters

objectGroup	an object group object
target	an object id to run away from
duration	number of frames

void GroupSetOwner	(	int	owner,
		object	targets
	)

Set the owner of objects in a group.

This is the same as SetOwner but with a object group as the target.

Parameters

owner	an object id
targets	an object group object

void GroupSetOwners	(	object	owners,
		object	targets
	)

Set the objects in a group as owners of target.

This is the same as SetOwners but with a object group as the target.

Parameters

owners	an object group object
targets	an object group object

void GroupSetRoamFlag	(	object	objectGroup,
		int	flags
	)

Set roaming flags.

Parameters

objectGroup	an object group object
flags	a 8-bit value (default is 0x80)

void GroupWalk	(	object	objectGroup,
		float	x,
		float	y
	)

Causes objects in a group to walk to a location.

Parameters

objectGroup	an object group object
x	x coordinate
y	y coordinate

void GroupWander ( object objectGroup )

Cause objects in a group to wander.

Parameters

objectGroup an object group object

int HasClass	(	int	id,
		string	className
	)

Get whether object has a class.

Parameters

id	an object id
className	a class name Class

Returns: TRUE or FALSE

int HasEnchant	(	int	id,
		string	enchant
	)

Get whether object has an enchant.

Parameters

id	an object id
enchant	an enchant name Enchant

Returns: TRUE or FALSE

int HasItem	(	int	holder,
		int	item
	)

Get whether the item is in the object's inventory.

Parameters

holder	an object id with inventory to check
item	an object id of item to check for

Returns: TRUE or FALSE

int HasSubclass	(	int	id,
		string	subclass
	)

Get whether object has subclass.

This will test whether an item has a specific subclass. The subclass overlaps, so you should probably test for the class first (HasClass).

Parameters

id	an object id
subclass	a subclass name

Returns: TRUE or FALSE

void HitFarLocation	(	int	id,
		float	x,
		float	y
	)

Ranged attack a location.

Parameters

id	an object id
x	x coordinate
y	y coordinate

void HitLocation	(	int	id,
		float	x,
		float	y
	)

Melee attack a location.

Parameters

id	an object id
x	x coordinate
y	y coordinate

void ImmediateBlind ( )

Immediately blind the host.

See also: Blind

string IntToString ( int number )

Convert an integer to a string.

This will convert an integer to a string, and add the string to the string table temporarily.

Parameters

number a integer number

Returns: a string

int IsAttackedBy	(	int	id1,
		int	id2
	)

Get whether object1 is being attacked by object2.

Parameters

id1	an object id
id2	an object id

int IsCaller ( int id )

Get whether object is OTHER.

Parameters

id	an object id

Returns: TRUE or FALSE

int IsCrown ( int id )

Get whether object is a Crown.

Parameters

id	an object id

Returns: TRUE or FALSE

int IsGameBall ( int id )

Get whether object is a GameBall.

Parameters

id	an object id

Returns: TRUE or FALSE

int IsLocked ( int id )

Get whether object is locked.

This will return whether an object is locked. It works with any kind of lock.

Parameters

id	an object id

Returns: locked state as TRUE or FALSE

int IsObjectOn ( int id )

Get whether object is enabled.

Parameters

id	an object id

Returns: enabled state as TRUE or FALSE

int IsOwnedBy	(	int	id,
		int	target
	)

Get whether target is owned by object.

Parameters

id	an object id
target	an object id

Returns: TRUE or FALSE

int IsOwnedByAny	(	object	objectGroup,
		int	target
	)

Get whether target is owned by any object in the group.

Parameters

objectGroup	an object group object
target	an object id

Returns: TRUE or FALSE

int IsSummoned ( int id )

Gets whether object is a summoned creature.

Parameters

id	an object id

Returns: TRUE or FALSE

int IsTalking ( )

Get whether host is talking.

Returns: TRUE or FALSE

int IsTrading ( )

Get whether the host is currently trading.

This will return whether the host is currently talking to shopkeeper.

Returns: TRUE or FALSE

int IsTrigger ( int id )

Get whether object is SELF.

Parameters

id	an object id

Returns: TRUE or FALSE

int IsVisibleTo	(	int	object1,
		int	object2
	)

Gets whether an object can see another object.

This will first check if the location of the objects are within 512 of each other coordinate-wise. It not, it returns FALSE.

It then checks whether the first object can see the second object.

Parameters

object1	an object id
object2	an object id

Returns: TRUE or FALSE

int IsWaypointOn ( object waypoint )

Get whether waypoint is enabled.

Parameters

waypoint a waypoint object

Returns: enabled state as TRUE or FALSE

void JournalDelete	(	int	id,
		string	message
	)

Delete entry from player's journal.

This will delete the first entry from a player object's journal whose message matches the specified message. If the player object id is 0, then all players are affected.

Parameters

id	an object id of player, or 0 for all players
message	entry to delete

void JournalEdit	(	int	id,
		string	message,
		int	type
	)

Edit entry in player's journal.

This will modify the first entry in a player object's journal whose message matches the specified message. If the player object id is 0, then all players are affected.

Parameters

id	an object id of player, or 0 for all players
message	entry to edit
type	see description of JournalEntry

void JournalEntry	(	int	id,
		string	message,
		int	type
	)

Add entry to player's journal.

This will add an entry to a player object's journal. The string can be any string, but should be less than 64 characters. The string is displayed according to the specified type:

0 = Green text, no sound 1 = White text 2 = Red text with quest label 3 = Green text 4 = Grey text with completed label 8 = Yellow text with hint label

If the player object id is 0, then it will add the journal entry to all players.

Parameters

id	an object id of player, or 0 for all players
message	string less than 64 characters
type	see description

void LockDoor ( int id )

Lock a door.

This will lock a door. It has no effect if the object is not a door.

Parameters

id	an object id

void LookAtDirection	(	int	id,
		int	direction
	)

Cause object to look in a direction.

Parameters

id	an object id
direction	see Direction

void LookAtObject	(	int	id,
		int	target
	)

Set direction of object so it is looking at another object.

Parameters

id	an object id
target	an object id to look at

void LookWithAngle	(	int	id,
		int	angle
	)

Set an object's direction.

This will set an object's direction. The direction is an angle represented as an integer between 0 and 255. Due east is 0, and the angle increases as the object turns clock-wise.

Parameters

id	an object id
angle	a number between 0 and 255

void MakeEnemy ( int id )

Unset object as friendly.

Parameters

id	an object id

void MakeFriendly ( int id )

Set object friendly with host.

Parameters

id	an object id

int MaxHealth ( int id )

Get object's maximum health.

Parameters

id	an object id

Returns: max mealth

void Move	(	int	id,
		object	waypoint
	)

Move an object to a waypoint.

This moves an object to a waypoint. The object must be movable or attached to a "Mover". If the waypoint is linked, the object will continue to move once it reaches the first waypoint.

Parameters

id	an object id
waypoint	a waypoint object

void MoveObject	(	int	id,
		float	x,
		float	y
	)

Set an object's location.

Parameters

id	an object id
x	x coordinate
y	y coordinate

void MoveWaypoint	(	object	waypoint,
		float	x,
		float	y
	)

Set a waypoint's location.

Parameters

waypoint	a waypoint object
x	x coordinate
y	y coordinate

void Music	(	int	music,
		int	volume
	)

Plays music.

Parameters

music	music id
volume	number from 0 - 100

void MusicEvent ( )

TODO

void MusicPopEvent ( )

TODO

void MusicPushEvent ( )

TODO

void NoWallSound ( int noWallSound )

Set no wall sound flag.

Parameters

noWallSound either TRUE (1) or FALSE (0)

int Object ( string name )

Lookup an object by name.

This will lookup an object by its script name and return the object id.

Parameters

name	object name

Returns: an object id

object ObjectGroup ( string name )

Lookup object group by name.

Parameters

name	a object group name

Returns: a object group object

void ObjectGroupOff ( object objectGroup )

Disable objects in a group.

Parameters

objectGroup an object group object

void ObjectGroupOn ( object objectGroup )

Enable objects in a group.

Parameters

objectGroup an object group object

void ObjectGroupToggle ( object objectGroup )

Toggle whether objects in group are disabled.

Parameters

objectGroup an object group object

void ObjectOff ( int id )

Disable an object.

Parameters

id	an object id

void ObjectOn ( int id )

Enable an object.

Parameters

id	an object id

void ObjectToggle ( int id )

Toggle whether object is disabled.

Parameters

id	an object id

void PauseObject	(	int	id,
		int	duration
	)

Pause an object temporarily.

Parameters

id	an object id
duration	number of frames

int Pickup	(	int	id,
		int	item
	)

Cause object to pickup an item.

Parameters

id	an object id
item	an object id to pickup

Returns: success as TRUE or FALSE

void Print ( string message )

Display a localized string.

This will display on a localized string on the screen of OTHER. If the string is not in the string database, it will instead print an error message with "MISSING:".

Parameters

message a string

void PrintToAll ( string message )

Display a localized string to everyone.

This will display on a localized string on everyone's screen. If the string is not in the string database, it will instead print an error message with "MISSING:".

Parameters

message a string

void PushObject	(	int	id,
		float	magnitude,
		float	x,
		float	y
	)

Push an object from a vector and magnitude.

This will calculate a unit vector from the object's location to the specified location, and multiply it by the specified magnitude. This vector will be added to the object's location.

Parameters

id	an object id
magnitude	force magnitude
x	force x coordinate
y	force y coordinate

void PushObjectTo	(	int	id,
		float	x,
		float	y
	)

Push an object to a location.

Parameters

id	an object id
x	x coordinate
y	y coordinate

void Raise	(	int	id,
		float	z
	)

Set an object's Z coordinate.

This will set an object's Z coordinate and then let the object fall down.

Parameters

id	an object id
z	z coordinate

void RaiseZombie ( int id )

Raise a zombie. Also clears stay down state.

Parameters

id	an object id

void RaiseZombieGroup ( object objectGroup )

Raise a zombie. Also clears stay down state.

Parameters

objectGroup an object group object

int Random	(	int	min,
		int	max
	)

Random number (int).

Parameters

min	minimum value
max	maximum value

Returns: random value between min and max

float RandomFloat	(	float	min,
		float	max
	)

Random number (float).

Parameters

min	minimum value
max	maximum value

Returns: random value between min and max

void ResetQuestStatus ( string name )

Delete quest status.

This will delete a quest status. The name can be a wildcard with an asterisk or with a map name.

TODO what is the wildcard syntax?

Parameters

name	quest name

void RestoreHealth	(	int	id,
		int	amount
	)

Restore object's health.

Parameters

id	an object id
amount	amount of health to restore

void ResumeLevel	(	int	id,
		float	percent
	)

Set when creature resumes due to health.

This will cause the creature to stop retreating if its health is above the specified percentage.

Parameters

id	an object id
percent	health ratio (0.0 - 1.0)

void RetreatLevel	(	int	id,
		float	percent
	)

Set when creature retreats due to low health.

This will cause the creature to retreat if its health falls below the specified percentage.

Parameters

id	an object id
percent	low health ratio (0.0 - 1.0)

void RunAway	(	int	id,
		int	target,
		int	duration
	)

Cause creature to run away from target.

Parameters

id	creature's object id
target	an object id to run away from
duration	number of frames

int SecondTimer	(	int	seconds,
		function	callback
	)

Create a timer with delay in seconds.

This will create a timer that calls the given script function after a delay given in seconds.

Parameters

seconds	delay
callback	a script function

Returns: timer id

int SecondTimerWithArg	(	int	seconds,
		any	argument,
		function	callback
	)

Create a timer with delay in seconds with an argument.

This will create a timer that calls the given script function after a delay given in seconds. The given argument will be passed into the script function.

Parameters

seconds	delay
argument	function argument
callback	a script function

Returns: timer id

void SetCallback	(	int	id,
		int	idx,
		function	callback
	)

Set a callback on an object.

This will set a function script to call for an event. The callback index is one of the following:

3 = Enemy sighted 4 = Looking for enemy 5 = Deatch 6 = Change focus 7 = Is hit 8 = Retreat 9 = Collision 10 = Enemy heard 11 = End of waypoint 13 = Lost sight of enemy

No other indexes are defined.

Parameters

id	an object id
idx	callback index
callback	a script function

void SetDialog	(	int	id,
		string	type,
		function	start,
		function	end
	)

Setup a conversation with object.

This will cause a conversation with the object. The type of conversation is one of: NORMAL, NEXT, YESNO, YESNONEXT. The start and end are script functions that are called at the start and end of the conversation.

If using a YESNO conversation, the end script function should use GetAnswer to retrieve the result.

Parameters

id	an object id
type	a conversation type string (NORMAL, NEXT, YESNO, YESNONEXT)
start	a script function
end	a script function

void SetHalberd ( int upgrade )

Upgrade host's oblivion staff.

This will upgrade the oblivion staff. The upgrades are:

0 = OblivionHalberd 1 = OblivionHeart 2 = OblivionWierdling 3 = OblivionOrb

Parameters

upgrade see description

void SetOwner	(	int	owner,
		int	target
	)

Set the owner of an object.

This will make an object the owner of the target. This will make the target friendly to the owner, and it will accredit the target's kills to the owner.

For example, in a multiplayer map, you might have a switch that activates a hazard. You can use this so that if the hazard kills anyone, the player who activated the hazard gets the credit.

Parameters

owner	an object id
target	an object id

void SetOwners	(	object	owners,
		int	target
	)

Set the objects in a group as owners of target.

This is the same as SetOwner but with a object group as the owner.

Parameters

owners	an object group object
target	an object id

void SetQuestStatus	(	int	status,
		string	name
	)

Set quest status (int).

Parameters

status	value to save
name	quest name

void SetQuestStatusFloat	(	float	status,
		string	name
	)

Set quest status (float).

Parameters

status	value to save
name	quest name

void SetRoamFlag	(	int	id,
		int	flags
	)

Set roaming flags.

Parameters

id	an object id
flags	a 8-bit value (default is 0x80)

void SetShopkeeperText	(	int	id,
		string	text
	)

Set shopkeeper text.

Parameters

id	an object id
text	a string less than 32 characters

void StartDialog	(	int	npc,
		int	other
	)

Starts a conversation between two objects.

This requires that SetDialog has already been used to setup the conversation on the NPC object.

Parameters

npc	an object id
other	an object id

void StartupScreen ( int arg1 )

Show startup screen to host.

Parameters

arg1

void StopScript ( any value )

Exit current script function.

Parameters

value the function return value, if it is non-void

void StoryPic	(	int	id,
		string	name
	)

Assigns a picture to a conversation.

Parameters

id	an object id
name	a picture name

void TellStory	(	string	audio,
		string	story
	)

Causes the telling of a story.

This will cause a story to be told. It relies on SELF and OTHER to be particular values, which limits this to being used in the SetDialog callbacks.

Example usage: TellStory("SwordsmanHurt", "Con05:OgreTalk07")

Parameters

audio	an audio event name that is usually "SwordsmanHurt"
story	a story name

void TrapSpells	(	int	id,
		string	spell1,
		string	spell2,
		string	spell3
	)

Set spells on a bomber.

Parameters

id	an object id
spell1	a spell name, or NULL Spell
spell2	a spell name, or NULL Spell
spell3	a spell name, or NULL Spell

void UnBlind ( )

Unblind the host.

int Unknownb8 ( int id )

TODO

Parameters

id	an object id

Returns: TRUE or FALSE

int Unknownb9 ( int id )

TODO

Parameters

id	an object id

Returns: TRUE or FALSE

void Unknownc4 ( )

TODO

void UnlockDoor ( int id )

Unlock a door.

This will unlock a door. It has no effect if the object is not a door.

Parameters

id	an object id

void Walk	(	int	id,
		float	x,
		float	y
	)

Causes an object to walk to a location.

Parameters

id	an object id
x	x coordinate
y	y coordinate

object Wall	(	int	x,
		int	y
	)

Get a pointer to a wall by its wall coordinates.

Parameters

x	wall coordinate X
y	wall coordinate Y

Returns: wall object

void WallBreak ( object wall )

Breaks a wall.

This will break a wall. The wall must be breakable.

Parameters

wall	a wall object

void WallClose ( object wall )

Close a wall.

Parameters

wall	a wall object

object WallGroup ( string name )

Lookup wall group by name.

Parameters

name	a wall group name

Returns: a wall group object

void WallGroupBreak ( object wallGroup )

Breaks walls in a group.

This will break walls in a group. The walls must be breakable.

Parameters

wallGroup a wall group object

void WallGroupClose ( object wallGroup )

Close walls in a group.

Parameters

wallGroup a wall group object

void WallGroupOpen ( object wallGroup )

Open walls in a group.

Parameters

wallGroup a wall group object

void WallGroupToggle ( object wallGroup )

Toggle walls in a group.

This will toggle a wall group between opened and closed.

Parameters

wallGroup a wall group object

void WallOpen ( object wall )

Open a wall.

Parameters

wall	a wall object

void WallToggle ( object wall )

Toggle a wall.

This will toggle wall between opened and closed.

Parameters

wall	a wall object

void Wander ( int id )

Cause an object to wander.

This will cause a NPC or monster to wander.

Parameters

id	an object id

object Waypoint ( string name )

Lookup waypoint by name.

Parameters

name	a waypoint name

Returns: a waypoint object

object WaypointGroup ( string name )

Lookup waypoint group by name.

Parameters

name	a waypoint group name

Returns: a waypoint group object

void WayPointGroupOff ( object waypointGroup )

Disable waypoints in a group.

Parameters

waypointGroup a waypoint group object

void WayPointGroupOn ( object waypointGroup )

Enable waypoints in a group.

Parameters

waypointGroup a waypoint group object

void WayPointGroupToggle ( object waypointGroup )

Toggle whether objects in group are disabled.

Parameters

waypointGroup a waypoint group object

void WayPointOff ( object waypoint )

Disable a waypoint.

Parameters

waypoint a waypoint object

void WayPointOn ( object waypoint )

Enable a waypoint.

Parameters

waypoint a waypoint object

void WayPointToggle ( object waypoint )

Toggle whether waypoint is disabled.

Parameters

waypoint a waypoint object

void WideScreen ( int value )

Parameters

value TRUE or FALSE

void ZombieGroupStayDown ( object objectGroup )

Set group of zombies to stay down.

Parameters

objectGroup an object group object

void ZombieStayDown ( int id )

Set zombie to stay down.

Parameters

id	an object id

Variable Documentation

const int FALSE = 0

FALSE value.

const int OTHER = -1

OTHER object id.

This constant can be used any place where an object id is used.

const int SELF = -2

SELF object id.

This constant can be used any place where an object id is used.

const int TRUE = 1

TRUE value.

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

Function Documentation

Variable Documentation