API:LabelGetWordWrap

UI Lua API · Label functions
Version: WAR 1.4.8

Returns whether word wrapping is turned on for a Label.

wordWrap = LabelGetWordWrap(labelName)

Arguments

labelName

string – Name of a Label window.

Returns

wordWrap

boolean – true if word wrapping is on.

Details

• Reports the flag set by LabelSetWordWrap.
• The stock UI never calls LabelGetWordWrap.

Errors

• Error in function call 'LabelGetWordWrap': Window %s does not exist
• Error in function call 'LabelGetWordWrap': Window %s is not a Label

Example

A minimal example built from the signature above:

if( not LabelGetWordWrap( "MyLabel" ) ) then
    LabelSetWordWrap( "MyLabel", true )
end

See also

• LabelSetWordWrap