itch.io

Hey!

Why do you want your text box to be automatically resizeable? I've had this question asked a few times before, and I just want to know what the end goal is so I can help properly!

Additionally, there's a few values to mess around with... outside of Unity UI, you can use the "auto wrap" and "vertical limit" values in the same way as the UI rect bounds. It's also worth looking at the different "Vertical Limit Mode" options, since "Show Last" and "auto pause" are useful when trying to have a lot of text in one place like a dialogue box. (Although I've got a bug with pauses not working as expected at the moment, so I've got to fix that ASAP!)

There are also best fit options, but apart from the "multiline" option, they are intended for text that's either just one line or has manual line breaks. (STM does its automatic linebreak insertion after the size of the text is determined, so that's why this works this way)

But yeah, please let me know the goal you're trying to achieve! When I think of "vertical space auto-resizing" I just think of a text box trying to fit so much text that it becomes unreadable, but there may something I'm misunderstanding... Like trying to resize text per-platform? Please let me know what this is for when you can!

Nah, that should be updated enough! I've got the 1.14.0 beta here and I'm seeing this broken-ness so... I'd like to fix that before release

Huh, well that's new.  I'll have to see what exactly I broke with this, because while I'm having trouble reproducing exactly this, some other stuff is cropping up, too...

Oh, that's a good idea... I *think* it would be possible, just a bit annoying to implement! (For users)

Essentially, I could add a toggle to control if the origin point of the draw animation is local to the character, or local to the mesh... the only problem with that would be actually getting the right number for the origin point to the mesh in the least painful way, so I'll have to think about how to implement this in the way that's least painful for users...

*Maybe* it could be... To make the text fly out of an arbitrary point, you'd find that point in local space to the text mesh object, then change the value on the data object itself before the read animation plays...?? I'll have to see if that's a good idea or not!

That's great you got your project working! 

And yeah, because of the limitation with Unity UI (and the fact I don't want to include all those emoji files in my asset... I'm not allowed to include any non-CC0 elements in my downloads, even if the license allows use for sale with credits) the emoji will have to remain as a separate add-on script for whoever wants it. I should probably link that in my documentation...

1. I know you said the issue is resolved, but that could be caused by either an older version of STM, or needing to refresh intellisense in your IDE. Since you're using Unity 5.5.5p2, it's probably that the asset store served you an older version of STM. They don't allow me to upload from Unity 5.3.4 anymore (I still develop in Unity 5.3.4 for maximum compatibility!), so you need to install a more recent version of Unity to get the asset, then move the files to your older project.

2. Honestly the way you're doing this is so baffling to me, and I would just use Unity's inspector to add the component since this is... Unity. Since you're adding a component through code and this is all very customized anyway, what you can do is edit STMEmoji to be a static class, and just subscribe your Super Text Mesh object directly to the "ReplaceEmoji" method, instead of replying on OnEnable and OnDisable to do the subscribing, which may or may not happen in the same frame, and are dependant on script execution order.

3. You didn't follow the steps at the start of the script properly... The folder containing your emoji files *needs* to be named "Resources" (This can be anywhere in your project) so that the Resources.Load() call that happens in the script is able to find them by name. You're welcome to try other methods for grabbing the files without using the Resources folder method, but I couldn't tell you what they are!

Yeah, when that extension is set up properly, you would using code like...

superTextMesh.text = "Look at my emoji! 🙂" and what it does is... I have a "preparse" event within SuperTextMesh that it uses, and this event is designed for methods you want to have modify the string after they've been sent to the text mesh, but before the text mesh actually evaluates the string. (This is also great for adding custom tags, check out the "links" example scene for some code with that)

So what it does is turns the above string into something more like "Look at my emoji! <q=emoji1234>" while dynamically creating a quad for the emoji at the same time, so the mesh can render it.

So this would work for you since you're going straight from code. You can just type emoji directly, send it directly to the text mesh, and have it be directly interpreted.

---

