Home API Manuals About Forum
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

GetCliloc

Returns the tooltip text for the object with ObjID as a pre-formatted string. Returns an empty string if the object has no tooltip.

Synonym for GetTooltip.

In Python, this method is named GetTooltip.

For structured tooltip data (cliloc IDs with parameters), use GetToolTipRec.

Возвращает текст тултипа объекта с ObjID в виде готовой строки. Возвращает пустую строку, если у объекта нет тултипа.

Синоним для GetTooltip.

В Python метод называется GetTooltip.

Для получения структурированных данных тултипа (cliloc ID с параметрами) используйте GetToolTipRec.

Pascal

function GetCliloc(ObjID: Cardinal): String;

Parameters:

  • ObjID — ID of the object.

Python

def GetTooltip(ObjID: int) -> str: ...

Pascal Example

begin
  if FindTypeEx($0E21, $FFFF, Backpack, False) > 0 then
    AddToSystemJournal('Tooltip: ' + GetCliloc(FindItem));
end.

Python Example

if FindTypeEx(0x0E21, 0xFFFF, Backpack(), False) > 0:
    AddToSystemJournal(f'Tooltip: {GetTooltip(FindItem())}')

See Also

GetToolTipRec, GetClilocByID