基础 Pawn

所有 Pawn 实体（Character 和 CharacterSimple）的基类。

👪Base Class🧑‍💻API Source

👪Base Class

This is a Base Class, an abstract definition that shares common methods and events with it's child classes. You cannot spawn it, and you cannot call anything on the Base Class name itself. Use any class that inherits it.

Classes that share methods and events from this Base Class: Character, CharacterSimple.

---

🦠 函数

	Returns	Name	Description
		AddSkeletalMeshAttached	附加一个骨骼网格体作为该实体的骨骼主姿态
		AddStaticMeshAttached	附加一个静态网格体到此实体
		Follow	AI：使此 Pawn 跟随另一个 Actor
	table of string	GetAllSkeletalMeshAttached	获取附加到此实体的所有骨骼网格体
	table of string	GetAllStaticMeshAttached	获取附加到此实体的所有静态网格体
	boolean	GetCanCrouch	获取此 Pawn 是否允许下蹲
	boolean	GetCanJump	获取此 Pawn 是否允许跳跃
	table	GetCapsuleSize	获取胶囊体大小
	Rotator	GetControlRotation	获取控制旋转，即此 Pawn 看向或瞄准的方向
	boolean	GetFlyingMode	获取是否处于飞行模式
	float	GetGravityScale	获取重力缩放值
	integer	GetJumpZVelocity	获取跳跃时的初始垂直速度，决定跳跃高度
	SkeletalMesh Reference	GetMesh	获取基础网格体资产
	Vector	GetMovingTo	获取正在移动去往的位置
	Player or nil	GetPlayer	获取当前控制此实体的玩家
		HideBone	隐藏此 Pawn 的某个骨骼
	boolean	IsBoneHidden	获取某根骨骼是否被隐藏
		Jump	触发此 Pawn 跳跃
		MoveTo	AI：使此 Pawn 行走至指定位置
		RemoveAllSkeletalMeshesAttached	移除所有已附加的骨骼网格体
		RemoveAllStaticMeshesAttached	移除所有已附加的静态网格体
		RemoveSkeletalMeshAttached	根据自定义 ID 移除此实体上已存在的骨骼网格体
		RemoveStaticMeshAttached	根据自定义 ID 移除此实体上的 StaticMesh（如果存在）
		SetAIAvoidanceSettings	AI：配置 AI 移动时使用的 RVO（相互速度障碍物）避让系统
		SetBrakingSettings	设置此 Pawn 的移动制动设置
		SetCanCrouch	设置此 Pawn 是否允许下蹲
		SetCanJump	设置此 Pawn 是否允许跳跃
		SetCapsuleSize	设置此 Pawn 的胶囊体尺寸
		SetControlRotation	设置控制旋转，即此 Pawn 看向或瞄准的方向
		SetFlyingMode	启用或禁用飞行模式（消除重力并允许向所有方向移动）
		SetGravityScale	更改重力缩放值
		SetHitReactionEnabled	设置角色在受到伤害时是否触发受击反应，通过对受损的本地骨骼应用微小的动态布娃娃效果
		SetJumpZVelocity	设置跳跃的速度
		SetMeshSettings	配置网格体附加设置和可见性
		SetRagdollOnDeathEnabled	设置角色死亡时是否进入布娃娃模式。你可以将其设置为 false 以应用自定义死亡动画
		SetStaticMeshAttachedTransform	设置已附加静态网格体的位置和旋转
		StopAnimation	停止该角色上的动画蒙太奇
		StopMovement	AI：停止移动，可选将速度归零
		UnHideBone	取消隐藏此 Pawn 的某个骨骼

---

Slow

AddSkeletalMeshAttached

生成并附加一个骨骼网格体到此实体，该骨骼网格体必须使用与此 Actor 的网格相同的骨骼，并且将同步其所有动画。使用自定义 ID 以便随后进行移除/自定义设置

🆕Updated Function

This method was recently updated in ver. 1.144. See the Compatibility Versions page for more information.

my_pawn:AddSkeletalMeshAttached(id, skeletal_mesh_path, socket?, relative_location?, relative_rotation?, use_parent_bounds?, use_base_leader_pose_component?, animation_path?, attachable_id?)

Parameters

