https://vrc-beta-docs.netlify.app/assets/js/d638eb08.dc3cd816.js

1"use strict";(self.webpackChunkVRChat_Creator_Docs=self.webpackChunkVRChat_Creator_Docs||[]).push([[4633],{84425:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>a,frontMatter:()=>d,metadata:()=>n,toc:()=>o});const n=JSON.parse('{"id":"worlds/components/textmeshpro/tmp_text","title":"TMP Text","description":"TMP_Text is the base class of two TextMesh Pro components:","source":"@site/docs/worlds/components/textmeshpro/tmp_text.md","sourceDirName":"worlds/components/textmeshpro","slug":"/worlds/components/textmeshpro/tmp_text","permalink":"/worlds/components/textmeshpro/tmp_text","draft":false,"unlisted":false,"editUrl":"https://github.com/vrchat-community/creator-docs/edit/main/Docs/docs/worlds/components/textmeshpro/tmp_text.md","tags":[],"version":"current","lastUpdatedAt":1716333687000,"frontMatter":{},"sidebar":"tutorialSidebar","previous":{"title":"TMP InputField","permalink":"/worlds/components/textmeshpro/tmp_inputfield"},"next":{"title":"VRC Avatar Pedestal","permalink":"/worlds/components/vrc_avatarpedestal"}}');var r=s(74848),i=s(28453);const d={},l="TMP Text",c={},o=[];function h(e){const t={a:"a",code:"code",h1:"h1",header:"header",li:"li",p:"p",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"tmp-text",children:"TMP Text"})}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"TMP_Text"})," is the base class of two TextMesh Pro components:"]}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.a,{href:"https://docs.unity3d.com/Packages/[email protected]/api/TMPro.TextMeshProUGUI.html",children:(0,r.jsx)(t.code,{children:"TextMeshProUGUI"})})," allows you to display text with a ",(0,r.jsx)(t.a,{href:"https://docs.unity3d.com/Packages/[email protected]/manual/UICanvas.html",children:"canvas renderer"}),".","\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"This component is an ideal replacement for the UI.Text component."}),"\n",(0,r.jsxs)(t.li,{children:['Change the "Render Mode" of your canvas depending on how you want to display your text.',"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:'"World Space" allows you to place text anywhere in your world.'}),"\n",(0,r.jsx)(t.li,{children:'"Screen Space" allows you to display text directly on the user\'s screen.'}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.a,{href:"https://docs.unity3d.com/Packages/[email protected]/api/TMPro.TextMeshPro.html",children:(0,r.jsx)(t.code,{children:"TextMeshPro"})})," allows you to display text with a ",(0,r.jsx)(t.a,{href:"https://docs.unity3d.com/Manual/class-MeshRenderer.html",children:"mesh renderer"}),".","\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"This component does not require a canvas. It's an ideal replacement for the legacy TextMesh components."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(t.h1,{id:"properties",children:"Properties"}),"\n",(0,r.jsxs)(t.p,{children:["Use the ",(0,r.jsx)(t.code,{children:"TMP_Text"})," base class to access these properties. Both ",(0,r.jsx)(t.code,{children:"TextMeshProUGUI"})," and ",(0,r.jsx)(t.code,{children:"TextMeshPro"})," inherit from ",(0,r.jsx)(t.code,{children:"TMP_Text"}),"."]}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Property"}),(0,r.jsx)(t.th,{children:"Type"}),(0,r.jsx)(t.th,{children:"Result"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"text"}),(0,r.jsx)(t.td,{children:"String"}),(0,r.jsx)(t.td,{children:"Accesses the text."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"isRightToLeftText"}),(0,r.jsx)(t.td,{children:"Bool"}),(0,r.jsx)(t.td,{children:"Gets/sets if the text needs to be displayed right to left. Useful when implementing a variety of languages."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"fontMaterial"}),(0,r.jsx)(t.td,{children:"Material"}),(0,r.jsx)(t.td,{children:"Gets/sets the font material. Take note that accessing this field will clone the material."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"fontSharedMaterial"}),(0,r.jsx)(t.td,{children:"Material"}),(0,r.jsx)(t.td,{children:"Gets/sets the shared font material. This returns null if this component's FontAsset is null."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"color"}),(0,r.jsx)(t.td,{children:"Color"}),(0,r.jsx)(t.td,{children:"Gets/sets the color of the text."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"alpha"}),(0,r.jsx)(t.td,{children:"Float"}),(0,r.jsx)(t.td,{children:"Gets/sets the opacity of the text."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"fontSize"}),(0,r.jsx)(t.td,{children:"Float"}),(0,r.jsx)(t.td,{children:"Gets/sets the size of the text."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"enableAutoSizing"}),(0,r.jsx)(t.td,{children:"Bool"}),(0,r.jsx)(t.td,{children:"Gets/sets if the text should try to 

