Font:getWrap

Available since LÖVE 0.7.0
This function is not supported in earlier versions.

Gets formatting information for text, given a wrap limit.

This function accounts for newlines correctly (i.e. '\n').

Function

Available since LÖVE 0.10.0
This variant is not supported in earlier versions.

Synopsis

width, wrappedtext = Font:getWrap( text, wraplimit )

Arguments

string text

The text that will be wrapped.

number wraplimit

The maximum width in pixels of each line that text is allowed before wrapping.

Returns

number width

The maximum width of the wrapped text.

table wrappedtext

A sequence containing each line of text that was wrapped.

Function

Removed in LÖVE 0.10.0
This variant is not supported in that and later versions.

Synopsis

width, lines = Font:getWrap( text, wraplimit )

Arguments

string text

The text that would be wrapped.

number wraplimit

The maximum width in pixels of each line that text is allowed before wrapping.

Returns

number width

The maximum width of the wrapped text.

number lines

The number of lines that the wrapped text will have.

See Also

• Font
• love.graphics.printf
• Text:setf