Skip to content

Add C# version for examples of custom BBCode tags and text effects #9420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+71 −3
Open

Add C# version for examples of custom BBCode tags and text effects #9420

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 71 additions & 3 deletions tutorials/ui/bbcode_in_richtextlabel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -911,8 +911,9 @@ Here are some examples of custom effects:
Ghost
~~~~~

::

.. tabs::
.. code-tab:: gdscript GDScript

Copy link
Member

@AThousandShips AThousandShips May 29, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

No space, rather than deleting the line, GitHub doesn't allow that clearly

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't get it, you suggested to delete the line between the code-tab and the code itself?

@tool
extends RichTextEffect
class_name RichTextGhost
Expand All @@ -931,10 +932,35 @@ Ghost
char_fx.color.a = alpha
return true

.. code-tab:: csharp

Copy link
Member

@AThousandShips AThousandShips May 29, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

Same here

using Godot;

[Tool]
public class RichTextGhost : RichTextEffect
{
// Syntax: [ghost freq=5.0 span=10.0][/ghost]

// Define the tag name.
private string bbcode = "ghost";

public override bool _ProcessCustomFX(CharFXTransform charFX)
{
// Get parameters, or use the provided default value if missing.
var speed = (float)charFx.Env.GetValueOrDefault("freq", 5.0f);
var span = (float)charFx.Env.GetValueOrDefault("span", 10.0f);

var alpha = Mathf.Sin(charFX.ElapsedTime * speed + (charFX.Range.X / span)) * 0.5f + 0.5f;
charFX.Color.A = alpha;
return true;
}
}

Matrix
~~~~~~

::
.. tabs::
.. code-tab:: gdscript GDScript

@tool
extends RichTextEffect
Expand Down Expand Up @@ -970,6 +996,48 @@ Matrix
char_fx.glyph_index = get_text_server().font_get_glyph_index(char_fx.font, 1, value, 0)
return true

.. code-tab:: csharp

using Godot;

[Tool]
public class RichTextMatrix : RichTextEffect
{
// Syntax: [matrix clean=2.0 dirty=1.0 span=50][/matrix]

// Define the tag name.
private string bbcode = "matrix";

// Gets TextServer for retrieving font information.
private TextServer GetTextServer()
{
return TextServerManager.GetPrimaryInterface();
}

public override bool _ProcessCustomFX(CharFXTransform charFX)
{
// Get parameters, or use the provided default value if missing.
var clearTime = (float)charFx.Env.GetValueOrDefault("clean", 2.0f);
var dirtyTime = (float)charFx.Env.GetValueOrDefault("dirty", 1.0f);
var textSpan = (float)charFx.Env.GetValueOrDefault("span", 50);

var value = charFX.GlyphIndex;

var matrixTime = (charFX.ElapsedTime + (charFx.Range.X / textSpan)) % (clearTime + dirtyTime);

matrixTime = matrixTime < clearTime ? 0.0f : (matrixTime - clearTime) / dirtyTime;

if (matrixTime > 0.0f)
{
value = (int)(1 * matrixTime * (126 - 65));
value %= (126 - 65);
value += 65;
}
charFX.GlyphIndex = GetTextServer().FontGetGlyphIndex(charFX.Font, 1, value, 0);
return true;
}
}

This will add a few new BBCode commands, which can be used like so:

.. code-block:: none
Expand Down