Cluster Creator Kit Script Reference
    Preparing search index...

    Type Alias TextInputOption

    Options for a text input request. Used in PlayerHandle.requestTextInput and PlayerScript.requestTextInput.

    type TextInputOption = {
        initialText?: string;
    }
    Index

    Properties

    Properties

    initialText?: string

    A text string to pre-fill the input field with. The player can edit and send this text string. If unset, the input field is displayed empty.

    The same restrictions as the text string the player can input apply. If the size exceeds 1000 bytes, or if the number of characters exceeds 250 (however, ASCII characters are counted as 0.5 characters each), an error occurs.

    In VR environments, text strings containing line breaks cannot be inputted. If the initial text contains line breaks, it may be edited and sent with the line breaks removed in VR environments.