UE C++基础 | UKismetTextLibrary 函数库解析

已于 2022-07-31 19:34:05 修改
阅读量1.2k 收藏 11
点赞数 1
分类专栏： 虚幻引擎 文章标签： c++
于 2022-07-31 17:59:34 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/ryacber/article/details/126086454
版权

文章目录

虚幻C++ UKismetTextLibrary 函数库解析

数据类型转换

  • 虚幻宏标记解析：
    1. BlueprintPure 此类函数为纯函数该函数不会以任何方式影响拥有的对象，并且可以在蓝图或关卡蓝图图中执行。
    2. meta= 元数据标签：
      1. (DisplayName=“”) 设置蓝图中显示的节点名称。
      2. (CompactNodeTitle = “->”) 设置成紧凑标题节点。
      3. (BlueprintAutocast) 在蓝图函数中的静态函数标记为BlueprintPure的前提下使用，将自动为函数的返回类型和第一个参数的类型添加一个强制转换节点。
    3. Category=“Utilities|String” 在蓝图中使用右键Search时会分类在Utilities的String下，|表示层级划分。
UFUNCTION(BlueprintPure, meta=(DisplayName = "", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
  • 目前提供以下虚幻基础类型转换：

在这里插入图片描述

originalnote
static FText Conv_VectorToText(FVector InVec);Vector To Text
static FText Conv_Vector2dToText(FVector2D InVec);Vector2d To Text
static FText Conv_RotatorToText(FRotator InRot);Rotator To Text
static FText Conv_TransformToText(const FTransform& InTrans);Transform To Text
static FText Conv_ObjectToText(class UObject* InObj);Object To Text
static FText Conv_ColorToText(FLinearColor InColor);Color To Text
static FString Conv_TextToString(const FText& InText);Text To String
static FText Conv_StringToText(const FString& InString);String To Text
static FText Conv_NameToText(FName InName);Name To Text
static FText Conv_BoolToText(bool InBool);Name To Text
static FText Conv_ByteToText(uint8 Value);Name To Text

数据类型转换（特殊）

======================================================================================================

To Text (Integer) | To Text (Integer64) (根据格式选项将传入转换为文本)

  • 参数：
    • Value - 待转换的值。
    • bAlwaysSign - 是否始终签名？
    • bUseGrouping - 是否使用分组。
    • MinimumIntegralDigits - 最小整数位数。
    • MaximumIntegralDigits - 最大整数位数。
UFUNCTION(BlueprintPure, meta=(DisplayName = "To Text (Integer)", AdvancedDisplay = "1", BlueprintAutocast), Category="Utilities|Text")
static FText Conv_IntToText(int32 Value, bool bAlwaysSign = false, bool bUseGrouping = true, int32 MinimumIntegralDigits = 1, int32 MaximumIntegralDigits = 324);

UFUNCTION(BlueprintPure, meta = (DisplayName = "To Text (Integer64)", AdvancedDisplay = "1", BlueprintAutocast), Category = "Utilities|Text")
static FText Conv_Int64ToText(int64 Value, bool bAlwaysSign = false, bool bUseGrouping = true, int32 MinimumIntegralDigits = 1, int32 MaximumIntegralDigits = 324);

在这里插入图片描述

To Text (Double) | To Text (Float) (根据格式选项将传入转换为文本)

  • 参数：
    • InDouble - 待转换的值。
    • Value - 待转换的值。
    • RoundingMode - 舍入模式。
    • bAlwaysSign - 是否始终签名？
    • bUseGrouping - 是否使用分组。
    • MinimumIntegralDigits - 最小整数位数。
    • MaximumIntegralDigits - 最大整数位数。
    • MinimumFractionalDigits - 最小分数位数。
    • MaximumFractionalDigits - 最大分数位数。
UFUNCTION(BlueprintPure, meta = (DisplayName = "To Text (Double)", AdvancedDisplay = "1", BlueprintAutocast), Category = "Utilities|Text")
static FText Conv_DoubleToText(double InDouble, TEnumAsByte<ERoundingMode> RoundingMode, bool bAlwaysSign = false, bool bUseGrouping = true, int32 MinimumIntegralDigits = 1, int32 MaximumIntegralDigits = 324, int32 MinimumFractionalDigits = 0, int32 MaximumFractionalDigits = 3);

UFUNCTION(BlueprintPure, meta=(DisplayName = "To Text (Float)", AdvancedDisplay = "1", BlueprintAutocast), Category="Utilities|Text")
static FText Conv_FloatToText(float Value, TEnumAsByte<ERoundingMode> RoundingMode, bool bAlwaysSign = false, bool bUseGrouping = true, int32 MinimumIntegralDigits = 1, int32 MaximumIntegralDigits = 324, int32 MinimumFractionalDigits = 0, int32 MaximumFractionalDigits = 3);

在这里插入图片描述

其它Text函数

======================================================================================================

Text Is Empty (如果文本为空，则返回 true)

  • 参数：
    • InText - 源文本。
UFUNCTION(BlueprintPure, Category="Utilities|Text")
static bool TextIsEmpty(const FText& InText);

在这里插入图片描述

======================================================================================================

Text Is Transient (如果文本是瞬态的，则返回 true)

  • 参数：
    • InText - 源文本。
UFUNCTION(BlueprintPure, Category="Utilities|Text")
static bool TextIsTransient(const FText& InText);

在这里插入图片描述

======================================================================================================

Text Is Culture Invariant (如果文本是文化不变的，则返回 true)

  • 参数：
    • InText - 源文本。
UFUNCTION(BlueprintPure, Category="Utilities|Text")
static bool TextIsCultureInvariant(const FText& InText);

在这里插入图片描述

======================================================================================================

Text To Lower | Text To Upper (以文化正确的方式将文本转换为大小写)

  • 参数：
    • InText - 源文本。
UFUNCTION(BlueprintPure, Category="Utilities|Text")
static FText TextToLower(const FText& InText);

UFUNCTION(BlueprintPure, Category="Utilities|Text")
static FText TextToUpper(const FText& InText);

在这里插入图片描述

======================================================================================================

Text Trim Preceding | Text Trim Trailing | Text Trim Preceding And Trailing (删除文本前面或尾部的空白字符)

  • 参数：
    • InText - 源文本。
UFUNCTION(BlueprintPure, Category="Utilities|Text")
static FText TextTrimPreceding(const FText& InText);

UFUNCTION(BlueprintPure, Category="Utilities|Text")
static FText TextTrimTrailing(const FText& InText);

UFUNCTION(BlueprintPure, Category="Utilities|Text")
static FText TextTrimPrecedingAndTrailing(const FText& InText);

在这里插入图片描述

======================================================================================================

Get Empty Text (返回一段空文本)

  • 参数：
    • 无
UFUNCTION(BlueprintPure, Category="Utilities|Text")
static FText GetEmptyText();

在这里插入图片描述

======================================================================================================

Find Text In Localization Table (尝试使用在指定命名空间和键的 loc 表中找到的表示来查找现有 Text。)

  • 参数：
    • Namespace - 命名空间
    • Key - 键
    • OutText - 输出文本
UFUNCTION(BlueprintPure, Category="Utilities|Text")
static bool FindTextInLocalizationTable(const FString& Namespace, const FString& Key, FText& OutText);

在这里插入图片描述

======================================================================================================

Equal | Not Equal (字面用法)

  • 参数：
    • A - 比较文本A
    • B - 比较文本B
UFUNCTION(BlueprintPure, meta=(DisplayName = "Equal Exactly (Text)", CompactNodeTitle = "==="), Category="Utilities|Text")
static bool EqualEqual_TextText(const FText& A, const FText& B);

UFUNCTION(BlueprintPure, meta=(DisplayName = "Equal, Case Insensitive (Text)", CompactNodeTitle = "=="), Category="Utilities|Text")
static bool EqualEqual_IgnoreCase_TextText(const FText& A, const FText& B);
			
UFUNCTION(BlueprintPure, meta=(DisplayName = "Not Equal Exactly (Text)", CompactNodeTitle = "!=="), Category="Utilities|Text")
static bool NotEqual_TextText(const FText& A, const FText& B);

UFUNCTION(BlueprintPure, meta=(DisplayName = "Not Equal, Case Insensitive (Text)", CompactNodeTitle = "!="), Category="Utilities|Text")
static bool NotEqual_IgnoreCase_TextText(const FText& A, const FText& B);

在这里插入图片描述

======================================================================================================

Format (文本格式化)

  • 参数：
    • InPattern - 格式化模式。
    • InArgs - 格式化数组数据。
UFUNCTION(BlueprintPure, meta=(BlueprintInternalUseOnly = "true"))
static FText Format(FText InPattern, TArray<FFormatArgumentData> InArgs);

在这里插入图片描述

数值格式转换

======================================================================================================

As Percent (将传入的浮点数转换为文本，格式为百分比)

  • 参数：
    • Value - 货币数量。
    • RoundingMode - 舍入模式。
    • bAlwaysSign - 是否始终签名？
    • bUseGrouping - 是否使用分组。
    • MinimumIntegralDigits - 最小整数位数。
    • MaximumIntegralDigits - 最大整数位数。
    • MinimumFractionalDigits - 最小分数位数。
    • MaximumFractionalDigits - 最大分数位数。
UFUNCTION(BlueprintPure, meta=(DisplayName = "As Percent", AdvancedDisplay = "1"), Category="Utilities|Text")
static FText AsPercent_Float(float Value, TEnumAsByte<ERoundingMode> RoundingMode, bool bAlwaysSign = false, bool bUseGrouping = true, int32 MinimumIntegralDigits = 1, int32 MaximumIntegralDigits = 324, int32 MinimumFractionalDigits = 0, int32 MaximumFractionalDigits = 3);

在这里插入图片描述

关于货币

======================================================================================================

As Currency (返回具体国家格式的货币值)

  • 参数：
    • BaseValue - 货币数量。
    • CurrencyCode - 国家货币名称缩写。
UFUNCTION(BlueprintPure, meta = (DisplayName = "As Currency"), Category = "Utilities|Text")
static FText AsCurrencyBase(int32 BaseValue, const FString& CurrencyCode);

在这里插入图片描述

AsCurrency (integer) - DEPRECATED (use AsCurrency) (已经弃用)

AsCurrency (float) - DEPRECATED (use AsCurrency) (已经弃用)

关于时间

======================================================================================================

As Date | As Date (from UTC) (将传入的日期和时间转换为日期的文本)

  • 使用不变时区格式化为日期，这将按原样使用给定的日期和时间，因此假定它已经在正确的时区。
  • 参数：
    • InDateTime - 传入的日期和时间。
UFUNCTION(BlueprintPure, meta=(DisplayName = "As Date", AdvancedDisplay = "1"), Category="Utilities|Text")
static FText AsDate_DateTime(const FDateTime& InDateTime);
  • 使用给定时区格式化为日期（默认为本地时区），这会将给定的日期和时间从 UTC 转换为给定的时区（考虑 DST）。
  • 参数：
    • InDateTime - 传入的日期和时间。
    • InTimeZone - 时区。
UFUNCTION(BlueprintPure, meta=(DisplayName = "As Date (from UTC)", AdvancedDisplay = "1"), Category="Utilities|Text")
static FText AsTimeZoneDate_DateTime(const FDateTime& InDateTime, const FString& InTimeZone = TEXT(""));

在这里插入图片描述

======================================================================================================

As DateTime | As DateTime (from UTC) (将传入的日期和时间转换为日期和时间的文本)

  • 使用不变时区格式化为日期和时间。 这将按原样使用给定的日期和时间，因此假定它已经在正确的时区。
  • 参数：
    • In - 传入的日期和时间。
UFUNCTION(BlueprintPure, meta=(DisplayName = "As DateTime", AdvancedDisplay = "1"), Category="Utilities|Text")
static FText AsDateTime_DateTime(const FDateTime& In);
  • 使用给定时区格式化为日期和时间（默认为本地时区），这会将给定的日期和时间从 UTC 转换为给定的时区（考虑 DST）。
  • 参数：
    • InDateTime - 传入的日期和时间。
    • InTimeZone - 时区。
UFUNCTION(BlueprintPure, meta=(DisplayName = "As DateTime (from UTC)", AdvancedDisplay = "1"), Category="Utilities|Text")
static FText AsTimeZoneDateTime_DateTime(const FDateTime& InDateTime, const FString& InTimeZone = TEXT(""));

在这里插入图片描述

======================================================================================================

As Time | As Time (from UTC) (将传入的日期和时间转换为时间的文本)

  • 使用不变时区格式化为时间，这将按原样使用给定的日期和时间，因此假定它已经在正确的时区。
  • 参数：
    • In - 传入的日期和时间。
UFUNCTION(BlueprintPure, meta=(DisplayName = "As Time", AdvancedDisplay = "1"), Category="Utilities|Text")
static FText AsTime_DateTime(const FDateTime& In);
  • 使用给定时区格式化为日期和时间（默认为本地时区），这会将给定的日期和时间从 UTC 转换为给定的时区（考虑 DST）。
  • 参数：
    • InDateTime - 传入的日期和时间。
    • InTimeZone - 时区。
UFUNCTION(BlueprintPure, meta=(DisplayName = "As Time (from UTC)", AdvancedDisplay = "1"), Category="Utilities|Text")
static FText AsTimeZoneTime_DateTime(const FDateTime& InDateTime, const FString& InTimeZone = TEXT(""));

在这里插入图片描述

======================================================================================================

As Timespan (将传入的时间跨度转换为文本，格式化为时间跨度)

  • 参数：
    • InTimespan - 传入时间跨度。
UFUNCTION(BlueprintPure, meta=(DisplayName = "As Timespan", AdvancedDisplay = "1"), Category="Utilities|Text")
static FText AsTimespan_Timespan(const FTimespan& InTimespan);

在这里插入图片描述

多语言

======================================================================================================

Is Text from String Table (如果给定文本引用字符串表，则返回 true)

  • 参数：
    • Text - 给定文本。
UFUNCTION(BlueprintPure, Category="Utilities|Text", meta=(DisplayName="Is Text from String Table"))
static bool TextIsFromStringTable(const FText& Text);

在这里插入图片描述

======================================================================================================

Make Text from String Table (Advanced) (尝试从字符串表 ID 和键创建文本实例)

  • 参数：
    • TableId - 字符串表ID。
    • Key - 键。
UFUNCTION(BlueprintPure, Category="Utilities|Text", meta=(DisplayName="Make Text from String Table (Advanced)"))
static FText TextFromStringTable(const FName TableId, const FString& Key);

在这里插入图片描述

======================================================================================================

Find String Table ID and Key from Text (尝试查找给定文本使用的字符串表 ID 和键)

  • 参数：
    • Text - 文本
    • OutTableId - 输出的字符串表ID。
    • OutKey - 输出的键。
UFUNCTION(BlueprintPure, Category="Utilities|Text", meta=(DisplayName="Find String Table ID and Key from Text"))
static bool StringTableIdAndKeyFromText(FText Text, FName& OutTableId, FString& OutKey);

在这里插入图片描述

======================================================================================================

Is Polyglot Data Valid (检查给定的多语言数据是否有效)

  • 参数：
    • Text - 文本
    • OutTableId - 输出的字符串表ID。
    • OutKey - 输出的键。
UFUNCTION(BlueprintPure, Category="Utilities|Text")
static void IsPolyglotDataValid(const FPolyglotTextData& PolyglotData, bool& IsValid, FText& ErrorMessage);

在这里插入图片描述

======================================================================================================

Polyglot Data To Text (获取从此多语言数据创建的文本实例。)

  • 参数：
    • PolyglotData - 多语言文本数据
UFUNCTION(BlueprintPure, Category="Utilities|Text")
static FText PolyglotDataToText(const FPolyglotTextData& PolyglotData);

在这里插入图片描述

======================================================================================================

Flame老唐
关注
  • 1
    点赞
  • 踩
  • 11
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
UE4 C++JSON读取示例.zip
09-03
在UE4（Unreal Engine 4）中，C++是一种常用的语言进行游戏开发，而JSON（JavaScript Object Notation）作为一种轻量级的数据交换格式，常用于存储和传输数据。本示例将详细介绍如何在UE4中使用C++来读取JSON文件。 ...
UE4的C++离线文档
01-04
该文档包含了UE4 C++ API的所有类、函数、宏、枚举等内容，并提供了详细的说明和示例代码。 文档内容 UE4 C++离线API文档的内容主要分为以下几部分： 类（Classes）：该部分包含了UE4 C++ API中所有类的信息，包括...
[玩转UE4/UE5动画系统＞C++篇＞C++基础] 之 C++版模板中那些琐碎而又应知应会的语法知识小结（本文献给刚学完谭浩强就来啃UEC++的同学）
开发游戏的老王
08-28 1552
本教程采用图文教程+视频教程的多元化形式，我会为不同的知识点选择适当的表达方式。教程内容将同步免费发布于开发游戏的老王（知乎|CSDN）的专栏《玩转UE4/UE5动画系统》。教程中使用的资源及工程将以开源项目的形式更新到GitHub：玩转UE4上。 工程文件： 玩转UE4(GitHub) 文章目录前言语法知识#pragma once是干嘛的？UCLASS()是干嘛的？GENERATED_BODY()是干嘛的？UPROPERTY是干嘛的？FORCEINLINE是干嘛的？类型前面的class关键字是干嘛.
UE5.3C++20新特性应用(一)
CatchTheDog的博客
02-29 1312
UE代码阅读
阿赵UE引擎C++编程学习笔记——C++自定义蓝图函数
最新发布
阿赵的博客
06-18 1134
使用UE引擎，大部分功能都可以使用蓝图的自带节点去完成。但有时候我们也需要扩展一些蓝图没有的功能。这一篇主要学习一下怎样用C++给蓝图新增自定义的函数节点。
虚幻蓝图BlueprintCallable与BlueprintPure区别
记录日常开发的小问题备忘
10-21 2288
在日常开发中，BlueprintCallable相信都很常用，但是BlueprintPure就不那么常用了，我也是在项目开发时，需要用C++封装单例对象供蓝图调用时，才用到BlueprintPure,下面简单看一下他们区别。注意：Pure函数一般声明成static ,如果不声明成static,使用函数节点时。以上是我们肉眼可见的区别，下面看一下肉眼不可见的区别。Promote to Variable不可用。Promote to Variable可用。
UE C++基础 | UKismetStringLibrary 函数库解析
ryacber的博客
07-26 1492
UKismetStringLibrary 函数库解析
UFUNCTION用法
丿咫尺天涯丨的博客
09-12 4213
基本功能：定义能够被UE识别的函数 参数扩展： UFUNCTION(BlueprintCallable,Category="Damage")：表明被修饰的函数能够被蓝图调用UFUNCTION(BlueprintImplementableEvent,Category="Damage")：允许在C++代码中调用在蓝图中实现的函数UFUNCTION(BlueprintNativeEvent,Ca
UE4的BlueprintPure用法
luomogenhaoqi的专栏
04-15 5790
/// This function fulfills a contract of producing no side effects, and additionally implies BlueprintCallable. BlueprintPure, BlueprintPure：感觉BlueprintPure修饰的函数和BlueprintCallable没太大...
UE4和C++ 开发-的UFUNCTION()是什么？
2201_75598244的博客
09-11 191
在事件形式重写中，使用UFUNCTION宏声明的成员函数可以被蓝图对象重写实现，这样可以在蓝图中直接处理该事件。例如，在蓝图中重写函数BlueprintImplementableEventTest()，可以在C++代码中声明该函数，并在蓝图中实现这个函数。在直接重写函数中，使用UFUNCTION宏声明的成员函数可以被蓝图对象直接重写。根据引用，UFUNCTION可以用于两种方式的重写：事件形式重写和直接重写函数。用于将成员函数暴露给蓝图对象，以便在蓝图中调用或重写该函数。
UE4蓝图调用C++函数的工程分享
03-11
总的来说，UE4中的蓝图调用C++函数是提升开发效率和游戏质量的有效手段。通过理解并熟练运用这两种调用方式，开发者可以更好地设计和实现游戏的各种功能，同时享受到UE4提供的强大工具集带来的优势。
UE4游戏编程蓝图c++语言教程
06-07
虚幻引擎4（UE4）提供了两种主要的编程方式，即C++和蓝图。C++是一种通用的文本编程语言，适合进行底层逻辑和性能敏感的代码编写，而蓝图则是一种图形化编程工具，更适合快速原型设计和游戏逻辑的可视化表达。 在UE...
UE4 C++教程 虚幻四C++教程
06-10
UE4 C++教程 虚幻四C++教程
UE4-常见的宏-UFUNCTION
wmy19890322的专栏
07-04 3629
基本功能：定义能够被UE识别的函数本文只对部分常用的修饰属性做用法说明，高端的后面接触到了再补充，大佬勿喷Unreal Engine version == 4.18.0 ； Virtual Studio 2017 update 15.4.2函数说明符 BlueprintAuthorityOnly 如果在具有网络权限的计算机（服务器，专用服务器或单人游戏）上运行，此功能只能从Blueprint代码执行,如无网络权限，则该函数将不会从蓝图代码中执行BlueprintCallable 该函数可以在蓝图或关卡蓝图图
UE4-（蓝图）第五十四课创建蓝图函数库
Stone的博客
11-28 3494
有时候我们需要自己创建全局函数库，该函数与具体蓝图类无关，逻辑不依赖于某一个具体的类都可以放到函数库中。 函数库中的函数之间是没有任何数据交流只是归为了一个类中（可以为纯虚函数），不像普通蓝图类中的函数是可以通过成员变量进行数据交流。 一、创建方法 文件夹空白处右键，选择Blueprints/BlueprintFunctionLibrary 创建函数库，并重命名。 二、创建函数实现生产...
UE4 C++ UFUNCTION说明
qq_34437757的博客
01-29 221
UE4 C++ UFUNCTION说明
【UE4 C++ 基础知识】＜2＞ UFUNCTION宏、函数说明符、元数据说明符
ttod的博客
11-06 663
【UE4 C++ 基础知识】 UFUNCTION宏、函数说明符、元数据说明符
UE4 ToText (float)
qq_42618180的博客
07-07 738
不勾选UseGrouping:打印:12345 勾选UseGrouping:打印:12,345
UEC++：UKismetMathLibrary::RandomPointInBoundingBox盒体内取随机坐标的方法
arbiter2的博客
11-05 726
学习笔记：UEC++_UKismetMathLibrary::RandomPointInBoundingBox盒体内取随机坐标的方法_盒体内取随机坐标的方法，空间内随机生成物体的时候可以用到
UE C++ 函数定义
08-10
引用123 #### 引用[.reference_title] - *1* [UE C++中获得蓝图函数返回值](https://blog.csdn.net/qq_43094860/article/details/126908215)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT3_1"}} ] [.reference_item] - *2* *3* [UE C++自定义事件](https://blog.csdn.net/m0_71515467/article/details/130545839)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT3_1"}} ] [.reference_item] [ .reference_list ]
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Flame老唐

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值