1size itself as big as possible and still be visible within the range of FontSizeMin and FontSizeMax."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"fontSizeMin"}),(0,r.jsx)(t.td,{children:"Float"}),(0,r.jsx)(t.td,{children:"The minimum font size if AutoSizing is enabled."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"fontSizeMax"}),(0,r.jsx)(t.td,{children:"Float"}),(0,r.jsx)(t.td,{children:"The maximum font size if AutoSizing is enabled."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"horizontalAlignment"}),(0,r.jsx)(t.td,{children:"HorizontalAlignmentOptions"}),(0,r.jsx)(t.td,{children:"How the text will be aligned horizontally."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"verticalAlignment"}),(0,r.jsx)(t.td,{children:"VerticalAlignmentOptions"}),(0,r.jsx)(t.td,{children:"How the text will be aligned vertically."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"alignment"}),(0,r.jsx)(t.td,{children:"TextAlignmentOptions"}),(0,r.jsx)(t.td,{children:"How the text will be aligned overall."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"characterSpacing"}),(0,r.jsx)(t.td,{children:"Float"}),(0,r.jsx)(t.td,{children:"The amount of space between characters."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"wordSpacing"}),(0,r.jsx)(t.td,{children:"Float"}),(0,r.jsx)(t.td,{children:"The amount of space between words."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"lineSpacing"}),(0,r.jsx)(t.td,{children:"Float"}),(0,r.jsx)(t.td,{children:"The amount of vertical space between text lines."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"paragraphSpacing"}),(0,r.jsx)(t.td,{children:"Float"}),(0,r.jsx)(t.td,{children:"The amount of vertical space between paragraphs."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"characterWidthAdjustment"}),(0,r.jsx)(t.td,{children:"Float"}),(0,r.jsx)(t.td,{children:"The amount of overlap characters have."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"enableWordWrapping"}),(0,r.jsx)(t.td,{children:"Bool"}),(0,r.jsx)(t.td,{children:"Controls whether words that exceed the available space will be put on a new line."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"overflowMode"}),(0,r.jsx)(t.td,{children:"TextOverflowModes"}),(0,r.jsx)(t.td,{children:"Controls how the text will be treated if it overflows its available space."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"richText"}),(0,r.jsx)(t.td,{children:"Bool"}),(0,r.jsxs)(t.td,{children:["Gets/sets if ",(0,r.jsx)(t.a,{href:"https://docs.unity3d.com/Packages/[email protected]/manual/RichText.html",children:"Rich Text"})," is enabled."]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"parseCtrlCharacters"}),(0,r.jsx)(t.td,{children:"Bool"}),(0,r.jsxs)(t.td,{children:["Enables or Disables parsing of escape characters typed into input text fields, such as ",(0,r.jsx)(t.code,{children:"\\n"}),", ",(0,r.jsx)(t.code,{children:"\\r"}),", ",(0,r.jsx)(t.code,{children:"\\t"}),", or ",(0,r.jsx)(t.code,{children:"\\\\"}),"."]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"firstVisibleCharacter"}),(0,r.jsx)(t.td,{children:"Int"}),(0,r.jsx)(t.td,{children:"The first character that should be made visible in conjunction with the Text Overflow Linked mode."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"maxVisibleCharacters"}),(0,r.jsx)(t.td,{children:"Int"}),(0,r.jsx)(t.td,{children:"Controls how many characters are visible from the input."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"maxVisibleWords"}),(0,r.jsx)(t.td,{children:"Int"}),(0,r.jsx)(t.td,{children:"Controls how many words are visible from the input."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"maxVisibleLines"}),(0,r.jsx)(t.td,{children:"Int"}),(0,r.jsx)(t.td,{children:"Controls how many lines of text are displayed."})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:"enable"}),(0,r.jsx)(t.td,{children:"bool"}),(0,r.jsx)(t.td,{children:"Enables/disables the attached component."})]})]})]})]})}function a(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},28453:(e,t,s)=>{s.d(t,{R:()=>d,x:()=>l});var n=s(96540);const r={},i=n.createContext(r);function d(e){const t=n.useContext(i);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]);