Documentation button

Any asset implementing the I_AssetDetails interface and overrides the GetDocumentationLinks will have a button appear next to the compile button that when pressed, will open that URL in the browser.

virtual TArray<FOmniDocumentationLinkAndText> GetDocumentationLinks_Implementation() const override
{
    return TArray<FOmniDocumentationLinkAndText>
    { 
        FOmniDocumentationLinkAndText("https://varian.gitbook.io/varian-docs/tagsmetadata")
    };
}

Providing more than 1 index will convert the button into a dropdown menu

virtual TArray<FOmniDocumentationLinkAndText> GetDocumentationLinks_Implementation() const override
{
    return TArray<FOmniDocumentationLinkAndText>
    { 
        FOmniDocumentationLinkAndText(
        "https://varian.gitbook.io/varian-docs/tagsmetadata",
        "Option1")
        FOmniDocumentationLinkAndText(
        "https://varian.gitbook.io/varian-docs/",
        "Option2")
    };
}

FOmniDocumentationLinkAndText has 2 parameters, a URL and a text. Remember to fill in the text when providing multiple links, as this text will be displayed to the user.

Last updated