/
Deprecated APIs

Deprecated APIs

Owned by Richard Wang
Last updated: Jun 13, 2025 by Lianne So

As part of enhancing developer experience and long-term maintainability, we have renamed and reorganized many of the IguanaX API functions. This update improves:

  • Readability – clearer names that reflect functionality

  • Comprehension – easier onboarding for new developers

  • Consistency – better namespacing (e.g., ui, component, net.tcpAsync, etc.)

Most deprecated APIs are specific to IguanaX. A small number exist in Iguana 6. If you're migrating from Iguana 6 to IguanaX, you may need to manually update those affected functions

How to Recognize and Update Deprecated APIs

When reviewing your Lua code:

  • Deprecated functions are shown with strikethrough formatting

image-20250612-154645.png

  • By Clicking on the Deprecated Function, you can view detailed documentation

image-20250612-154752.png

  • You can also list ALL deprecated apis using Help Doc → Show Deprecated checkbox

image-20250612-154844.png

Deprecated APIs Full List

✅ You can use the Search and Replace utility to update multiple APIs across a project.

Here is the Deprecated APIs list with its categories and whether the API exists in Iguana 6

Deprecated Function

Replacement Function

Category

Exists in Iguana6

Deprecated Function

Replacement Function

Category

Exists in Iguana6

component.call

iguana.callComponentFunction

Inter-Component Messaging & Queue Functions

❌ No

component.clone

component.spawnClone

Component Lifecycle & Execution Control

❌ No

component.retry

component.retryMessage

Component Lifecycle & Execution Control

❌ No

component.runAs

component.runAsUser

Component Lifecycle & Execution Control

❌ No

component.setBorder

ui.setBorderColor

UI

❌ No

component.setColumn

ui.setDashboardColumn

UI

❌ No

component.setLight

ui.setStatusLight

UI

❌ No

component.setStatus

ui.setStatusBar

UI

❌ No

component.setTooltip

ui.setDashboardTooltip

UI

❌ No

gcinfo

collectgarbage("count")

Environment & System Functions

❌ No

iguana.logMessage

iguana.logInfo

Logging and Debugging

❌ No

iguana.projectRoot

component.projectRoot

Environment & System Functions

✅ Yes

iguana.setColumn

ui.addDashboardColumn

UI

❌ No

iguana.setTimeout

component.setScriptTimeout

Component Lifecycle & Execution Control

❌ No

iguana.stopOnError

component.setStopOnError

Component Lifecycle & Execution Control

✅ Yes

iguana.translatorGuid

component.id

Component Info & Metadata

❌ No

net.smtp.send

net.smtp.sendEmail

Network Communication

✅ Yes

net.tcp.recv

net.tcp.receive

Network Communication

✅ Yes

os.whichOs

os.platform

Note: output changed to ‘macos’, ‘windows’, or ‘linux’

Environment & System Functions

❌ No

socket.close_a

net.tcpAsync.close

Network Communication

❌ No

socket.connect_a

net.tcpAsync.connect

Network Communication

❌ No

socket.listen_a

net.tcpAsync.listen

Network Communication

❌ No

socket.onAccept

net.tcpAsync.listen

Network Communication

❌ No

socket.onClose

net.tcpAsync:setOnSocketClosed

Network Communication

❌ No

socket.onConnect

net.tcpAsync.connect

Network Communication

❌ No

socket.onData

net.tcpAsync:setOnDataReceived

Network Communication

❌ No

socket.onWrite

net.tcpAsync:setOnSendComplete

Network Communication

❌ No

socket.send_a

net.tcpAsync.send

Network Communication

❌ No

table.foreach

pairs

General Utilities

✅ Deprecated

table.foreachi

ipairs

General Utilities

✅ Deprecated

table.getn

Use the # operator

General Utilities

✅ Deprecated

table.setn

N/A throw an error

General Utilities

✅ Deprecated

test.search

util.findPattern

General Utilities

❌ No

unwind_protect

util.safeCall

General Utilities

❌ No

util.guid

util.generateGUID

General Utilities

✅ Yes

Considerations

IguanaX Version for Deprecated APIs

Deprecated APIs Support

Deprecated APIs will continue to function in current IguanaX versions. However:

  • They are no longer supported for bug fixes or enhancements

  • Future releases may remove them entirely

  • We strongly recommend updating deprecated API usage after upgrading