Type	Parameter	Default	Description
string	id	Required parameter	后续用于移除或在其上应用材质设置
SkeletalMesh Reference	skeletal_mesh_path	Required parameter	要附加的骨骼网格体资产路径
string	socket?		要附加到的骨骼插槽。传入空字符串以附加到根组件（即胶囊体）。传入 'root' 以附加到主骨骼网格体组件的根骨骼
Vector	relative_location?	Vector(0, 0, 0)	相对位置
Rotator	relative_rotation?	Rotator(0, 0, 0)	相对旋转
boolean	use_parent_bounds?	true	如果为 true，则该组件在附加时使用其父级的边界。当附加许多组件时，这可以带来显著的优化
boolean	use_base_leader_pose_component?	true	如果为 true，此组件将使用基础领头姿态组件来复制其动画
Animation Reference	animation_path?		要在附加的骨骼网格体上播放的动画资产路径
string	attachable_id?		可选，将此组件附加到另一个已附加的骨骼网格体上（而不是附加到根组件上）

See also RemoveSkeletalMeshAttached.

---

Slow

AddStaticMeshAttached

在插槽中以相对位置和旋转生成并附加一个静态网格体到此实体。使用自定义 ID 以便随后进行移除/自定义设置

my_pawn:AddStaticMeshAttached(id, static_mesh_path, socket?, relative_location?, relative_rotation?, use_parent_bounds?, attachable_id?)

Parameters

Type	Parameter	Default	Description
string	id	Required parameter	分配给该静态网格体的唯一 ID
StaticMesh Reference	static_mesh_path	Required parameter	要附加的静态网格体资产路径
string	socket?		要附加到的骨骼插槽
Vector	relative_location?	Vector(0, 0, 0)	相对位置
Rotator	relative_rotation?	Rotator(0, 0, 0)	相对旋转
boolean	use_parent_bounds?	true	如果为 true，则该组件在附加时使用其父级的边界。当附加许多组件时，这可以带来显著的优化
string	attachable_id?		可选，将此组件附加到另一个已附加的静态网格体上（而不是附加到根组件上）

See also SetStaticMeshAttachedTransform, RemoveStaticMeshAttached.

---

Optimal

Follow

AI：使此 Pawn 跟随另一个 Actor

触发事件 MoveComplete

my_pawn:Follow(actor, acceptance_radius?, stop_on_succeed?, stop_on_fail?, update_rate?)

Parameters

Type	Parameter	Default	Description
Base Actor	actor	Required parameter	要跟随的 Actor
float	acceptance_radius?	50	判定为成功的半径范围
boolean	stop_on_succeed?	false	到达目标时是否停止
boolean	stop_on_fail?	false	未能到达目标时是否停止
float	update_rate?	0.25	重新计算 AI 路径的频率

See also StopMovement, MoveTo, GetMovingTo, MoveComplete.

---

Moderate

GetAllSkeletalMeshAttached

获取附加到此实体的所有骨骼网格体

local ret = my_pawn:GetAllSkeletalMeshAttached()

Returns

Type	Description
table of string	键为附加 ID，值为资产路径的表

---

Moderate

GetAllStaticMeshAttached

获取附加到此实体的所有静态网格体

local ret = my_pawn:GetAllStaticMeshAttached()

Returns

Type	Description
table of string	键为附加 ID，值为资产路径的表

---

Optimal

GetCanCrouch

获取此 Pawn 是否允许下蹲

local can_crouch = my_pawn:GetCanCrouch()

Returns

Type	Description
boolean	此 Pawn 是否允许下蹲

See also SetCanCrouch.

---

Optimal

GetCanJump

获取此 Pawn 是否允许跳跃

local can_jump = my_pawn:GetCanJump()

Returns

Type	Description
boolean	此 Pawn 是否允许跳跃

See also SetCanJump.

---

Optimal

GetCapsuleSize

获取胶囊体大小

local capsule_sizes = my_pawn:GetCapsuleSize()

Returns

Type	Description
table	胶囊体尺寸 with this format

See also SetCapsuleSize.

---

Optimal

GetControlRotation

获取控制旋转，即此 Pawn 看向或瞄准的方向

local control_rotation = my_pawn:GetControlRotation()

