UOX3 Script Engine

Functions, Methods, Properties and Event handling

Region Properties

Property Purpose
name Returns/Sets the name of the region.
mayor Returns character that's designated as region's mayor (or null if there is none).
race Returns/Sets the race this region belongs to.
tax Returns/Sets the taxvalue for this region.
taxResource Returns/Sets the tax-resource for this region.
canMark If true, the Mark spell can be used in this region. If false, it cannot.
canRecall If true, the Recall spell can be used in this region. If false, it cannot.
canGate If true, the Gate spell can be used in this region. If false, it cannot.
canTeleport If true, the Gate spell can be used in this region. If false, it cannot.
isGuarded If true, the region is guarded. If false, it's not.
canCastAggressive If true, it's possible to cast "aggressive" spells in this region.
health Returns the health of the townstone for this region.
isDungeon If true, this region will count as a dungeon-region, and will be unaffected by the day/night cycles.
chanceBigOre Returns/Sets the chance to find big ores in this region.
chanceColourOre Returns/Sets the chance of finding coloured ore in this region.
numOrePrefs Returns the number of ore preferences present for the region.
population Returns the population of this region.
members Returns a comma-separated string of town member serials
canPlaceHouse Returns whether houses can be placed in this region.
worldNumber Gets/Sets the worldnumber the region exists in
instanceID Gets/Sets the instanceID the region exists in
isSafeZone Gets/Sets whether the region is considered a safe zone where not hostile actions may be taken
scriptTriggers Returns a list of all scripttriggers attached to the region
taxes Gets/Sets collected gold reserves for townregion
reserves Gets/Sets collected resource reserves for townregion
appearance Gets/Sets visual appearance (season) of townregion
music Gets/Sets musicList for the townregion, as originally specified in region DFNs
weather Gets/Sets the weather ID of the townregion
owner Gets the name of the guard owner for the townregion
Original: ©Copyright 2000-2001 WWW.UOX3.NET (Daniel Stratton/Matthew Randall) ||| Rewrite: ©Copyright 2002 WWW.UOXDEV.DE (Florian "Rukus" Frick) Rewrite: ©Copyright 2003-2021 WWW.UOX3.ORG (Xuri)