L2Project Documentation

Index

Enumerations

Events

OnAttack

OnAttack(attackerObjId: number, objId: number, isAOE: boolean): void

- Defined in src/index.ts:934
Parameters
- attackerObjId: number
- objId: number
- isAOE: boolean
Returns void

OnAutoAttackStart

OnAutoAttackStart(objId: number): void

- Defined in src/index.ts:938
Parameters
- objId: number
Returns void

OnAutoAttackStop

OnAutoAttackStop(objId: number): void

- Defined in src/index.ts:942
Parameters
- objId: number
Returns void

OnBeforeScriptStop

OnBeforeScriptStop(): void

Useful for cleaning up resources when stopping the script

Example

const connect = Me.PropertyChanged.connect((target, args) => {
  console.log(args.PropertyName)
})

globalThis.OnBeforeScriptStop = () => {
  connect.disconnect();
}

Returns void

OnChangeMoveType

OnChangeMoveType(objId: number, moveType: number): void

- Defined in src/index.ts:1002
Parameters
- objId: number
- moveType: number
Returns void

OnChangeWaitType

OnChangeWaitType(objId: number, waitType: number): void

- Defined in src/index.ts:1006
Parameters
- objId: number
- waitType: number
Returns void

OnCommunityBoardHtmlMessage

OnCommunityBoardHtmlMessage(html: string): void

- Defined in src/index.ts:950
Parameters
- html: string
Returns void

OnDeleteObject

OnDeleteObject(objId: number): void

- Defined in src/index.ts:966
Parameters
- objId: number
Returns void

OnDie

OnDie(objId: number): void

- Defined in src/index.ts:954
Parameters
- objId: number
Returns void

OnDropItem

OnDropItem(objId: number): void

- Defined in src/index.ts:970
Parameters
- objId: number
Returns void

OnGetItem

OnGetItem(itemId: number, playerId: number): void

- Defined in src/index.ts:974
Parameters
- itemId: number
- playerId: number
Returns void

OnIncomingPacket

OnIncomingPacket(packet: number[]): void

- Defined in src/index.ts:1026
Parameters
- packet: number[]
Returns void

OnInventoryItemUpdate

OnInventoryItemUpdate(action: number, objId: number): void

- Defined in src/index.ts:1022
Parameters
- action: number
- objId: number
Returns void

OnInventoryUpdate

OnInventoryUpdate(): void

- Defined in src/index.ts:1018
Returns void

OnLogin

OnLogin(): void

- Defined in src/index.ts:926
Returns void

OnLogout

OnLogout(): void

- Defined in src/index.ts:930
Returns void

OnMagicSkillUse

OnMagicSkillUse(objId: number, targetId: number, skillId: number): void

- Defined in src/index.ts:1014
Parameters
- objId: number
- targetId: number
- skillId: number
Returns void

OnMove

OnMove(num: number, X: number, Y: number, Z: number, dX: number, dY: number, dZ: number): void

- Defined in src/index.ts:994
Parameters
- num: number
- X: number
- Y: number
- Z: number
- dX: number
- dY: number
- dZ: number
Returns void

OnMoveStop

OnMoveStop(num: number, X: number, Y: number, Z: number): void

- Defined in src/index.ts:998
Parameters
- num: number
- X: number
- Y: number
- Z: number
Returns void

OnMyTargetSelected

OnMyTargetSelected(objId: number): void

- Defined in src/index.ts:990
Parameters
- objId: number
Returns void

OnNpcHtmlMessage

OnNpcHtmlMessage(html: string): void

- Defined in src/index.ts:946
Parameters
- html: string
Returns void

OnNpcSay

OnNpcSay(msgId: number, msg: string): void

- Defined in src/index.ts:1034
Parameters
- msgId: number
- msg: string
Returns void

OnPointsEnded

OnPointsEnded(): void

- Defined in src/index.ts:1042
Returns void

OnPointsNext

OnPointsNext(X: number, Y: number, Z: number): void

- Defined in src/index.ts:1054
Parameters
- X: number
- Y: number
- Z: number
Returns void

OnPointsStarted

OnPointsStarted(): void

- Defined in src/index.ts:1046
Returns void

OnPointsStopped

OnPointsStopped(): void

- Defined in src/index.ts:1050
Returns void

OnRevive

OnRevive(objId: number): void

- Defined in src/index.ts:958
Parameters
- objId: number
Returns void

OnSay

OnSay(charName: string, text: string, messageType: number): void

- Defined in src/index.ts:1038
Parameters
- charName: string
- text: string
- messageType: number
Returns void

OnShopList

OnShopList(shopId: number, itemsList: L2EntityCollection<L2Item>): void

- Defined in src/index.ts:1066
Parameters
- shopId: number
- itemsList: L2EntityCollection<L2Item>
Returns void

OnSkillList

OnSkillList(skillList: L2EntityCollection<L2Skill>): void