Returns

Type	Description
Rotator	控制旋转

See also SetControlRotation.

---

Optimal

GetFlyingMode

获取是否处于飞行模式

local flying_mode = my_pawn:GetFlyingMode()

Returns

Type	Description
boolean	是否处于飞行模式

See also SetFlyingMode.

---

Optimal

GetGravityScale

获取重力缩放值

local gravity_scale = my_pawn:GetGravityScale()

Returns

Type	Description
float	重力缩放比例

See also SetGravityScale.

---

Optimal

GetJumpZVelocity

获取跳跃时的初始垂直速度，决定跳跃高度

local jump_z_velocity = my_pawn:GetJumpZVelocity()

Returns

Type	Description
integer	跳跃 Z 轴速度

See also SetJumpZVelocity.

---

Optimal

GetMesh

获取基础网格体资产

local skeletal_mesh_asset = my_pawn:GetMesh()

Returns

Type	Description
SkeletalMesh Reference	基础网格体资产

---

Optimal

GetMovingTo

获取正在移动去往的位置

local location = my_pawn:GetMovingTo()

Returns

Type	Description
Vector	正在移动去往的位置，如果未移动则返回 Vector(0, 0, 0)

---

Optimal

GetPlayer

获取当前控制此实体的玩家

local possesser = my_pawn:GetPlayer()

Returns

Type	Description
Player or nil	控制中的玩家

See also Possess, UnPossess.

---

Optimal

HideBone

隐藏此 Pawn 的某个骨骼。

请查阅 骨骼名称列表

my_pawn:HideBone(bone_name?)

Parameters

Type	Parameter	Default	Description
string	bone_name?		要隐藏的骨骼

See also UnHideBone, IsBoneHidden.

---

Optimal

IsBoneHidden

获取某根骨骼是否被隐藏

local is_hidden = my_pawn:IsBoneHidden(bone_name)

Parameters

Type	Parameter	Default	Description
string	bone_name	Required parameter	要检查的骨骼

Returns

Type	Description
boolean	骨骼是否被隐藏

See also UnHideBone, HideBone.

---

Optimal

Jump

触发此 Pawn 跳跃

my_pawn:Jump()

---

Optimal

MoveTo

AI：使此 Pawn 行走至指定位置

触发事件 MoveComplete

my_pawn:MoveTo(location, acceptance_radius?)

Parameters

Type	Parameter	Default	Description
Vector	location	Required parameter	目的地
float	acceptance_radius?	50	距离目的地多近会被判定为到达

See also StopMovement, Follow, GetMovingTo, MoveComplete.

---

Optimal

RemoveAllSkeletalMeshesAttached

移除所有已附加的骨骼网格体

my_pawn:RemoveAllSkeletalMeshesAttached()

---

Optimal

RemoveAllStaticMeshesAttached

移除所有已附加的静态网格体

my_pawn:RemoveAllStaticMeshesAttached()

---

Optimal

RemoveSkeletalMeshAttached

根据自定义 ID 移除此实体上已存在的骨骼网格体

my_pawn:RemoveSkeletalMeshAttached(id)

Parameters

Type	Parameter	Default	Description
string	id	Required parameter	要移除的骨骼网格体的唯一 ID

See also AddSkeletalMeshAttached.

---

Optimal

RemoveStaticMeshAttached

根据自定义 ID 移除此实体上的 StaticMesh（如果存在）

my_pawn:RemoveStaticMeshAttached(id)

Parameters

Type	Parameter	Default	Description
string	id	Required parameter	要移除的静态网格体的唯一 ID

See also AddStaticMeshAttached.

---

Optimal

SetAIAvoidanceSettings

AI：配置 AI 移动时使用的 RVO（相互速度障碍物）避让系统

my_pawn:SetAIAvoidanceSettings(enabled, avoidance_consideration_radius?)

Parameters

Type	Parameter	Default	Description
boolean	enabled	Required parameter	是否启用 RVO 避让
integer	avoidance_consideration_radius?	300	用于确定避让距离的圆半径

---

Optimal

SetBrakingSettings

设置此 Pawn 的移动制动设置

