API UO GetSkillLockState en

UO.GetSkillLockState

ClassicUO / Basic IDE

Home · API A–Z · Каталоги

Reads the local skill advancement mode.

Exact syntax

UO.GetSkillLockState(SkillName:Any) -> Integer

Parameters

• SkillName — Required skill: a name from client data, such as "Mining" or "Animal Lore", or a decimal index from 0 through Skills.Length−1, as a number or string. Names ignore case, trim outer whitespace and replace _ with a space. This is neither an item ID nor a one-based index. Numeric strings always select an index.

Returns

Integer: 0 — increase, 1 — decrease, 2 — locked. A mode code, not true/false. An unknown skill or absent player returns −1.

Behavior

• Invoke reads existing data on the game thread and sends no network packets. It neither uses nor trains a skill. Two queries are separate snapshots.
• Required skill: a name from client data, such as "Mining" or "Animal Lore", or a decimal index from 0 through Skills.Length−1, as a number or string. Names ignore case, trim outer whitespace and replace _ with a space. This is neither an item ID nor a one-based index. Numeric strings always select an index.
• ExecuteClientApiCompatibility selects the command branch. Text reads the skill selector; Arg reads numeric selectors and modes. Unconvertible arguments may raise a conversion error.

Internal functions: from call to result

These are actual internal C# stages. ReadMode is a fully defined helper in the example, not an undocumented built-in command.

1. ExecuteClientApiCompatibility

ExecuteClientApiCompatibility selects the command branch. Text reads the skill selector; Arg reads numeric selectors and modes. Unconvertible arguments may raise a conversion error.

Integer: 0 — increase, 1 — decrease, 2 — locked. A mode code, not true/false. An unknown skill or absent player returns −1.

Project source: external/InjectionScript/src/InjectionScript/Runtime/InjectionApiUO.cs; function ExecuteClientApiCompatibility.

2. Invoke

Invoke reads on the game thread; a worker waits for the manager to process the request. Script cancellation interrupts that wait. No extra delay or network query is added.

Invoke reads existing data on the game thread and sends no network packets. It neither uses nor trains a skill. Two queries are separate snapshots.

Project source: src/ClassicUO.Client/Game/Managers/ClassicUOInjectionApiBridge.cs; function Invoke.

3. FindSkillUnsafe

FindSkillUnsafe first validates a decimal index and its bounds; otherwise it normalizes the name and matches Skill.Name exactly, ignoring case. An unknown name yields null; no target opens.

An unknown skill or absent player returns −1.

Project source: src/ClassicUO.Client/Game/Managers/ClassicUOInjectionApiBridge.cs; function FindSkillUnsafe.

4. GetSkillLockState

Reads the local skill advancement mode.

Integer: 0 — increase, 1 — decrease, 2 — locked. A mode code, not true/false. An unknown skill or absent player returns −1.

Project source: src/ClassicUO.Client/Game/Managers/ClassicUOInjectionApiBridge.cs; function GetSkillLockState.

Invoke reads existing data on the game thread and sends no network packets. It neither uses nor trains a skill. Two queries are separate snapshots.

Examples

Read and display

# Read and display
#
# Reads the local skill advancement mode.
#
# Integer: 0 — increase, 1 — decrease, 2 — locked. A mode code, not true/false. An unknown skill
# or absent player returns −1.

SUB Main()
    # The example explicitly sets selector and, for writes, mode. The first line selects a skill by
    # name or a stat by number. Print only displays the result.

    VAR selector = 'Mining'
    VAR mode = UO.GetSkillLockState(selector)
    UO.Print(CStr(mode))
END SUB

Parameter and execution notes:

• The example explicitly sets selector and, for writes, mode. The first line selects a skill by name or a stat by number. Print only displays the result.

Use in a condition or comparison

# Use in a condition or comparison
#
# Reads the local skill advancement mode.
#
# Integer: 0 — increase, 1 — decrease, 2 — locked. A mode code, not true/false. An unknown skill
# or absent player returns −1.

SUB Main()
    # The threshold 95.1 and modes 0/1/2 are example settings. Check −1 before changing a mode.
    # Reading after a write reads only the local copy, without waiting for server acknowledgement.

    VAR mode = UO.GetSkillLockState('Mining')
    IF mode = 2 THEN
        UO.Print("Locked")
    ELSE
        IF mode = -1 THEN
            UO.Print("Unknown selector")
        ELSE
            UO.Print("Mode: " + CStr(mode))
        END IF
    END IF
END SUB

Parameter and execution notes:

• The threshold 95.1 and modes 0/1/2 are example settings. Check −1 before changing a mode. Reading after a write reads only the local copy, without waiting for server acknowledgement.

Complete helper function

# Complete helper function
#
# Reads the local skill advancement mode.
#
# Integer: 0 — increase, 1 — decrease, 2 — locked. A mode code, not true/false. An unknown skill
# or absent player returns −1.

SUB Main()
    # The complete helper follows Main. selector chooses a skill/stat; mode sets the write mode.
    # ReadValue/ReadMode return the original number; ApplyMode checks arguments, performs the action
    # and returns no value. WAIT(1000) separates two reading snapshots.

    VAR before = ReadMode('Mining')
    WAIT(1000)
    VAR after = ReadMode('Mining')
    UO.Print(CStr(before) + " -> " + CStr(after))
END SUB

SUB ReadMode(selector)
    RETURN UO.GetSkillLockState(selector)
END SUB

Parameter and execution notes:

• The complete helper follows Main. selector chooses a skill/stat; mode sets the write mode. ReadValue/ReadMode return the original number; ApplyMode checks arguments, performs the action and returns no value. WAIT(1000) separates two reading snapshots.

Skills / Навыки

Skills / Навыки