Table of Contents

Scripting - Mobiles data and function

Here can find some information about Enhanced Scripting function and data about Mobiles!

Find

Find Mobile by Serial
Syntax Mobiles.FindBySerial(int)
Description:
Find Mobile and get mobile object by specific serial
Returns mobile
In Object: Mobiles
Parameters: Int serialnumber

Use

Use Mobile
Syntax Mobiles.UseMobile(mobile or int)
Description:
Use (double click) specific mobile, can insert mobile object or serial
Returns none
In Object: Mobiles
Parameters: Mobile mobiletouse or Int serialmobiletouse

Single Click
Syntax Mobiles.SingleClick(mobile or int)
Description:
Perform a single click on specific mobile, can insert mobile object or serial
Returns none
In Object: Mobiles
Parameters: Mobile mobiletoclick or Int serialmobiletoclick

Filter Type

Enable Filter
Syntax Mobiles.Filter.Enabled
Description:
Enable or not filter in ApplyFilter function.
Returns bool
In Object: Mobiles
Parameters:
Serial Filter
Syntax Mobiles.Filter.Serials
Description:
Set a list of serial to filter in ApplyFilter function.
Returns list
In Object: Mobiles
Parameters:

CheckLineOfSite
Syntax Mobiles.Filter.CheckLineOfSite
Description:
Will check that a mobile is within your line of site.
Returns list
In Object: Mobiles
Parameters:

Bodies Filter
Syntax Mobiles.Filter.Bodies
Description:
Set a list of body to filter in ApplyFilter function.
Returns list
In Object: Mobiles
Parameters:
Name Filter
Syntax Mobiles.Filter.Name
Description:
Set a name to filter in ApplyFilter function, blank no filter by name
Returns string
In Object: Mobiles
Parameters:
Range Min Filter
Syntax Mobiles.Filter.RangeMin
Description:
Set a value of minimum range in ApplyFilter function
Returns int
In Object: Mobiles
Parameters:
Range Max Filter
Syntax Mobiles.Filter.RangeMax
Description:
Set a value of maximum range in ApplyFilter function
Returns int
In Object: Mobiles
Parameters:
Z Range Min Filter
Syntax Mobiles.Filter.ZRangeMin
Description:
Set a value of minimum Z range in ApplyFilter function
Returns int
In Object: Mobiles
Parameters:
Z Range Max Filter
Syntax Mobiles.Filter.ZRangeMax
Description:
Set a value of maximum Z range in ApplyFilter function
Returns int
In Object: Mobiles
Parameters:
Color Filter
Syntax Mobiles.Filter.Hues
Description:
Set a list of color to filter in ApplyFilter function.
Returns list
In Object: Mobiles
Parameters:
Poisoned Filter
Syntax Mobiles.Filter.Poisoned
Description:
Set a filter by poisoned flag for ApplyFilter function. 1 On, 0 Off, -1 Both
Returns int
In Object: Mobiles
Parameters:
Human Filter
Syntax Mobiles.Filter.IsHuman
Description:
Set a filter by Human flag for ApplyFilter function. 1 On, 0 Off, -1 Both
Returns int
In Object: Mobiles
Parameters:
Ghost Filter
Syntax Mobiles.Filter.IsGhost
Description:
Set a filter by Ghost flag for ApplyFilter function. 1 On, 0 Off, -1 Both
Returns int
In Object: Mobiles
Parameters:
Sex Filter
Syntax Mobiles.Filter.Female
Description:
Set a filter by sex for ApplyFilter function. 1 Female, 0 Male, -1 Both
Returns int
In Object: Mobiles
Parameters:
Warmode Filter
Syntax Mobiles.Filter.Warmode
Description:
Set a filter by warmode flag for ApplyFilter function. 1 On, 0 Off, -1 Both
Returns int
In Object: Mobiles
Parameters:
Friend Filter
Syntax Mobiles.Filter.Friend
Description:
Set a filter by friend list for ApplyFilter function. 1 On, 0 Off, -1 Both
Returns int
In Object: Mobiles
Parameters:
Notorieties color Filter
Syntax Mobiles.Filter.Notorieties
Description:
Set a filter by byte list for notorieties color for ApplyFilter function. blue = 1, green = 2, gray = 3, gray crim = 4, orange = 5, red = 6, yellow = 7
Returns list
In Object: Mobiles
Parameters:
Ignore list Filter
Syntax Mobiles.Filter.CheckIgnoreObject
Description:
Set search parameter True or false for remove IgnoreObject from result.
Returns bool
In Object: Mobiles
Parameters:
Ignore Pets list Filter
Syntax Mobiles.Filter.IgnorePets
Description:
Remove any of your pets from the returned filter list.
Returns bool
In Object: Mobiles
Parameters:

Message

Mobile Message
Syntax Mobiles.Message(mobile or int, int, string)
Description:
Display a message over specific mobile whit color.
Returns void
In Object: Mobiles
Parameters: Int MobileSerial or Mobile SelectedMobile, Int MessageColor, String Message

ApplyFilter

Search Mobile with a filter
Syntax Mobiles.ApplyFilter(filter)
Description:
Seatch a mobile by filter
Returns list(mobile)
In Object: Mobiles
Parameters: filter
Apply a selector on mobile list
Syntax Mobiles.Select( List<Mobile>, string)
Description:
Apply a selector on mobile list.
Returns Mobile
In Object: Mobiles
Parameters: List<Mobile>, string
Possible selector:

  • Random
  • Nearest
  • Farthest
  • Weakest
  • Strongest
  • Next

Properties

Mobile WaitforProps
Syntax Mobiles.WaitForProps(mobile or int, int)
Description:
Retrive Propriety of specific mobile.
Returns none
In Object: Mobiles
Parameters: Mobile mobiletocheck, int serialmobiletocheck, Int delay of props wait (ms)

Get Item Proprerties
Syntax Mobiles.GetPropValue(int or mobile, string)
Description:
Get value of item propriety
Returns int
In Object: Mobiles
Parameters: Int serialtoinspect or mobile mobiletoinspect, String PropName
Get Mobile Proprerties String
Syntax Mobiles.GetPropStringByIndex(int or mobile, int)
Description:
Get string name of prop by index, if no prop in selected index return empty.
Returns string
In Object: Mobiles
Parameters: Int serialtoinspect or mobile mobiletoinspect, Int PropIndex

Get Mobile Proprerties String List
Syntax Mobiles.GetPropStringList(int or mobile)
Description:
Get string list of all props name on specific mobile, if item no props list is empty.
Returns List (String)
In Object: Mobiles
Parameters: Int serialtoinspect or mobile mobiletoinspect

Mobile WaitForStats
Syntax Mobiles.WaitForStats (mobile or int, int)
Description:
Retrive stat value of specific mobile. This is for OSI or server not send stats if no open bars.
Returns none
In Object: Mobiles
Parameters: Mobile mobiletocheck, int serialmobiletocheck, Int delay of props wait (ms)

Context

Context Exist
Syntax Mobiles.ContextExist(int or mobile, string)
Description:
Check on specific mobile if context menu by string exist. Return context id if exist, -1 if not present.
Returns string
In Object: Mobiles
Parameters: Int mobserial or item mobiletocheck, string contextstring
Get the last tracking information
Syntax Mobiles.GetTrackingInfo( )
Description:
returns a structure of the last tracking info
use in your code like:

#
tracking = Mobiles.GetTrackingInfo()
Misc.SendMessage("serial: 0x{:x} at x:{} y:{} ts: {}".format(tracking.serial, tracking.x, tracking.y, tracking.lastUpdate))
#

Returns public struct LastTrackingInfo

      {
          public UInt16 x;
          public UInt16 y;
          public UInt32 serial;
          public DateTime lastUpdate;
      }

In Object: Misc
Parameters: none