Project

General

Profile

Entity (Data Type)

Description

This DataType includes information and performs actions that are exclusive to the ISXEVE extension.

Members

  • Identification
    • int64 ID
    • string <MW_DOUBLEBRACKET>Category</MW_DOUBLEBRACKET>
    • int <MW_DOUBLEBRACKET>Category|CategoryID</MW_DOUBLEBRACKET>
    • int64 CharID
    • string Group
    • int GroupID
    • string Name
    • int64 OwnerID
      • If the owner is a PC/PLAYER, it is the same as that player's 'CharID'.
    • pilot Owner
    • int Owner
      • If the entity has an owner that is currently in your "Locals" list, then this will return that owner as a 'pilot' datatype object. ::If not, it will return the ownerID# as an integer.
    • float64 Security
    • string Type
    • int TypeID
    • int WreckID
    • activedrone ToActiveDrone
    • attacker ToAttacker
      • Will return null if not a valid attacker
    • jammer ToJammer
    • bool IsWarpScramblingMe
    • bool IsTargetJammingMe
    • float64 Bounty
  • Logical Status
    • bool IsCloaked
    • bool IsInteractive
    • bool IsMassive
    • bool IsGlobal
    • bool IsMoribund
    • bool IsWarpScrambled
    • bool IsActiveTarget
    • bool IsLockedTarget
    • bool IsNPC
    • bool IsPC
    • bool IsAbandoned
    • bool HaveLootRights
      • Return TRUE if the entity is owned by you, someone in your corporation, someone in your fleet, or is abandoned
Return FALSE otherwise.
    • bool IsWreckEmpty
      • ie, does the wreck have loot in it
    • bool IsWreckViewed
    • bool IsOwnedByCorpMember
      • ie, is the container/wreck/etc owned by someone in your corp.
    • bool IsOwnedByAllianceMember
      • ie, is the container/wreck/etc owned by someone in your alliance
    • int Mode
      • Known Modes
0 - Aligned
1 - Approaching
2 - Stopped
3 - Warping (in warp)
4 - Orbiting
    • bool IsTargetingMe
    • bool BeingTargeted
      • Return TRUE if your ships is in the process of locking the entity 
    • entity Approaching
    • entity Following
    • bool IsAbandoned
  • Cargo
    • float64 CargoCapacity
    • float64 UsedCargoCapacity
    • evewindow LootWindow
      • If you have used "OpenCargo" on this entity and a 'loot window' has appeared, then this member will return an evewindow datatype object representing that lootwindow. Otherwise, it will return NULL.
    • evewindow CargoWindow
      • Alias for 'LootWindow'
    • evewindow StorageWindow
    • bool HasOreHold

Methods

  • Interaction
    • Abandon
      • Note: This is the preferred method if your script is abandoning one thing at a time.
    • AbandonAll
      • Abandons all of nearby entities of the same group type
    • Activate
      • 'Acceleration Gate' entities only. You must also be in range to activate.
    • Open
    • CreateBookmark<MW_SINGLEBRACKET><label>,<notes></MW_SINGLEBRACKET>
      • Creates bookmark. and are optional. Requires at least one parameter.
    • Dock
      • Dock with a station
NOTE: This method only works if you're within docking range of the station.
    • Jump
      • 'Stargate' entities only. You must also be in range to jump.
    • SetName<MW_SINGLEBRACKET><text></MW_SINGLEBRACKET>
      • Sets the entity (container, probably) name
Note - It's the responsibility of the script to know whether or not an entity can have its name set
    • SetFleetTag<MW_SINGLEBRACKET><text></MW_SINGLEBRACKET>
      • Note: Only usable when in fleet
Note: Limited to the set of fleet tags assignable in-game, currently ABCDEFGHIJXYZ0123456789
  • Targeting
    • LockTarget
    • MakeActiveTarget
      • Selects a locked target as your current Active target
    • UnlockTarget
  • Movement
    • KeepAtRange<MW_SINGLEBRACKET>distance</MW_SINGLEBRACKET>
      • Distance is in meters. If no distance is given, ISXEVE uses a default of 1000.
    • AlignTo
    • Approach<MW_SINGLEBRACKET>distance</MW_SINGLEBRACKET>
      • Distance is in meters. If no distance is given, ISXEVE uses a default of 50.
    • Orbit<MW_SINGLEBRACKET>distance</MW_SINGLEBRACKET>
      • Distance is in meters. If no distance is given, ISXEVE uses a default of 5000.
    • WarpFleetTo<MW_SINGLEBRACKET>distance</MW_SINGLEBRACKET>
      • Distance is in meters. If no distance is given, zero distance will be used.
    • WarpTo<MW_SINGLEBRACKET>distance</MW_SINGLEBRACKET>
      • Distance is in meters. If no distance is given, zero distance will be used.
  • Information Retrieval
    • GetActiveDrones<MW_SINGLEBRACKET><index:activedrone></MW_SINGLEBRACKET>
      • Get Active Drones for yourself.
    • GetCargo<MW_SINGLEBRACKET><index:item></MW_SINGLEBRACKET>
      • Gets a list of cargo items.
    • GetCorpHangarsCargo<MW_SINGLEBRACKET>index:item</MW_SINGLEBRACKET> (retrieves ALL items)
    • GetCorpHangarsCargo<MW_SINGLEBRACKET>index:item, "FOLDERNAME"</MW_SINGLEBRACKET> (retrieve items from a particular folder)
    • GetCorpHangarsCargo<MW_SINGLEBRACKET>index:item, index:string</MW_SINGLEBRACKET> (retrieve items from all folders named in the index:string)
  • Methods for drones only
    • EngageMyTarget
    • Mine
    • MineRepeatedly
    • ReturnAndOrbit
    • ReturnToDroneBay
    • ScoopToCargoBay
    • ScoopToDroneBay