my_pawn:SetBrakingSettings(ground_friction?, braking_friction_factor?, braking_walking?, braking_flying?, braking_swimming?, braking_falling?)

Parameters

Type	Parameter	Default	Description
float	ground_friction?	2	在地面行走时施加的摩擦力
float	braking_friction_factor?	2	制动时施加摩擦力的系数
integer	braking_walking?	96	无输入行走时的减速度
integer	braking_flying?	3000	无输入飞行时的减速度
integer	braking_swimming?	10	无输入游泳时的减速度
integer	braking_falling?	0	无输入下落时的水平减速度

---

Optimal

SetCanCrouch

设置此 Pawn 是否允许下蹲

my_pawn:SetCanCrouch(can_crouch)

Parameters

Type	Parameter	Default	Description
boolean	can_crouch	Required parameter	此 Pawn 是否允许下蹲

See also GetCanCrouch.

---

Optimal

SetCanJump

设置此 Pawn 是否允许跳跃

my_pawn:SetCanJump(can_jump)

Parameters

Type	Parameter	Default	Description
boolean	can_jump	Required parameter	此 Pawn 是否允许跳跃

See also GetCanJump.

---

Optimal

SetCapsuleSize

设置此 Pawn 的胶囊体尺寸（将影响相机位置以及 Pawn 的碰撞）

🆕Updated Function

This method was recently updated in ver. 1.144. See the Compatibility Versions page for more information.

my_pawn:SetCapsuleSize(radius?, half_height?, crouched_half_height?)

Parameters

Type	Parameter	Default	Description
integer	radius?	0	传入 0 以根据网格体边界自动计算半径
integer	half_height?	0	传入 0 以根据网格体边界自动计算半高
integer	crouched_half_height?	0	传入 0 以根据网格体边界自动计算下蹲半高

See also GetCapsuleSize.

---

Optimal

SetControlRotation

设置控制旋转，即此 Pawn 看向或瞄准的方向

my_pawn:SetControlRotation(control_rotation)

Parameters

Type	Parameter	Default	Description
Rotator	control_rotation	Required parameter	新的控制旋转

See also GetControlRotation.

---

Optimal

SetFlyingMode

启用或禁用飞行模式（消除重力并允许向所有方向移动）

my_pawn:SetFlyingMode(flying_mode)

Parameters

Type	Parameter	Default	Description
boolean	flying_mode	Required parameter	是否启用飞行模式

See also GetFlyingMode.

---

Optimal

SetGravityScale

更改此 Pawn 的重力缩放比例（可为负数）

my_pawn:SetGravityScale(gravity_scale)

Parameters

Type	Parameter	Default	Description
float	gravity_scale	Required parameter	新的重力缩放比例

See also GetGravityScale.

---

Optimal

SetHitReactionEnabled

设置角色在受到伤害时是否触发受击反应，通过对受损的本地骨骼应用微小的动态布娃娃效果

my_pawn:SetHitReactionEnabled(is_enabled)

Parameters

Type	Parameter	Default	Description
boolean	is_enabled	Required parameter	角色受到伤害时是否会在受损的局部骨骼上应用微小的动态布娃娃效果作为受击反应

---

Moderate

SetJumpZVelocity

设置跳跃的速度

my_pawn:SetJumpZVelocity(jump_z_velocity)

Parameters

Type	Parameter	Default	Description
integer	jump_z_velocity	Required parameter	默认值为 420

See also GetJumpZVelocity.

---

Optimal

SetMeshSettings

配置网格体附加设置和可见性

my_pawn:SetMeshSettings(relative_location?, relative_rotation?, is_visible?)

Parameters

Type	Parameter	Default	Description
Vector	relative_location?	Vector(0, 0, 0)	网格体相对于胶囊体的位置
Rotator	relative_rotation?	Rotator(0, -90, 0)	网格体相对于胶囊体的旋转
boolean	is_visible?	true	网格体是否可见（在使用子网格体的重定向器时很有用）

---

Optimal

SetRagdollOnDeathEnabled

设置角色死亡时是否进入布娃娃模式。你可以将其设置为 false 以应用自定义死亡动画

my_pawn:SetRagdollOnDeathEnabled(is_enabled)

Parameters