- Defined in src/index.ts:1010
Parameters
- skillList: L2EntityCollection<L2Skill>
Returns void

OnSpawnItem

OnSpawnItem(objId: number): void

- Defined in src/index.ts:962
Parameters
- objId: number
Returns void

OnSystemMessage

OnSystemMessage(id: number): void

- Defined in src/index.ts:1030
Parameters
- id: number
Returns void

OnTargetSelected

OnTargetSelected(objId: number, targetObjId: number): void

- Defined in src/index.ts:982
Parameters
- objId: number
- targetObjId: number
Returns void

OnTargetUnselected

OnTargetUnselected(targetObjId: number): void

- Defined in src/index.ts:986
Parameters
- targetObjId: number
Returns void

OnTeleportToLocation

OnTeleportToLocation(objId: number, X: number, Y: number, Z: number): void

- Defined in src/index.ts:978
Parameters
- objId: number
- X: number
- Y: number
- Z: number
Returns void

OnTrade

OnTrade(traderObjId: number, itemsList: L2EntityCollection<L2Item>): void

- Defined in src/index.ts:1070
Parameters
- traderObjId: number
- itemsList: L2EntityCollection<L2Item>
Returns void

OnWareHouseDepositList

OnWareHouseDepositList(itemsList: L2EntityCollection<L2Item>): void

- Defined in src/index.ts:1058
Parameters
- itemsList: L2EntityCollection<L2Item>
Returns void

OnWareHouseWithdrawalList

OnWareHouseWithdrawalList(itemsList: L2EntityCollection<L2Item>): void

- Defined in src/index.ts:1062
Parameters
- itemsList: L2EntityCollection<L2Item>
Returns void

OnWindowOpenNpcDialog

OnWindowOpenNpcDialog(windowHandle: BotWindow): void

- Defined in src/index.ts:1116
Parameters
- windowHandle: BotWindow
Returns void

OnWindowOpenPlayerStore

OnWindowOpenPlayerStore(windowHandle: BotWindow): void

- Defined in src/index.ts:1112
Parameters
- windowHandle: BotWindow
Returns void

OnWindowOpenPrivateStore

OnWindowOpenPrivateStore(windowHandle: BotWindow): void

- Defined in src/index.ts:1108
Parameters
- windowHandle: BotWindow
Returns void

OnWindowOpenRecipeBook

OnWindowOpenRecipeBook(windowHandle: BotWindow): void

- Defined in src/index.ts:1104
Parameters
- windowHandle: BotWindow
Returns void

OnWindowOpenSendMail

OnWindowOpenSendMail(windowHandle: BotWindow): void

- Defined in src/index.ts:1100
Parameters
- windowHandle: BotWindow
Returns void

OnWindowOpenShop

OnWindowOpenShop(windowHandle: BotWindow): void

- Defined in src/index.ts:1096
Parameters
- windowHandle: BotWindow
Returns void

OnWindowOpenStore

OnWindowOpenStore(windowHandle: BotWindow): void

- Defined in src/index.ts:1092
Parameters
- windowHandle: BotWindow
Returns void

OnWindowOpenTrade

OnWindowOpenTrade(windowHandle: BotWindow): void

- Defined in src/index.ts:1088
Parameters
- windowHandle: BotWindow
Returns void

OnWindowOpenWarehouse

OnWindowOpenWarehouse(windowHandle: BotWindow): void

- Defined in src/index.ts:1084
Parameters
- windowHandle: BotWindow
Returns void

Variables

BuffsList

BuffsList: IContext["BuffList"]

Context

Context: IContext

Instance of SendToServer class provided to the script engine.

Send.StopMove();
Send.RequestItemList();

SkillsList

SkillsList: IContext["SkillList"]

Target

Target: IContext["Target"]

FILE

__FILE__: string

Filepath of current script.

__VERSION

__VERSION: string

Current version of running program. eg: 2.3.0

console

console: DebugConsole

Functions

Const Attack

Attack(objectId: number): void

- Defined in src/index.ts:789
Parameters
- objectId: number
Returns void

Const DisableBot

DisableBot(): void

- Defined in src/index.ts:800
See IContext.DisableBot.

Returns void

Dispatch

Dispatch(callback: () => void): void

- Defined in src/index.ts:872
Dispatch a callback within the current UI thread context

Parameters
- callback: () => void
  - - (): void
    - Returns void
Returns void

Const EnableBot

EnableBot(): void

- Defined in src/index.ts:807
See IContext.EnableBot.

Returns void

Const RunCommand

RunCommand(command: string): void

- Defined in src/index.ts:845
Parameters
- command: string
Returns void

Say

Say(text: any): ReturnType<SendToServer["Say2"]>

- Defined in src/index.ts:874
Parameters
- text: any
Returns ReturnType<SendToServer["Say2"]>

SayToAlly