When you say "display them in nicknames and titles", do you mean you want to type the emoji more like :smiling: or <q=smiling>...? If that's the case, you can define whatever emoji you want your project to have either in the Text Data editor, or with your custom code you showed me which basically does the same thing to make STMQuadData objects with whatever name you want.

Then, if you don't want to type <q=smiling> and instead something like :smiling: or ":)", you can use the PreParsing event, just like the emoji one I sent to edit your script for you.

e.g. stringToBeSentToMesh = originalString.Replace(":)", "<q=smiling>");

...Like that, but more dynamic!

Oh, interesting... May I ask what "UTMJitterData" is? Your own variant on STMJitterData?

And as long as it works for you, that's good! I always keep my code exposed so people can customize it as they see fit. I suppose this way, if you're more used to editing code than using the inspector interface, you can just change values in here to edit your effects!

Emoji support unfortunately can't be included by default until Unity figures out how to render emoji in their inspector windows... but you're not using inspector windows, so this code may be useful to you: https://pastebin.com/qr9me3GA

Just follow the steps in the start of the file with how to organize your folders with the emoji textures, and this *should* work. The code is similar to what you're doing, where it will create a quad texture dynamically as an emoji is requested. You just add the script as a component to whatever object has SuperTextMesh to add this emoji functionality.

You can also just use quads directly to insert emoji or whatever other symbol without needing to convert it from an actual emoji character, first. (That might be good, because that awful, long regex string is all I could find in terms of detecting if a typed character is an actual emoji)

You may have to uncheck "remove emoji" which is under the "Beta" foldout in the SuperTextMesh inspector. This boolean is there because trying to use emoji directly with the inspector was causing so many problems, I just disabled it since STM can't render native emoji anyway.

Ah sorry, but by a personal policy, I only do support through emails or the forums. (Call me old-school, but my brain will split in two if I have to dig through discord channels for support cases...)

What do you mean you're trying to do everything through code? Creating new data objects, viewing which ones exist, or seeing why it's not animating...? I feel I'm not understanding the issue properly, so what exactly are you trying to do?

If you're trying to create data objects or see which ones exist, please use the Text Data inspector, or alternatively find the folders within "Assets > Clavian > SuperTextMesh > Resources" in your project to see all the data objects there. If you add/remove any data objects that way, please keep in mind you need to go into the Text Data inspector after to press the "Refresh Database" button anyway.

If you mean you're trying to create data as your project is running... someone has done that for quads before, which i will link here: https://itch.io/t/2579008/loading-quad-images-at-runtime ...But I just don't see the use for using this for effects like waves and jitters, since those go across multiple characters. You're more than welcome to try it, though!

