nuke.localization

APIs for Nuke’s localization functionality.

Use help(‘_localization’) to get detailed help on the classes exposed here.

This module provides the public interface to the localization module and will remain stable. It uses an underlying native module called _localization to provide this interface. While there is nothing stopping you from using the _localization module directly, it may change in a future release and break backwards compatibility.

Functions

addFileCallback

param callback:

is a python callable object with arguments for path and event. See nuke.localization.FileEvent for possible file events.

addReadCallback

Adds a callback for read localization events.

checkForUpdates

Trigger a manual file check, which checks and updates the states of localised files.

clearUnusedFiles

Clears unused files in the localization folder.

findNodes

Returns the list of read nodes that read from the argument paths.

forceUpdateAll

Update all localized files currently in use in Nuke.

forceUpdateOnDemand

forceUpdateAll() -> None

forceUpdateSelectedNodes

Update all localized files used by nodes that are currently selected.

isLocalizationPaused

return:

whether localization was paused

localizationProgress

gets the percentage of localization completed.

localizedPaths

gets paths of files which are currently localized.

mode

:return string 'on', 'off' or 'manual'

pauseLocalization

Pause the localization background thread if it was running.

removeFileCallback

Removes a callback for file localization events.

removeReadCallback

Removes a callback for read localization events

resumeLocalization

Resume the localization background thread if it was paused

setMode

sets the localization system mode.

Classes

FileEvent

Events received in file callbacks

ReadStatus

Localization status recieved by Read callbacks