User Tools

Site Tools


scripting-mobiles

Scripting - Mobiles data and function

Here can find some infomation 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
Exception: If mobile not found function return null!




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

Serial Filter
Syntax Mobiles.Filter.Serials
Description:
Set a list of serial to filter in ApplyFilter function.
Returns: list
In Object: Mobiles

Bodyes Filter
Syntax Mobiles.Filter.Bodies
Description:
Set a list of body to filter in ApplyFilter function.
Returns: list
In Object: Mobiles

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

Range Min Filter
Syntax Mobiles.Filter.RangeMin
Description:
Set a value of minimum range in ApplyFilter function
Returns: int
In Object: Mobiles

Range Max Filter
Syntax Mobiles.Filter.RangeMax
Description:
Set a value of maximum range in ApplyFilter function
Returns: int
In Object: Mobiles

Color Filter
Syntax Mobiles.Filter.Hues
Description:
Set a list of color to filter in ApplyFilter function.
Returns: list
In Object: Mobiles

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

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

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

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

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

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

Notorieties color Filter
Syntax Mobiles.Filter.Notorieties
Description:
Set a filter by byte list for notorieties color for ApplyFilter function.
Returns: list
In Object: Mobiles

Ignore list Filter
Syntax Mobiles.Filter.CheckIgnoreObject
Description:
Set search parameter True or false for remove IgnoreObject from result.
Type: bool
In Object: Mobiles




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 whit a filter
Syntax Mobiles.ApplyFilter(filter)
Description:
Seatch a mobile by filter
Returns: list(mobile)
In Object: Mobiles

Apply a selector on mobile list
Syntax Mobiles.Select((List)Mobile, string)
Description:
Apply a selector on mobile list. Possible selector:
  • Random
  • Nearest
  • Farthest
  • Weakest
  • Strongest
  • Next
Returns: Mobile
In Object: Mobiles




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




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: Int
In Object: Items
Parameters: Int mobserial or item mobiletocheck, string contextstring

scripting-mobiles.txt · Last modified: 2018/09/30 23:06 by wikiadmin