SayToAlly(text: any): ReturnType<SendToServer["Say2"]>

- Defined in src/index.ts:876
Parameters
- text: any
Returns ReturnType<SendToServer["Say2"]>

SayToClan

SayToClan(text: any): ReturnType<SendToServer["Say2"]>

- Defined in src/index.ts:878
Parameters
- text: any
Returns ReturnType<SendToServer["Say2"]>

SayToParty

SayToParty(text: any): ReturnType<SendToServer["Say2"]>

- Defined in src/index.ts:880
Parameters
- text: any
Returns ReturnType<SendToServer["Say2"]>

SayToTrade

SayToTrade(text: any): ReturnType<SendToServer["Say2"]>

- Defined in src/index.ts:882
Parameters
- text: any
Returns ReturnType<SendToServer["Say2"]>

Const Select

Select(name: string, range: number): L2Creature

- Defined in src/index.ts:847
Parameters
- name: string
- range: number
Returns L2Creature

Const SetCombatRect

SetCombatRect(x1: number, y1: number, x2: number, y2: number): void

- Defined in src/index.ts:849
Parameters
- x1: number
- y1: number
- x2: number
- y2: number
Returns void

Const SetWindowTitle

SetWindowTitle(title: string): void

- Defined in src/index.ts:851
Parameters
- title: string
Returns void

Shout

Shout(text: any): ReturnType<SendToServer["Say2"]>

- Defined in src/index.ts:884
Parameters
- text: any
Returns ReturnType<SendToServer["Say2"]>

Const ShowBaloonTip

ShowBaloonTip(title: string, message: string, timeout: number): void

- Defined in src/index.ts:853
Parameters
- title: string
- message: string
- timeout: number
Returns void

Const StartCombat

StartCombat(): void

- Defined in src/index.ts:860
See IContext.StartCombat.

Returns void

Const StopCombat

StopCombat(): void

- Defined in src/index.ts:865
See IContext.StopCombat.

Returns void

Tell

Tell(text: any, target: any): ReturnType<SendToServer["Say2"]>

- Defined in src/index.ts:886
Parameters
- text: any
- target: any
Returns ReturnType<SendToServer["Say2"]>

alert

alert(msg: any): void

- Defined in src/index.ts:888
Parameters
- msg: any
Returns void

assert_min_version

assert_min_version(ver: any): void

- Defined in src/index.ts:895
throws
When min version requirement for script is not met.

Parameters
- ver: any
  
  min version number eg: 2.1.1
Returns void

clearInterval

clearInterval(id: any): void

- Defined in src/index.ts:897
Parameters
- id: any
Returns void

clearTimeout

clearTimeout(id: any): void

- Defined in src/index.ts:899
Parameters
- id: any
Returns void

confirm

confirm(msg: any, title: any): any

- Defined in src/index.ts:901
Parameters
- msg: any
- title: any
Returns any

prompt

prompt(question: any, defaultValue: any, title: any): any

- Defined in src/index.ts:903
Parameters
- question: any
- defaultValue: any
- title: any
Returns any

setInterval

setInterval(callback: any, ms: any): any

- Defined in src/index.ts:905
Parameters
- callback: any
- ms: any
Returns any

setTimeout

setTimeout(callback: any, ms: any): any

- Defined in src/index.ts:907
Parameters
- callback: any
- ms: any
Returns any

sleep

sleep(ms: number): Promise<void>

- Defined in src/index.ts:919
Sets a timer for specified amount of miliseconds and resolves the promise when timeout is reached.
```
console.log('start');
await sleep(500);
console.log('after 500ms');
```
Parameters
- ms: number
  
  Amount of miliseconds to sleep for.
Returns Promise<void>

Index

Enumerations

Interfaces

Events

Variables

Functions

Events

OnAttack

Parameters

attackerObjId: number

objId: number

isAOE: boolean

Returns void

OnAutoAttackStart

Parameters

objId: number

Returns void

OnAutoAttackStop

Parameters

objId: number

Returns void

OnBeforeScriptStop

Returns void

OnChangeMoveType

Parameters

objId: number

moveType: number

Returns void

OnChangeWaitType

Parameters

objId: number

waitType: number

Returns void

OnCommunityBoardHtmlMessage

Parameters

html: string

Returns void

OnDeleteObject

Parameters

objId: number

Returns void

OnDie

Parameters

objId: number

Returns void

OnDropItem

Parameters

objId: number

Returns void

OnGetItem

Parameters

itemId: number

playerId: number

Returns void

OnIncomingPacket

Parameters

packet: number[]

Returns void

OnInventoryItemUpdate

Parameters

action: number

objId: number

Returns void

OnInventoryUpdate

Returns void

OnLogin

Returns void

OnLogout

Returns void

OnMagicSkillUse

Parameters

objId: number

targetId: number

skillId: number

Returns void

OnMove

Parameters

num: number

X: number

Y: number