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

GetClilocByID

Returns the localized cliloc string for the given ClilocID.

If Params is provided, the method substitutes ~placeholder~ tokens in the cliloc template with corresponding parameter values. Parameters prefixed with # are treated as nested cliloc IDs and resolved recursively.

Returns an empty string if the character is disconnected or UO data files are not loaded.

Возвращает локализованную cliloc-строку по указанному ClilocID.

Если передан массив Params, метод подставляет значения параметров вместо токенов ~placeholder~ в шаблоне cliloc-строки. Параметры с префиксом # интерпретируются как вложенные cliloc ID и разрешаются рекурсивно.

Возвращает пустую строку, если персонаж не подключён или файлы UO Data не загружены.

DWS

DWScript only. Not available in PascalScript.

function GetClilocByID(ClilocID: Cardinal; Params: TArray<String>): String;

DWScript overload (without parameters):

function GetClilocByID(ClilocID: Cardinal): String;

Parameters:

  • ClilocID — cliloc message ID.
  • Params — array of substitution values for ~placeholder~ tokens. Optional in the overloaded form.

Python

def GetClilocByID(ClilocID: int, Params: list[str]) -> str: ...

Pascal Example

var
  Name: String;
begin
  // Simple lookup — no parameters
  Name := GetClilocByID(1042971);
  AddToSystemJournal('Cliloc 1042971: ' + Name);

  // With parameter substitution
  Name := GetClilocByID(1060847, ['Iron', 'Valorite', 'Ingots']);
  AddToSystemJournal('Result: ' + Name);
end.

Python Example

# Simple lookup — pass empty list for Params
name = GetClilocByID(1042971, [])
AddToSystemJournal(f'Cliloc 1042971: {name}')

# With parameter substitution
name = GetClilocByID(1060847, ['Iron', 'Valorite', 'Ingots'])
AddToSystemJournal(f'Result: {name}')

See Also

GetTooltip, GetToolTipRec