Additionally, you can create scriptableObjects with code, save them to the appropriate folders (although personally I use Unity's AssetDatabase code for this, which will not run in a build, only in-editor!), and then call superTextMesh.data.RebuildDictionaries() to have them be usable by SuperTextMesh objects. (The quad example above bypasses this by writing the data object to a specific character as the text is reading)

In the top-right corner of any Super Text Mesh inspector window, click the [T] icon to open the Text Data Inspector, and in there you can see all of the included animations, and make new ones! I'm guessing you already know about this since you made your own color data, but it's worth mentioning, anyway.

As for why it's not animating, there's a chance that you may have encountered an import error, make sure to import all the default assets, and then in that Text Data Inspector window, click the "Refresh Database" button at the bottom.

In this window, also ensure that under the "master" foldout, that "disable animated text" is false. There's a variable for this on every Super Text Mesh object, too, under the "Timing" foldout.

Additionally, make sure your text has "ignore time scale" set to true, your game's timeScale value can effect animated text, too.

I find that some versions of Unity will show the mesh animating in edit mode, but does it work in play mode for you?

Ah oops, i'll update this to be a bit more clear! The message references a "Text Data Inspector" which I *think* I call the Text Data Editor more often, now. I'll get to updating the docs and warning message on this, I've really been meaning to review the docs!

The ideal way to make a font data file, or any other kind of data file, is with the Text Data Editor, btw! That's the menu that pops up when you click the [T] in the top-right of any Super Text Mesh component inspector

Ok, I'm giving this a shot in Unity 2022 and I still can't seem to replicate it... Is your text box using Unity UI or not? I did notice that resizing the rectTransform for UI text can cause a redraw if "rememberReadPosition" is unchecked, could anything be resizing that box for you as the camera moves...? 

Ok, reviewing this part of my code, and while I did attempt to compare masking values, I think I made a couple mistakes. 1. I'm comparing the ui stencil depth as a float instead of an int... 2. The "_Stencil" or "stencil ID" value I think would be a better comparison to make in this situation.

I think that change *should* fix this, but I'm also currently cleaning up the code in that area a little bit, right now. There could be something else I'm forgetting, too.

If you want to give a build with this change a shot, send me an email though my website!

I'll give this a look over the weekend!

I believe I'm in the middle of changing some code related to mask modes but something like *this* is really odd... It might have to do with how I'm caching materials...? I may not be checking if the mask value is the same with material caches (STM will have two objects share a material if the base material, font, and filter mode are the same), so that could cause this to trip up! Does the error still happen if the STM objects in hierarchy branch A are given a different font? This would basically confirm that this is the issue for me!

Oh good idea... It can't go directly after the <e> tag since sometimes you want multiple events to be called at once, but in this one instance... I'll have to think of how to account for it!

For passable parameters, I think I do this somewhere in the example but you can do <e=myEvent,variable> and then string.Split(",") 

Hello!

I'm going to be away for most of the month so I'll try to help while I can!

1) To get the last character printed, you can use the OnPrint event, and then use... hyphenedText[latestNumber] (I need to come up with a quick, better-named way for users to grab this value...) to get the last character printed.

Do you mean the custom event tag? (<e=myEvent>, <e2=myEvent> for repeating) There's a "links" sample scene that shows how to use these in an effective way with custom tags! Event tags are called as text reads out, so that sounds like what you're after.

Ok, I'll be able to give it a look, soon! I've been really busy with the holidays coming up, but I just want to let you know this is on my to-do list!

Thank you so much for sharing! I need to update the package properly but this will be great to have publicly for the time being. I'm glad it works!

Hello,

The Adventure Creator plugin was developed by a friend of mine if I'm remembering correctly, so I'm also unfamiliar with it! (And it hasn't been updated in a long time... I think!)

But going by that code, that should be correct for setting a baseline colour for a SuperTextMesh object... Are you able to edit the script attached to the "STM SubtitlesUI" prefab that you mentioned and add that code to it? Look for wherever that code is setting "superText.text", and you should put the line of code you shared on the line before that, so the colour is set before the text is set. My thinking is as follows: the script has to be getting the dialogue from somewhere, so that would be the right place to also grab and set the colour data.

I'll be able to take a look at the code myself later, (things have been really busy for me, sorry!) but this should be a pretty easy feature to be able to add yourself!

Ok, a few things to try:

1) On your Super Text Mesh component, set your Quality to 16, to match the pixel size of the font. (Quality is the font size that is rendered for dynamic fonts, so pixel fonts should usually be kept at their original size to render properly) This font probably has a *lot* of characters, so setting the quality so high *could* be a potential cause of the issue, if it's tripping up Unity's internal font texture tools.

2) On your font import settings, try changing "Character" from "Dynamic" to "Unicode". This will make the font be non-dynamic, so it *usually* eliminates the garbled text problem, with the caveat of the entire font being pre-rendered into a texture. I'll say that this *used* to be a concern back in 2018, but nowadays I think any platform shouldn't see any performance hits from this. (Pre-rendering the entire texture can take up more memory, but with a pixel font it's not really a problem in the first place, even with such a large character set)

3) Are you enabling/disabling the SuperTextMesh *component* at any point? Is it possible to enable/disable the gameObject instead?

4) Is that the only font you have named "Fusion Pixel"?

5) Additionally, and this is really silly, but since you're using a pixel font, *disabling* "pixel snap" may give you better rendering if your text object is grid-aligned in the first place. I'm just using Unity's pixel snap method, and honestly it's just not as good as lining up text yourself. I think it's meant moreso for non-pixel fonts. Unrelated to your issue, just saying this since I'm talking about pixel font rendering!