Type	Parameter	Default	Description
boolean	is_enabled	Required parameter	角色死亡时是否进入布娃娃模式。可以设为 false 以应用自定义死亡动画

---

Moderate

SetStaticMeshAttachedTransform

设置已附加静态网格体的位置和旋转

my_pawn:SetStaticMeshAttachedTransform(id, relative_location, relative_rotation)

Parameters

Type	Parameter	Default	Description
string	id	Required parameter	通过 AddStaticMeshAttached 设置的静态网格体的唯一 ID
Vector	relative_location	Required parameter	新的相对位置
Rotator	relative_rotation	Required parameter	新的相对旋转

See also AddStaticMeshAttached.

---

Optimal

StopAnimation

停止该角色上的动画蒙太奇

my_pawn:StopAnimation(animation_asset)

Parameters

Type	Parameter	Default	Description
Animation Reference	animation_asset	Required parameter	要停止的动画资产

---

Optimal

StopMovement

AI：停止移动，可选将速度归零（非 AI 也会停止）

触发事件 MoveComplete

my_pawn:StopMovement(stops_velocity?)

Parameters

Type	Parameter	Default	Description
boolean	stops_velocity?	false	同时停止 Pawn 的当前速度

See also Follow, MoveTo, GetMovingTo, MoveComplete.

---

Optimal

UnHideBone

取消隐藏此 Pawn 的某个骨骼。

请查阅 骨骼名称列表

my_pawn:UnHideBone(bone_name)

Parameters

Type	Parameter	Default	Description
string	bone_name	Required parameter	要取消隐藏的骨骼

See also HideBone, IsBoneHidden.

🚀 事件

	Name	Description
	AnimationBeginNotify	当动画蒙太奇通知开始时
	AnimationEndNotify	当动画蒙太奇通知结束时
	MoveComplete	当 AI 到达目的地或失败时调用
	Possess	当此 Pawn 被玩家控制时触发
	UnPossess	当玩家解除对此 Pawn 的控制时触发

---

AnimationBeginNotify

当动画蒙太奇通知开始时

<AnyPawnClass>.Subscribe("AnimationBeginNotify", function(self, notify_name, animation_name, trigger_begin_time, trigger_end_time)
	-- AnimationBeginNotify was called
end)

Arguments

Type	Argument	Description
Base Pawn	self	触发该事件的 Pawn
string	notify_name	动画通知的名称
string	animation_name	触发该通知的动画蒙太奇名称
number	trigger_begin_time	通知开始时在动画中的时间（秒）
number	trigger_end_time	通知结束时在动画中的时间（秒）

---

AnimationEndNotify

当动画蒙太奇通知结束时

<AnyPawnClass>.Subscribe("AnimationEndNotify", function(self, notify_name, animation_name, trigger_begin_time, trigger_end_time)
	-- AnimationEndNotify was called
end)

Arguments

Type	Argument	Description
Base Pawn	self	触发该事件的 Pawn
string	notify_name	动画通知的名称
string	animation_name	触发该通知的动画蒙太奇名称
number	trigger_begin_time	通知开始时在动画中的时间（秒）
number	trigger_end_time	通知结束时在动画中的时间（秒）

---

MoveComplete

当 AI 到达目的地或失败时调用

<AnyPawnClass>.Subscribe("MoveComplete", function(self, succeeded)
	-- MoveComplete was called
end)

Arguments

Type	Argument	Description
Base Pawn	self	触发该事件的 Pawn
boolean	succeeded	是否已到达目的地

See also StopMovement, MoveTo, Follow, GetMovingTo.

---

Possess

当此 Pawn 被玩家控制时触发

<AnyPawnClass>.Subscribe("Possess", function(self, player)
	-- Possess was called
end)

Arguments

Type	Argument	Description
Base Pawn	self	触发该事件的 Pawn
Player	player	目标玩家

See also UnPossess, GetPlayer.

---

UnPossess

当玩家解除对此 Pawn 的控制时触发

<AnyPawnClass>.Subscribe("UnPossess", function(self, old_player)
	-- UnPossess was called
end)

Arguments

Type	Argument	Description
Base Pawn	self	触发该事件的 Pawn
Player	old_player	此前控制此 Pawn 的玩家

See also Possess, GetPlayer.