Librocket API Document: Difference between revisions

Latest revision as of 18:30, 28 October 2026

This page has moved. SCPUI documentation now lives on the SCPUI GitHub wiki.
See the new version of this page. The old content is still available in this page's history.

@@ Line 1: / Line 1: @@
-{{Librocket_API}}
+{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/Librocket-API-Document}}
-Documents derive from elements, so inherit their interface. The document-specific interface is similar to the C++ interface; refer there for the full functional documentation.
-==Properties==
-{| border=1 cellpadding=4 style="border-collapse: collapse"
-|-
-| Lua property
-| Brief description
-| Equivalent C++ methods
-|-
-| context
-| Retrieves the document’s context.
-| GetContext()
-|-
-| title
-| Gets / sets the document’s title.
-| GetTitle(), SetTitle()
-|}
-==Methods==
-{| border=1 cellpadding=4 style="border-collapse: collapse"
-|-
-| Lua method
-| Brief description
-|-
-| CreateElement()
-| Creates an element by tag name.
-|-
-| CreateTextNode()
-| Creates a text element.
-|-
-| Close()
-| Closes the document and destroys all child elements.
-|-
-| Hide()
-| Hides the document.
-|-
-| PullToFront()
-| Pulls to the document to the front of others with a similar z-index.
-|-
-| PushToBack()
-| Pushes to the document behind others with a similar z-index.
-|-
-| Show(flags = FOCUS)
-| Shows the document, optionally with focus flags.
-|}
-The flags available for the Show() are referenced in Luaas:
-*NONE
-*FOCUS
-*MODAL