Please let me know if that has a difference for you. Basically, the garbled text bug is caused by when a dynamic font texture rebuilds, and the text mesh does not receive the "OnFontTextureRebuilt" callback. So... this could be caused by the Super Text Mesh component not being active, Unity's backend not sending the signal for whatever reason, or an error within my OnFontTextureRebuilt method within Super Text Mesh... but looking at it, I can't seem to see what the cause would be from that, unless the text object glitched out and isn't aware of the fonts it has within it.

Ok, in that case, what version of Unity are you using? And do you have the latest version of Super Text Mesh? Please try reimporting, I've seen situations where an update doesn't properly apply in the past.

What do the import settings for your font look like? And would it be possible to send a screenshot of the inspector for your Super Text Mesh component?

Is the pink text there the same mesh as the text on the right side of the screen?

This took a bit to figure out, and honestly I'm not too sure *why* this is working now and how it even was working before, but within the method "ApplyOffsetDataToTextInfo()", please update this part of the switch statement:

case Alignment.Justified:
    /* drawText[jL - (hyphenedText.Length - drawText.Length)] != '\n' */
    if(jL < hyphenedText.Length && hyphenedText[jL+1] != '\n'){ //not the very last row, or a row with a manual linebreak?
       info[j].pos.x += justifySpace * passedSpaces;
    }
    break;

That seems to do the job! I would send you a new build, but I have a few other unpublished changes in there, but I'll make sure this fix is in the next update when I upload it! Luckily, Japanese text is already justified since it has even spacing, so you can just use "Left" alignment and get the same result for the time being, anyway!

Thank you for finding this!!

If you go into the sample scene for "links", you can see some code there for how to convert existing tags to STM ones... (e.g. <link=myLink> becoming <e2=linkSpawnEvent> etc) That way, you can keep the system you have, and just convert it for the text renderer.

I think the "Auto Pause Full" feature would work well for what you're trying to do, but it's also possible to just manually take the leftoverText field, and send that to a new box when you continue, too... (I would advise this if the text gets *really* long! And look at the "pagination" scene for an example on doing this, too) STM is just a renderer, so you have a lot of control over how to integrate it into *your* system.

Hm I suppose that would be "superTextMesh.leftoverText.Length > 0" as an equivalent to that boolean, but also if you set the cut off mode to "Auto Pause" or "Auto Pause Full", Super Text Mesh has that built-in if I'm understanding what you want to do correctly. Just call superTextMesh.Continue() to have it keep reading past the pause. (This works with the <pause> tag, too!)

What do you mean by "built in test printing functionality" and the scripting system in your text? Are you using your own tagging system? STM should be compatible with a lot of stuff since it's programmed to be generic in use, so would it be possible to use that? You can use pre-parsing in STM to convert your own tags to things STM would recognize if you have an entire script written up for your game already! I may be able to point you in the right direction if that's the case!

1. Ah I meant, try manually calling Read() or Rebuild(true) when updating text in your code! Also I forgot to ask, is this happening only in editor, or does it still happen in a build? There's unique behaviour for changing the rectTransform in the editor that causes a rebuild... but it shouldn't happen when the game is playing, which would be the bug. I'll take a look at it soon!

2. Ok I'm glad the ultra shader works here! It's eventually going to replace the other shaders anyway, so I'll accept it as a fix.

1. Have you updated to the latest version? I changed some things related to the text mesh automatically redrawing when the RectTransform is changed in a recent version, so I'm wondering if this is a side-effect... does disabling "autoRead" (under the timing foldout) produce a differet result?

2. At first it looks like just how the Universal outline shader renders when the outline width is too far, (that shader only does an 8-pass outline) but the outline being thinner than the text on that shader is something I haven't seen... What version of Unity is this? Additionally, try out the "Ultra" shader, that's where I've been putting more work into prettier outlines, recently!

If you're creating text data objects through the text data editor, they will be recognized immediately by STM, but if you make them through unity's project window, you'll have to go into the text data editor (click the [T] in the top-right of any STM inspector window), and scroll to the bottom and click "Refresh Database". Please let me know if this solves your issue!

Right, Super Text Mesh has a custom material viewer for editing material properties right in the editor (The code for this is within STMCustomInspectorTools.cs) but that's not needed to edit the material properties, you can edit it as if it's a normal material! (By clicking on the created material in the project window, and editing the properties in Unity's inspector)

I'll take my own try at it and email you that, but it sounds like you've basically got it! For the record, I wasn't going to edit the inspector code to get this working, myself... If I'm happy enough with the implementation, I may add it as a standard feature to the Ultra shader, but I'll have to test for performance efficiency

Oh, I see what you mean now! When you said gradient, I thought you meant in the way that the rainbow text STM has by default shows a gradient over space, not a gradient over time. *That* should for sure be possible to mod into a custom STM shader without needing to mask anything. I should have asked to see a sample sooner, that is indeed a cool use-case for a gradient outline!

Are you familiar with modifying shader code? What I'm thinking is basically... Set it up so the _OutlineColor variable is either a gradient or two values representing the colours you want (e.g. _OutlineColor1 _OutlineColor2), and then you use _Time.y and some math (Or _SinTime.w! Or a custom pingpong function...) to lerp between these values within either the vert or frag functions of the shader, where the shader normally just grabs _OutlineColor. I could code this for you if you send over your invoice number via email, but I think it could be a good learning experience to try it yourself!

It's common in graphics design, but pretty rare for dialogue text in games! Have you seen the effect in another game? That might give me an idea on how it was implemented.

What is the effect going to be used for if you don't mind me asking? If it's something like short UI elements or decorative text, it'd be way more efficient to just render what you need in an art program and drag that into Unity... I can chase efficiency all I want, but I can't beat a .png when it comes down to it! (With raster-based text rendering, anyway!)

The only way I can think of doing it *now* (and didn't care too much about efficiency) is...

Set the outline colour to something to use for a chroma key (lets say green), and then have it so that text is on a layer that's only captured by a camera obeying that chroma key and replacing it with whatever you need.

Hello!

The outlines just support a single colour. It might be possible to modify the shader to add gradient support, but I'll say that it's a bit of a tall order with how outlines work in general! Really sorry about that. 

-Kai

Hello! I got your email and answered you there.

For anyone else on the forum finding this, I believe the solution is to press the [T] in the top-right of any Super Text Mesh component to open the text data editor, then to press the "Refresh Database" button at the bottom. This is an extra step needed when making Data objects outside of the text data editor.

Hey, going through my checklist, did I ever fix this? It looks like STM calls Rebuild with OnRectTransformDimensionsChange() instead of Update() and a manual check now, so is the event still being fired constantly? I could probably add another check to make sure STM *actually* needs to update at this point...?

emailed you the script!

Ok, i think I got it... this is how it looks with "break text" off, now.

Still playing with this, now I've got this result:

Break text off:

and break text on:

This seems to be a more desirable result for Japanese, but the first result should be respecting the bounding box size, and it's not. So I'm looking into why that's the case

Hey!

Just checking, is this a more desirable result?

I found that some logic was misbehaving involving the "insert hyphens" variable, where STM was giving different (and way too far) breakpoints when hyphen insertion was disabled. This is some of the oldest code in STM and is pretty english-oriented, so it was only a matter of time until some cases like this popped up. 

I also temporarily removed the japanese comma and period as being linebreak-friendly positions for the above result, as STM would overly favour them as linebreak positions. I'd still like it to be a "friendly" position, but only when it's near the edge of the text box. Going to keep working on that, but if this looks good, I can hack it into your version of SuperTextMesh.cs for you!

I'm still working on this, there's still a few text elements that can go over the box limits...

I'll give the code a look on a workday! Chances are, if it's something in *this* part of the code, we should be able to retrofit the solution into your project. I want to fix this asap...