版本：bleeding-edge 🩸

🧑 角色

角色代表可以被附身、移动并与世界互动的 Actor。它们是为 nanos world 构建的默认骨骼网格体角色。

Server Only🔁Auto-Distributed🧑‍💻API Source

👪Inheritance

This class shares methods and events from Base Entity, Base Actor, Base Paintable, Base Damageable, Base Pawn.

Characters are Skeletal Meshes using Unreal's Mannequin Skeletal, with animations and interactivity already natively integrated into nanos world. It is possible to import any Skeletal Mesh (which uses Unreal's Mannequin Skeletal) to this Character.

🎒 示例

Server/Index.lua
-- The following examples are using all Skeletal Meshes which we currently have for examples, including the officials Woman, Man and Mannequin:
local woman = Character(Vector(100, 0, 100), Rotator(0, 0, 0), "nanos-world::SK_Female")
local man = Character(Vector(200, 0, 100), Rotator(0, 0, 0), "nanos-world::SK_Male")
local mannequin = Character(Vector(300, 0, 100), Rotator(0, 0, 0), "nanos-world::SK_Mannequin")
local mannequin_female = Character(Vector(400, 0, 100), Rotator(0, 0, 0), "nanos-world::SK_Mannequin_Female")

local post_apocalyptic = Character(Vector(400, 0, 100), Rotator(0, 0, 0), "nanos-world::SK_PostApocalyptic")
local classic_male = Character(Vector(500, 0, 100), Rotator(0, 0, 0), "nanos-world::SK_ClassicMale")

-- Adds Clothes to Man. Note: some Meshes only supports a specific Mesh (Men/Woman)
man:AddSkeletalMeshAttached("shirt", "nanos-world::SK_Shirt") -- Men only
man:AddSkeletalMeshAttached("shirt", "nanos-world::SK_Underwear") -- Men only
man:AddSkeletalMeshAttached("pants", "nanos-world::SK_Pants") -- Men only
man:AddSkeletalMeshAttached("shoes", "nanos-world::SK_Shoes_01")
man:AddSkeletalMeshAttached("tie", "nanos-world::SK_Tie")

-- Adds Clothes to Woman
woman:AddSkeletalMeshAttached("full", "nanos-world::SK_CasualSet") -- Woman only
woman:AddSkeletalMeshAttached("shoes", "nanos-world::SK_Sneakers")

-- Adds Beard to Man
man:AddStaticMeshAttached("beard", "nanos-world::SM_Beard_Extra", "beard")
man:AddStaticMeshAttached("beard", "nanos-world::SM_Beard_Middle", "beard")
man:AddStaticMeshAttached("beard", "nanos-world::SM_Beard_Mustache_01", "beard")
man:AddStaticMeshAttached("beard", "nanos-world::SM_Beard_Mustache_02", "beard")
man:AddStaticMeshAttached("beard", "nanos-world::SM_Beard_Side", "beard")

-- Adds Hair to Man
man:AddStaticMeshAttached("hair", "nanos-world::SM_Hair_Long", "hair_male")
man:AddStaticMeshAttached("hair", "nanos-world::SM_Hair_Short", "hair_male")

-- Adds Hair to Woman
woman:AddStaticMeshAttached("hair", "nanos-world::SM_Hair_Kwang", "hair_female")

🛠 构造函数

Default Constructor

No description provided

local my_character = Character(location, rotation, skeletal_mesh_asset, collision_type?, gravity_enabled?, max_health?, death_sound?, pain_sound?, spawn_mode?)

Parameters

Type	Name	Default	Description
Vector	`location`	Required parameter	No description provided
Rotator	`rotation`	Required parameter	No description provided
SkeletalMesh Reference	`skeletal_mesh_asset`	Required parameter	No description provided
CollisionType	`collision_type`	`CollisionType.Auto`	No description provided
boolean	`gravity_enabled`	`true`	No description provided
integer	`max_health`	`100`	当前 / 最大生命值
Sound Reference	`death_sound`	`nanos-world::A_Male_01_Death`	角色死亡时播放
Sound Reference	`pain_sound`	`nanos-world::A_Male_01_Pain`	角色受到伤害时播放
SpawnMode	`spawn_mode`	`SpawnMode.Immediate`	传入 `SpawnMode.AfterConstructor` 或 `SpawnMode.Manual` 可避免立即将实体发送至客户端，在需要配置多项设置时使用此选项可提升性能。最后必须调用 `FinishSpawn()`

🗿 静态函数

Inherited Entity Static Functions

Character inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/entity

Returns	Name	Description
table of Base Entity	`GetAll`	返回一个包含调用此方法的类中所有实体的表
Base Entity	`GetByIndex`	返回该类中指定索引处的特定实体
integer	`GetCount`	返回该类当前存在的实体数量
table of table	`GetInheritedClasses`	获取使用继承系统创建的、直接继承自该类的所有子类列表
iterator	`GetPairs`	返回一个包含该类所有实体的迭代器，用于 `pairs()` 循环
table or nil	`GetParentClass`	如果该类是使用继承系统创建的，则获取其父类
table	`Inherit`	使用继承系统继承此类
boolean	`IsChildOf`	如果该类是使用继承系统创建的，检查此类是否为另一个类的子类
function	`Subscribe`	为该类的所有实体订阅一个事件
function	`SubscribeRemote`	订阅从服务器调用的自定义远程事件
	`Unsubscribe`	退订此包内该类中此事件的所有回调，或者仅取消传入的特定回调

This class doesn't have own static functions.

🦠 函数

Inherited Entity Functions

Character inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/entity

Returns	Name	Description
	`BroadcastRemoteEvent`	直接在此实体上向所有玩家调用自定义远程事件
	`BroadcastRemoteInRadiusEvent`	直接针对此实体调用自定义远程事件，并将该事件传递给半径范围内的所有玩家
	`CallRemoteEvent`	直接在此实体上向特定玩家调用自定义远程事件
	`CallRemoteEvent`	直接在此实体上调用自定义远程事件
	`CallRemotePlayersEvent`	直接在此实体上调用自定义远程事件，并将事件传递给玩家列表
	`Destroy`	销毁该实体
	`FinishSpawn`	如果此实体是以延迟 `spawn_mode` 生成的，则完成生成过程并将该实体发送至客户端
table of string	`GetAllValuesKeys`	获取所有值键的列表
table	`GetClass`	获取该实体的类
integer	`GetID`	获取该实体的全网通用网络 ID（在客户端和服务器上相同）
any	`GetValue`	获取此实体上存储在给定键处的值
boolean	`HasAuthority`	获取本地上下文是否对此实体拥有主控（如果由客户端生成则为 true，由服务器生成则为 false）
boolean	`IsA`	递归检查此实体是否继承自某个类
boolean	`IsBeingDestroyed`	如果该实体正在被销毁，则返回 true
boolean	`IsSpawned`	获取此实体是否已完成生成
boolean	`IsValid`	如果该实体有效（即未被销毁且指向一个有效的实体），则返回 true
	`SetSpawnMode`	从继承类的构造函数中覆盖此实体完成生成的时间点
	`SetValue`	在此实体中设置一个值
function	`Subscribe`	在这个特定实体上订阅一个事件
function	`SubscribeRemote`	在这个特定实体上订阅一个从服务器调用的自定义远程事件
	`Unsubscribe`	退订此包内该实体中此事件的所有回调，或者仅取消传入的特定回调

Inherited Actor Functions

Character inherits from Base Actor Class, sharing it's methods and functions:
Base Actorscripting-reference/classes/base-classes/actor

Returns	Name	Description
	`AddActorTag`	向该 Actor 添加一个虚幻 Actor 标签
	`AddAngularImpulse`	向该 Actor 添加角冲量。适用于单次瞬间爆发
	`AddImpulse`	向该 Actor 添加冲量。适用于单次瞬间爆发
boolean	`AttachTo`	将该 Actor 附加到任何其他 Actor 上，可选择附加在特定骨骼处
	`Detach`	将该 Actor 从其附加的 Actor 上分离
table of string	`GetActorTags`	获取该 Actor 上的所有虚幻 Actor 标签
Vector	`GetAngularForce`	获取该 Actor 的角外力（由 `SetAngularForce()` 设置）
float	`GetAngularVelocity`	返回此 Actor 的角速度
table of Base Actor	`GetAttachedEntities`	获取附加到该 Actor 的所有 Actor
Base Actor or nil	`GetAttachedTo`	获取该 Actor 所附加到的父级 Actor
table	`GetBounds`	获取该 Actor 的边界范围
CollisionType	`GetCollision`	获取该 Actor 的碰撞类型
integer	`GetDimension`	获取该 Actor 的维度
float	`GetDistanceFromCamera`	获取该 Actor 距离相机的距离
Vector	`GetForce`	获取该 Actor 的持续外力（由 `SetForce()` 设置）
Vector	`GetLocation`	获取该 Actor 在游戏世界中的位置
float	`GetMass`	返回此 Actor 的质量
Player or nil	`GetNetworkAuthority`	获取该 Actor 的网络主控玩家
Vector	`GetRelativeLocation`	如果该 Actor 已附加，获取其相对位置
Rotator	`GetRelativeRotation`	如果该 Actor 已附加，获取其相对旋转
Rotator	`GetRotation`	获取该 Actor 在游戏世界中的角度值
Vector	`GetScale`	获取该 Actor 的缩放比例
float	`GetScreenPercentage`	获取该 Actor 在屏幕中所占尺寸的百分比
table	`GetSocketTransform`	在给定骨骼或插槽名称的情况下，获取世界空间中的插槽变换
Vector	`GetVelocity`	获取该 Actor 当前的速度
boolean	`HasNetworkAuthority`	如果本地玩家当前是该 Actor 的网络主控（Network Authority），则返回 true
boolean	`IsGravityEnabled`	如果该 Actor 启用了重力，则返回 true
boolean	`IsInWater`	如果该 Actor 处于水中，则返回 true
boolean	`IsNetworkDistributed`	如果该 Actor 当前处于网络分配状态，则返回 true
boolean	`IsVisible`	如果该 Actor 可见，则返回 true
	`RemoveActorTag`	从该 Actor 中移除一个虚幻 Actor 标签
	`RotateTo`	在一定时间内平滑旋转该 Actor 到指定角度
	`SetAngularForce`	向该 Actor 添加一个永久的角外力，设为 Vector(0, 0, 0) 可以取消
	`SetCastShadow`	设置该 Actor 是否投射阴影
	`SetCollision`	设置该 Actor 的碰撞类型
	`SetDimension`	设置该 Actor 的维度
	`SetDistanceOptimizationMultiplier`	设置此 Actor 的距离优化系数
	`SetForce`	向该 Actor 添加一个永久的外力，设为 Vector(0, 0, 0) 可以取消
	`SetGravityEnabled`	设置该 Actor 是否启用重力
	`SetHighlightEnabled`	设置该 Actor 是否启用高亮显示，以及使用哪个高亮索引值
	`SetLifeSpan`	设置该 Actor 被销毁前的生存时间（秒）。经过这段时间后，Actor 将被自动销毁。
	`SetLocation`	设置该 Actor 在游戏世界中的位置
	`SetNetworkAuthority`	设置某个玩家拥有此 Actor 的网络主控
	`SetNetworkAuthorityAutoDistributed`	设置该 Actor 是否在玩家之间自动分配网络主控
	`SetOutlineEnabled`	设置该 Actor 是否启用描边，以及使用哪个描边索引值
	`SetRelativeLocation`	在本地空间中设置该 Actor 的相对位置（仅在此 Actor 已附加时生效）
	`SetRelativeRotation`	在本地空间中设置该 Actor 的相对旋转（仅在此 Actor 已附加时生效）
	`SetRenderCullDistance`	设置该 Actor 的渲染剔除距离
	`SetRotation`	设置该 Actor 在游戏世界中的旋转
	`SetScale`	设置该 Actor 的缩放比例
	`SetVisibility`	设置该 Actor 是否可见
	`TranslateTo`	在一定时间内平滑地将该 Actor 移动到某个位置
boolean	`WasRecentlyRendered`	获取该 Actor 最近是否在屏幕上被渲染过

Inherited Paintable Functions

Character inherits from Base Paintable Class, sharing it's methods and functions:
Base Paintablescripting-reference/classes/base-classes/paintable

Returns	Name	Description
Color	`GetMaterialColorParameter`	从该 Actor 的材质中获取 Color 参数
float	`GetMaterialScalarParameter`	从该 Actor 的材质中获取 Scalar 参数
string	`GetMaterialTextureParameter`	从该 Actor 的材质中获取 Texture 参数
Vector	`GetMaterialVectorParameter`	从该 Actor 的材质中获取 Vector 参数
	`ResetMaterial`	将指定索引处的材质重置为原始材质
	`SetMaterial`	设置该 Actor 指定索引处的材质
	`SetMaterialColorParameter`	设置该 Actor 材质中的 Color 参数
	`SetMaterialFromCanvas`	将该 Actor 指定索引处的材质设为 Canvas 对象
	`SetMaterialFromSceneCapture`	将该 Actor 指定索引处的材质设为 SceneCapture 对象
	`SetMaterialFromWebUI`	将该 Actor 指定索引处的材质设为 WebUI 对象
	`SetMaterialScalarParameter`	设置该 Actor 材质中的 Scalar 参数
	`SetMaterialTextureParameter`	将该 Actor 材质中的纹理参数设为一张图像
	`SetMaterialVectorParameter`	设置该 Actor 材质中的 Vector 参数
	`SetPhysicalMaterial`	使用新的物理材质覆盖该 Actor 的物理材质

Inherited Damageable Functions

Character inherits from Base Damageable Class, sharing it's methods and functions:
Base Damageablescripting-reference/classes/base-classes/damageable

Returns	Name	Description
integer	`ApplyDamage`	对该实体造成伤害
float	`GetDamageMultiplier`	获取特定骨骼的伤害系数
integer	`GetHealth`	获取当前生命值
integer	`GetMaxHealth`	获取最大生命值
boolean	`IsDead`	返回该实体是否已死亡
	`Respawn`	重生该实体，恢复其生命值并将其移动到初始位置
	`SetDamageMultiplier`	更改该实体在特定骨骼上受到的伤害大小
	`SetHealth`	设置该实体的生命值
	`SetMaxHealth`	设置该实体的最大生命值

Inherited Pawn Functions

Character inherits from Base Pawn Class, sharing it's methods and functions:
Base Pawnscripting-reference/classes/base-classes/pawn

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

Returns	Name	Description
	`ClearMorphTargets`	清除设置在此网格体上的所有变形目标
	`Drop`	丢弃角色当前持有的任何可拾取物
	`EnterVehicle`	进入载具的指定座位（0 - 驾驶人）
table of string	`GetAllMorphTargetNames`	返回一个包含所有可用变形目标的表
CameraMode	`GetCameraMode`	获取相机模式
boolean	`GetCanAim`	获取是否可以瞄准
boolean	`GetCanDrop`	获取是否可以丢弃物品
boolean	`GetCanGrabProps`	获取是否可以抓取道具
boolean	`GetCanPickupPickables`	获取是否可以拾取可拾取物（武器、近战武器、手榴弹……）
boolean	`GetCanPunch`	获取是否可以出拳
boolean	`GetCanSprint`	获取是否可以疾跑
boolean	`GetCanUsePickables`	获取是否可以使用可拾取物（武器、近战武器、手榴弹……）
integer	`GetFallDamageTaken`	获取坠落伤害
FallingMode	`GetFallingMode`	获取 FallingMode
GaitMode	`GetGaitMode`	获取 GaitMode
Prop or nil	`GetGrabbedProp`	获取当前抓取的 Prop
integer	`GetImpactDamageTaken`	获取受到的撞击伤害
integer	`GetJumpZVelocity`	获取跳跃 Z 轴速度
float	`GetMorphTarget`	返回指定变形目标的值
Base Pickable or nil	`GetPicked`	获取当前正在拾取的可拾取物
integer	`GetPunchDamage`	获取出拳伤害
float	`GetSpeedMultiplier`	获取速度系数
StanceMode	`GetStanceMode`	获取姿态模式
SwimmingMode	`GetSwimmingMode`	获取游泳模式
integer	`GetTeam`	获取团队
Base Vehicle or nil	`GetVehicle`	获取已进入的载具
integer	`GetVehicleSeat`	获取已进入的载具座位
ViewMode	`GetViewMode`	获取视角模式
AimMode	`GetWeaponAimMode`	获取武器瞄准模式
	`GrabProp`	给予角色一个 Prop
boolean	`IsInputEnabled`	获取是否启用了输入
boolean	`IsInRagdollMode`	获取角色是否处于布娃娃模式
boolean	`IsInvulnerable`	获取是否无敌
	`LeaveVehicle`	离开当前载具
	`LookAt`	AI：尝试使该角色看向指定位置
	`PickUp`	给予角色一个近战武器/手榴弹/武器（可拾取物）
	`PlayAnimation`	在此角色上播放动画蒙太奇
	`ResetPhysicalAnimationSettings`	重置所有物理动画设置
	`SetAccelerationSettings`	设置此角色的最大移动加速度
	`SetAirControl`	设置角色处于空中时允许的移动控制量
	`SetAnimationIdleWalkRunCrouching`	设置下蹲状态的混合空间（2D）动画水平轴代表 X 轴速度，垂直轴代表 Y 轴速度
	`SetAnimationIdleWalkRunProning`	设置俯卧状态的混合空间（2D）动画水平轴代表 X 轴速度，垂直轴代表 Y 轴速度
	`SetAnimationIdleWalkRunStanding`	设置站立状态的混合空间（2D）动画
	`SetAnimationsTransitionCrouchingProning`	设置下蹲与俯卧之间的过渡动画
	`SetAnimationsTransitionStandingCrouching`	设置站立与下蹲之间的过渡动画
	`SetCameraMode`	设置相机模式
	`SetCanAim`	设置此角色是否允许瞄准
	`SetCanDeployParachute`	设置此角色是否允许部署降落伞
	`SetCanDive`	设置此角色是否允许下潜
	`SetCanDrop`	设置此角色是否允许丢弃当前拾取的物品
	`SetCanGrabProps`	设置此角色是否允许抓取任何道具
	`SetCanPickupPickables`	设置此角色是否允许拾取任何可拾取物（武器、手榴弹、近战武器……）
	`SetCanPunch`	设置此角色是否允许出拳
	`SetCanSprint`	设置此角色是否允许疾跑
	`SetCanUsePickables`	设置此角色是否允许使用可拾取物（武器、手榴弹、近战武器……）
	`SetDeathSound`	更改角色死亡时的死亡声音
	`SetFallDamageTaken`	设置从高处坠落时承受的坠落伤害系数
	`SetFootstepVolumeMultiplier`	设置脚步音量系数
	`SetFOVMultiplier`	设置视场角系数
	`SetGaitMode`	设置步态模式
	`SetHighFallingTime`	设置过渡到 HighFalling 状态所需的时间
	`SetImpactDamageTaken`	设置被物体碾压时所承受的撞击伤害
	`SetInputEnabled`	启用/禁用角色的输入
	`SetInvulnerable`	设置角色是否可以接受任何伤害
	`SetMesh`	动态更改角色的网格体
	`SetMorphTarget`	通过名称和值设置变形目标
	`SetPainSound`	更改角色受到伤害时的痛苦声音
	`SetParachuteTexture`	更改降落伞的纹理
	`SetPhysicalAnimationSettings`	将物理动画设置应用给指定的骨骼体
	`SetPhysicsAsset`	设置角色的物理资产
	`SetPunchDamage`	设置该角色对他人施加的出拳伤害
	`SetRadialDamageToRagdoll`	设置触发角色进入布娃娃模式所需的最小径向伤害（例如爆炸）
	`SetRagdollMode`	设置角色的布娃娃模式
	`SetRagdollOnHitEnabled`	设置角色在被物体撞击或从高处坠落时是否会进入布娃娃模式
	`SetRagdollStandUpCooldown`	设置此角色从布娃娃状态起立之前的冷却时间（以秒为单位）
	`SetSimulatePhysics`	设置角色胶囊体以模拟物理效果
	`SetSpeedMultiplier`	设置所有速度的系数
	`SetStanceMode`	设置姿态模式
	`SetTeam`	设置团队，将禁用对同一团队成员的伤害
	`SetViewMode`	设置视角模式
	`SetWeaponAimMode`	设置武器的瞄准模式
	`UnGrabProp`	取消抓取/丢弃角色当前持有的道具

Optimal

`ClearMorphTargets`

清除设置在此网格体上的所有变形目标

my_character:ClearMorphTargets()

Moderate

`Drop`

丢弃角色当前持有的任何可拾取物

my_character:Drop()

`EnterVehicle`

进入载具的指定座位（0 - 驾驶人）

my_character:EnterVehicle(vehicle, seat?)

Parameters

Type	Parameter	Default	Description
Base Vehicle	`vehicle`	Required parameter	No description provided
integer	`seat?`	`0`	No description provided

Optimal

`GetAllMorphTargetNames`

返回一个包含所有可用变形目标的表

local ret = my_character:GetAllMorphTargetNames()

Returns

Type	Description
table of string	包含所有可用变形目标的表

Optimal

`GetCameraMode`

获取相机模式

local camera_mode = my_character:GetCameraMode()

Returns

Type	Description
CameraMode	camera_mode

`GetCanAim`

获取是否可以瞄准

local can_aim = my_character:GetCanAim()

Returns

Type	Description
boolean	can_aim

`GetCanDrop`

获取是否可以丢弃物品

local can_drop = my_character:GetCanDrop()

Returns

Type	Description
boolean	can_drop

`GetCanGrabProps`

获取是否可以抓取道具

local can_grab_props = my_character:GetCanGrabProps()

Returns

Type	Description
boolean	can_grab_props

`GetCanPickupPickables`

获取是否可以拾取可拾取物（武器、近战武器、手榴弹……）

local can_pickup = my_character:GetCanPickupPickables()

Returns

Type	Description
boolean	can_pickup

`GetCanPunch`

获取是否可以出拳

local can_punch = my_character:GetCanPunch()

Returns

Type	Description
boolean	can_punch

`GetCanSprint`

获取是否可以疾跑

local can_sprint = my_character:GetCanSprint()

Returns

Type	Description
boolean	can_sprint

`GetCanUsePickables`

获取是否可以使用可拾取物（武器、近战武器、手榴弹……）

local can_use = my_character:GetCanUsePickables()

Returns

Type	Description
boolean	can_use

`GetFallDamageTaken`

获取坠落伤害

local damage = my_character:GetFallDamageTaken()

Returns

Type	Description
integer	damage

`GetFallingMode`

获取 FallingMode

local ret = my_character:GetFallingMode()

Returns

Type	Description
FallingMode	No description provided

Optimal

`GetGaitMode`

获取 GaitMode

local gait_mode = my_character:GetGaitMode()

Returns

Type	Description
GaitMode	gait_mode

`GetGrabbedProp`

获取当前抓取的 Prop

local prop = my_character:GetGrabbedProp()

Returns

Type	Description
Prop or nil	prop

`GetImpactDamageTaken`

获取受到的撞击伤害

local impact_damage = my_character:GetImpactDamageTaken()

Returns

Type	Description
integer	impact_damage

`GetJumpZVelocity`

获取跳跃 Z 轴速度

local jump_z_velocity = my_character:GetJumpZVelocity()

Returns

Type	Description
integer	jump_z_velocity

Optimal

`GetMorphTarget`

返回指定变形目标的值

local value = my_character:GetMorphTarget(name)

Parameters

Type	Parameter	Default	Description
string	`name`	Required parameter	变形目标名称

Returns

Type	Description
float	变形目标的值

Optimal

`GetPicked`

获取当前正在拾取的可拾取物

local object = my_character:GetPicked()

Returns

Type	Description
Base Pickable or nil	object

`GetPunchDamage`

获取出拳伤害

local punch_damage = my_character:GetPunchDamage()

Returns

Type	Description
integer	punch_damage

`GetSpeedMultiplier`

获取速度系数

local speed_multiplier = my_character:GetSpeedMultiplier()

Returns

Type	Description
float	speed_multiplier

`GetStanceMode`

获取姿态模式

local stance_mode = my_character:GetStanceMode()

Returns

Type	Description
StanceMode	stance_mode

`GetSwimmingMode`

获取游泳模式

local swimming_mode = my_character:GetSwimmingMode()

Returns

Type	Description
SwimmingMode	swimming_mode

Optimal

`GetTeam`

获取团队

local team = my_character:GetTeam()

Returns

Type	Description
integer	team

`GetVehicle`

获取已进入的载具

local vehicle = my_character:GetVehicle()

Returns

Type	Description
Base Vehicle or nil	vehicle

`GetVehicleSeat`

获取已进入的载具座位

local seat_index = my_character:GetVehicleSeat()

Returns

Type	Description
integer	角色在载具中所坐的座位索引。如果不在载具中则为 -1

Optimal

`GetViewMode`

获取视角模式

local view_mode = my_character:GetViewMode()

Returns

Type	Description
ViewMode	view_mode

`GetWeaponAimMode`

获取武器瞄准模式

local aim_mode = my_character:GetWeaponAimMode()

Returns

Type	Description
AimMode	aim_mode

`GrabProp`

给予角色一个 Prop

my_character:GrabProp(prop)

Parameters

Type	Parameter	Default	Description
Prop	`prop`	Required parameter	No description provided

`IsInputEnabled`

获取是否启用了输入

local is_enabled = my_character:IsInputEnabled()

Returns

Type	Description
boolean	is_enabled

`IsInRagdollMode`

获取角色是否处于布娃娃模式

local ragdoll_enabled = my_character:IsInRagdollMode()

Returns

Type	Description
boolean	ragdoll_enabled

Optimal

`IsInvulnerable`

获取是否无敌

local is_invulnerable = my_character:IsInvulnerable()

Returns

Type	Description
boolean	is_invulnerable

`LeaveVehicle`

离开当前载具

my_character:LeaveVehicle()

Moderate

`LookAt`

AI：尝试使该角色看向指定位置

my_character:LookAt(location)

Parameters

Type	Parameter	Default	Description
Vector	`location`	Required parameter	要注视的世界坐标位置

Moderate

`PickUp`

给予角色一个近战武器/手榴弹/武器（可拾取物）

my_character:PickUp(pickable)

Parameters

Type	Parameter	Default	Description
Base Pickable	`pickable`	Required parameter	No description provided

`PlayAnimation`

在此角色上播放动画蒙太奇

my_character:PlayAnimation(animation_path, slot_type?, loop_indefinitely?, blend_in_time?, blend_out_time?, play_rate?, stop_all_montages?)

Parameters

Type	Parameter	Default	Description
Animation Reference	`animation_path`	Required parameter	No description provided
AnimationSlotType	`slot_type?`	`AnimationSlotType.FullBody`	No description provided
boolean	`loop_indefinitely?`	`false`	No description provided
float	`blend_in_time?`	`0.25`	No description provided
float	`blend_out_time?`	`0.25`	传入 -1 以禁用自动混出，并使动画永远保持在最后一帧姿态
float	`play_rate?`	`1.0`	No description provided
boolean	`stop_all_montages?`	`false`	停止来自同一组的所有正在播放的蒙太奇

`ResetPhysicalAnimationSettings`

重置所有物理动画设置

my_character:ResetPhysicalAnimationSettings()

Optimal

`SetAccelerationSettings`

设置此角色的最大移动加速度

my_character:SetAccelerationSettings(walking?, parachuting?, skydiving?, falling?, swimming?, swimming_surface?, flying?)

Parameters

Type	Parameter	Default	Description
integer	`walking?`	`768`	No description provided
integer	`parachuting?`	`512`	No description provided
integer	`skydiving?`	`768`	No description provided
integer	`falling?`	`128`	No description provided
integer	`swimming?`	`256`	No description provided
integer	`swimming_surface?`	`256`	No description provided
integer	`flying?`	`1024`	No description provided

Optimal

`SetAirControl`

设置角色处于空中时允许的移动控制量

my_character:SetAirControl(air_control?, boost_multiplier?, boost_velocity_threshold?)

Parameters

Type	Parameter	Default	Description
float	`air_control?`	`0.2`	下落时，角色可用的横向移动控制量。0 = 无法控制，1 = 在 MaxWalkSpeed 最大速度下完全控制
float	`boost_multiplier?`	`512`	下落时，当横向速度小于 boost_velocity_threshold 时应用于 air_control 的系数。将其设为 0 将禁用空中控制增强。最终结果会被限制在 1 以内
float	`boost_velocity_threshold?`	`25`	下落时，如果横向速度大小小于该值，则 air_control 会乘以 boost_multiplier。将其设为 0 将禁用空中控制增强

Slow

`SetAnimationIdleWalkRunCrouching`

设置下蹲状态的混合空间（2D）动画

水平轴代表 X 轴速度，垂直轴代表 Y 轴速度

my_character:SetAnimationIdleWalkRunCrouching(blend_space_path, enable_turn_in_place?)

Parameters

Type	Parameter	Default	Description
Animation Reference	`blend_space_path`	Required parameter	No description provided
boolean	`enable_turn_in_place?`	`false`	No description provided

Slow

`SetAnimationIdleWalkRunProning`

设置俯卧状态的混合空间（2D）动画

水平轴代表 X 轴速度，垂直轴代表 Y 轴速度

my_character:SetAnimationIdleWalkRunProning(blend_space_path)

Parameters

Type	Parameter	Default	Description
Animation Reference	`blend_space_path`	Required parameter	No description provided

Slow

`SetAnimationIdleWalkRunStanding`

设置站立状态的混合空间（2D）动画

水平轴代表 X 轴速度，垂直轴代表 Y 轴速度

my_character:SetAnimationIdleWalkRunStanding(blend_space_path, enable_turn_in_place?)

Parameters

Type	Parameter	Default	Description
Animation Reference	`blend_space_path`	Required parameter	No description provided
boolean	`enable_turn_in_place?`	`false`	No description provided

Slow

`SetAnimationsTransitionCrouchingProning`

设置下蹲与俯卧之间的过渡动画

my_character:SetAnimationsTransitionCrouchingProning(crouching_to_proning, proning_to_crouching)

Parameters

Type	Parameter	Default	Description
Animation Reference	`crouching_to_proning`	Required parameter	No description provided
Animation Reference	`proning_to_crouching`	Required parameter	No description provided

Slow

`SetAnimationsTransitionStandingCrouching`

设置站立与下蹲之间的过渡动画

my_character:SetAnimationsTransitionStandingCrouching(standing_to_crouching, crouching_to_standing)

Parameters

Type	Parameter	Default	Description
Animation Reference	`standing_to_crouching`	Required parameter	No description provided
Animation Reference	`crouching_to_standing`	Required parameter	No description provided

Optimal

`SetCameraMode`

设置相机模式（例如：仅第三人称 (TPS)、仅第一人称 (FPS) 或允许两者）

对 AI 使用 FPSOnly 相机模式将锁定其身体旋转（当使用 LookAt 时）

my_character:SetCameraMode(camera_mode)

Parameters

Type	Parameter	Default	Description
CameraMode	`camera_mode`	Required parameter	No description provided

`SetCanAim`

设置此角色是否允许瞄准

my_character:SetCanAim(can_aim)

Parameters

Type	Parameter	Default	Description
boolean	`can_aim`	Required parameter	No description provided

`SetCanDeployParachute`

设置此角色是否允许部署降落伞

my_character:SetCanDeployParachute(can_deploy_parachute)

Parameters

Type	Parameter	Default	Description
boolean	`can_deploy_parachute`	Required parameter	No description provided

Optimal

`SetCanDive`

设置此角色是否允许下潜

my_character:SetCanDive(can_dive)

Parameters

Type	Parameter	Default	Description
boolean	`can_dive`	Required parameter	No description provided

Optimal

`SetCanDrop`

设置此角色是否允许丢弃当前拾取的物品

my_character:SetCanDrop(can_drop)

Parameters

Type	Parameter	Default	Description
boolean	`can_drop`	Required parameter	No description provided

`SetCanGrabProps`

设置此角色是否允许抓取任何道具

my_character:SetCanGrabProps(can_grab_props)

Parameters

Type	Parameter	Default	Description
boolean	`can_grab_props`	Required parameter	No description provided

`SetCanPickupPickables`

设置此角色是否允许拾取任何可拾取物（武器、手榴弹、近战武器……）

my_character:SetCanPickupPickables(can_pickup)

Parameters

Type	Parameter	Default	Description
boolean	`can_pickup`	Required parameter	No description provided

`SetCanPunch`

设置此角色是否允许出拳

my_character:SetCanPunch(can_punch)

Parameters

Type	Parameter	Default	Description
boolean	`can_punch`	Required parameter	No description provided

`SetCanSprint`

设置此角色是否允许疾跑

my_character:SetCanSprint(can_sprint)

Parameters

Type	Parameter	Default	Description
boolean	`can_sprint`	Required parameter	No description provided

`SetCanUsePickables`

设置此角色是否允许使用可拾取物（武器、手榴弹、近战武器……）

my_character:SetCanUsePickables(can_use)

Parameters

Type	Parameter	Default	Description
boolean	`can_use`	Required parameter	No description provided

`SetDeathSound`

更改角色死亡时的死亡声音

my_character:SetDeathSound(sound_asset)

Parameters

Type	Parameter	Default	Description
Sound Reference	`sound_asset`	Required parameter	No description provided

Optimal

`SetFallDamageTaken`

设置从高处坠落时承受的坠落伤害系数。

设为 0 将使角色不受到任何坠落伤害

my_character:SetFallDamageTaken(damage)

Parameters

Type	Parameter	Default	Description
integer	`damage`	Required parameter	默认值为 10

`SetFootstepVolumeMultiplier`

设置脚步音量系数

my_character:SetFootstepVolumeMultiplier(volume_multiplier)

Parameters

Type	Parameter	Default	Description
float	`volume_multiplier`	Required parameter	No description provided

Optimal

`SetFOVMultiplier`

设置视场角系数

my_character:SetFOVMultiplier(multiplier)

Parameters

Type	Parameter	Default	Description
float	`multiplier`	Required parameter	No description provided

Optimal

`SetGaitMode`

设置步态模式

my_character:SetGaitMode(gait_mode)

Parameters

Type	Parameter	Default	Description
GaitMode	`gait_mode`	Required parameter	No description provided

`SetHighFallingTime`

设置自动从 SmallFalling 过渡到 HighFalling 状态所经过的时间（秒）

将其设为 -1 将永远不会进入 HighFalling 状态，因此下落时不会成为布娃娃

my_character:SetHighFallingTime(time)

Parameters

Type	Parameter	Default	Description
float	`time`	Required parameter	默认值为 1 秒

`SetImpactDamageTaken`

设置被物体碾压时承受的撞击伤害。

设为 0 将使角色不承受伤害，也不会进入布娃娃模式

my_character:SetImpactDamageTaken(impact_damage)

Parameters

Type	Parameter	Default	Description
integer	`impact_damage`	Required parameter	默认值为 10

Optimal

`SetInputEnabled`

启用/禁用角色的输入

my_character:SetInputEnabled(is_enabled)

Parameters

Type	Parameter	Default	Description
boolean	`is_enabled`	Required parameter	No description provided

`SetInvulnerable`

设置角色是否可以接受任何伤害

my_character:SetInvulnerable(is_invulnerable)

Parameters

Type	Parameter	Default	Description
boolean	`is_invulnerable`	Required parameter	No description provided

`SetMesh`

动态更改角色的网格体

my_character:SetMesh(skeletal_mesh_asset)

Parameters

Type	Parameter	Default	Description
SkeletalMesh Reference	`skeletal_mesh_asset`	Required parameter	No description provided

Moderate

`SetMorphTarget`

通过名称和值设置变形目标

my_character:SetMorphTarget(name, value)

Parameters

Type	Parameter	Default	Description
string	`name`	Required parameter	变形目标名称
float	`value`	Required parameter	No description provided

Slow

`SetPainSound`

更改角色受到伤害时的痛苦声音

my_character:SetPainSound(sound_asset)

Parameters

Type	Parameter	Default	Description
Sound Reference	`sound_asset`	Required parameter	No description provided

Slow

`SetParachuteTexture`

更改降落伞的纹理

my_character:SetParachuteTexture(texture)

Parameters

Type	Parameter	Default	Description
Image Path	`texture`	Required parameter	No description provided

Moderate

`SetPhysicalAnimationSettings`

将物理动画设置应用给指定的骨骼体

my_character:SetPhysicalAnimationSettings(bone, include_self, is_local_simulation, orientation_strength?, angular_velocity_strength?, position_strength?, velocity_strength?, max_linear_force?, max_angular_force?)

Parameters

Type	Parameter	Default	Description
string	`bone`	Required parameter	我们将驱动的骨骼体
boolean	`include_self`	Required parameter	是否修改给定的骨骼体
boolean	`is_local_simulation`	Required parameter	驱动目标是在世界空间还是本地空间
float	`orientation_strength?`	`0`	用于修正朝向误差的强度
float	`angular_velocity_strength?`	`0`	用于修正角速度误差的强度
float	`position_strength?`	`0`	用于修正线性位置误差的强度。仅用于非本地模拟
float	`velocity_strength?`	`0`	用于修正线性速度误差的强度。仅用于非本地模拟
float	`max_linear_force?`	`0`	用于修正线性误差的最大力
float	`max_angular_force?`	`0`	用于修正角度误差的最大力

Slow

`SetPhysicsAsset`

设置角色的物理资产

my_character:SetPhysicsAsset(physics_asset)

Parameters

Type	Parameter	Default	Description
Other	`physics_asset`	Required parameter	No description provided

Optimal

`SetPunchDamage`

设置该角色对他人施加的出拳伤害

my_character:SetPunchDamage(punch_damage)

Parameters

Type	Parameter	Default	Description
integer	`punch_damage`	Required parameter	默认值为 15

`SetRadialDamageToRagdoll`

设置触发角色进入布娃娃模式所需的最小径向伤害（例如爆炸）。

设为 -1 将使角色在受到径向伤害时不会进入布娃娃模式

my_character:SetRadialDamageToRagdoll(damage)

Parameters

Type	Parameter	Default	Description
integer	`damage`	Required parameter	默认值为 50

Optimal

`SetRagdollMode`

设置角色的布娃娃模式

my_character:SetRagdollMode(ragdoll_enabled)

Parameters

Type	Parameter	Default	Description
boolean	`ragdoll_enabled`	Required parameter	No description provided

Optimal

`SetRagdollOnHitEnabled`

设置角色在被物体撞击或从高处坠落时是否会进入布娃娃模式

my_character:SetRagdollOnHitEnabled(is_enabled)

Parameters

Type	Parameter	Default	Description
boolean	`is_enabled`	Required parameter	No description provided

`SetRagdollStandUpCooldown`

设置此角色从布娃娃状态起立之前的冷却时间（以秒为单位）

my_character:SetRagdollStandUpCooldown(time)

Parameters

Type	Parameter	Default	Description
float	`time`	Required parameter	No description provided

Optimal

`SetSimulatePhysics`

设置角色胶囊体以模拟物理效果

my_character:SetSimulatePhysics(simulate_physics)

Parameters

Type	Parameter	Default	Description
boolean	`simulate_physics`	Required parameter	No description provided

Optimal

`SetSpeedMultiplier`

设置所有速度的系数

my_character:SetSpeedMultiplier(speed_multiplier)

Parameters

Type	Parameter	Default	Description
float	`speed_multiplier`	Required parameter	1 为正常速度

`SetStanceMode`

设置姿态模式

my_character:SetStanceMode(stance_mode)

Parameters

Type	Parameter	Default	Description
StanceMode	`stance_mode`	Required parameter	No description provided

`SetTeam`

设置团队，将禁用对同一团队成员的伤害

my_character:SetTeam(team)

Parameters

Type	Parameter	Default	Description
integer	`team`	Required parameter	0 为中立且为默认值

`SetViewMode`

设置视角模式

my_character:SetViewMode(view_mode)

Parameters

Type	Parameter	Default	Description
ViewMode	`view_mode`	Required parameter	No description provided

`SetWeaponAimMode`

设置武器的瞄准模式

my_character:SetWeaponAimMode(aim_mode)

Parameters

Type	Parameter	Default	Description
AimMode	`aim_mode`	Required parameter	No description provided

`UnGrabProp`

取消抓取/丢弃角色当前持有的道具

my_character:UnGrabProp()

🚀 事件

Inherited Entity Events

Character inherits from Base Entity Class, sharing it's events:
Base Entityscripting-reference/classes/base-classes/entity

	Name	Description
	`ClassRegister`	当使用继承系统注册一个新类时触发
	`Destroy`	当实体被销毁时触发
	`Spawn`	当实体被生成/创建时触发
	`ValueChange`	当实体通过 `:SetValue()` 改变了值时触发

Inherited Actor Events

Character inherits from Base Actor Class, sharing it's events:
Base Actorscripting-reference/classes/base-classes/actor

	Name	Description
	`DimensionChange`	当 Actor 改变其维度时触发
	`EnterWater`	Triggered when an Actor enters a water body
	`LeaveWater`	Triggered when an Actor leaves a water body
	`NetworkAuthorityChange`	Triggered when an Actor changes its network authority Player
	`NetworkAuthorityChange`	Triggered when the local Player gets/loses network authority over this actor

Inherited Damageable Events

Character inherits from Base Damageable Class, sharing it's events:
Base Damageablescripting-reference/classes/base-classes/damageable

	Name	Description
	`Death`	当实体死亡时
	`HealthChange`	当实体的生命值发生改变时，无论是由于受到伤害，还是通过脚本或重生进行手动设置
	`Respawn`	当实体重生时
	`TakeDamage`	当此实体受到伤害时触发

Inherited Pawn Events

Character inherits from Base Pawn Class, sharing it's events:
Base Pawnscripting-reference/classes/base-classes/pawn

	Name	Description
	`AnimationBeginNotify`	当动画蒙太奇通知开始时
	`AnimationEndNotify`	当动画蒙太奇通知结束时
	`MoveComplete`	当 AI 到达目的地或失败时调用
	`Possess`	当角色被玩家控制时
	`UnPossess`	当角色被玩家取消控制时

	Name	Description
	`Attack`	当角色使用近战武器有效进行攻击时触发
	`AttemptEnterVehicle`	当角色尝试进入载具时触发
	`AttemptLeaveVehicle`	当角色尝试离开载具时触发
	`AttemptReload`	当角色尝试换弹时触发
	`Drop`	当角色丢弃当前拾取的可拾取物时
	`EnterVehicle`	当角色进入载具时
	`FallingModeChange`	当 FallingMode 发生改变时调用
	`Fire`	当角色开火武器时
	`GaitModeChange`	当 GaitMode（步态模式）发生改变时调用
	`GrabProp`	当角色抓取起一个道具时
	`Highlight`	当角色高亮/注视一个道具或可拾取物时触发
	`Interact`	当角色与道具或可拾取物互动时触发
	`LeaveVehicle`	当角色离开载具时
	`PickUp`	当角色拾取任何物品时
	`PullUse`	当角色按下可拾取物的使用键时触发（即装备该物品时单击鼠标左键）
	`Punch`	当角色出拳时
	`RagdollModeChange`	当角色进入或离开布娃娃状态时
	`ReleaseUse`	当角色松开可拾取物的使用键时触发（即装备该物品时松开鼠标左键）
	`Reload`	当角色为武器换弹时
	`StanceModeChange`	当 StanceMode（姿态模式）发生改变时调用
	`SwimmingModeChange`	当游泳模式发生改变时调用
	`UnGrabProp`	当角色丢弃道具时
	`ViewModeChange`	当角色改变其视角模式时
	`WeaponAimModeChange`	当武器瞄准模式发生改变时调用

`Attack`

当角色使用近战武器有效进行攻击时触发

Character.Subscribe("Attack", function(self, melee)
	-- Attack was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
Melee	`melee`	No description provided

`AttemptEnterVehicle`

当角色尝试进入载具时触发

返回 false 以阻止该行为

Character.Subscribe("AttemptEnterVehicle", function(self, vehicle, seat_index)
	-- AttemptEnterVehicle was called
	return true
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
Base Vehicle	`vehicle`	No description provided
integer	`seat_index`	No description provided

`AttemptLeaveVehicle`

当角色尝试离开载具时触发

返回 false 以阻止该行为

Character.Subscribe("AttemptLeaveVehicle", function(self, vehicle)
	-- AttemptLeaveVehicle was called
	return true
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
Base Vehicle	`vehicle`	No description provided

`AttemptReload`

当角色尝试换弹时触发

返回 false 以阻止该行为

Character.Subscribe("AttemptReload", function(self, weapon)
	-- AttemptReload was called
	return true
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
Weapon	`weapon`	No description provided

`Drop`

当角色丢弃当前拾取的可拾取物时

Character.Subscribe("Drop", function(self, object, triggered_by_player)
	-- Drop was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
Base Pickable	`object`	No description provided
boolean	`triggered_by_player`	No description provided

`EnterVehicle`

当角色进入载具时

Character.Subscribe("EnterVehicle", function(self, vehicle, seat_index)
	-- EnterVehicle was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
Base Vehicle	`vehicle`	No description provided
integer	`seat_index`	No description provided

`FallingModeChange`

当 FallingMode 发生改变时调用

Character.Subscribe("FallingModeChange", function(self, old_state, new_state)
	-- FallingModeChange was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
FallingMode	`old_state`	No description provided
FallingMode	`new_state`	No description provided

`Fire`

当角色开火武器时

Character.Subscribe("Fire", function(self, weapon)
	-- Fire was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
Weapon	`weapon`	No description provided

`GaitModeChange`

当 GaitMode（步态模式）发生改变时调用

Character.Subscribe("GaitModeChange", function(self, old_state, new_state)
	-- GaitModeChange was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
GaitMode	`old_state`	No description provided
GaitMode	`new_state`	No description provided

`GrabProp`

当角色抓取起一个道具时

Character.Subscribe("GrabProp", function(self, prop)
	-- GrabProp was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
Prop	`prop`	No description provided

`Highlight`

当角色高亮/注视一个道具或可拾取物时触发

Character.Subscribe("Highlight", function(self, is_highlighted, object)
	-- Highlight was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
boolean	`is_highlighted`	对象当前是否被高亮
Prop or Base Pickable	`object`	No description provided

`Interact`

当角色与道具或可拾取物互动时触发

返回 false 以阻止该行为

Character.Subscribe("Interact", function(self, object)
	-- Interact was called
	return true
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
Prop or Base Pickable	`object`	No description provided

`LeaveVehicle`

当角色离开载具时

Character.Subscribe("LeaveVehicle", function(self, vehicle, seat_index)
	-- LeaveVehicle was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
Base Vehicle	`vehicle`	No description provided
integer	`seat_index`	No description provided

`PickUp`

当角色拾取任何物品时

Character.Subscribe("PickUp", function(self, object)
	-- PickUp was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
Base Pickable	`object`	No description provided

`PullUse`

当角色按下可拾取物的使用键时触发（即装备该物品时单击鼠标左键）

Character.Subscribe("PullUse", function(self, pickable)
	-- PullUse was called
end)

Arguments

Type	Argument	Description
Character	`self`	使用它的角色
Base Pickable	`pickable`	刚刚被使用的可拾取物

`Punch`

当角色出拳时

Character.Subscribe("Punch", function(self)
	-- Punch was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided

`RagdollModeChange`

当角色进入或离开布娃娃状态时

Character.Subscribe("RagdollModeChange", function(self, old_state, new_state)
	-- RagdollModeChange was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
boolean	`old_state`	No description provided
boolean	`new_state`	No description provided

`ReleaseUse`

当角色松开可拾取物的使用键时触发（即装备该物品时松开鼠标左键）

Character.Subscribe("ReleaseUse", function(self, pickable)
	-- ReleaseUse was called
end)

Arguments

Type	Argument	Description
Character	`self`	停止使用它的角色
Base Pickable	`pickable`	刚刚停止使用的可拾取物

`Reload`

当角色为武器换弹时

Character.Subscribe("Reload", function(self, weapon, ammo_to_reload)
	-- Reload was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
Weapon	`weapon`	No description provided
integer	`ammo_to_reload`	No description provided

`StanceModeChange`

当 StanceMode（姿态模式）发生改变时调用

Character.Subscribe("StanceModeChange", function(self, old_state, new_state)
	-- StanceModeChange was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
StanceMode	`old_state`	No description provided
StanceMode	`new_state`	No description provided

`SwimmingModeChange`

当游泳模式发生改变时调用

Character.Subscribe("SwimmingModeChange", function(self, old_state, new_state)
	-- SwimmingModeChange was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
SwimmingMode	`old_state`	No description provided
SwimmingMode	`new_state`	No description provided

`UnGrabProp`

当角色丢弃道具时

Character.Subscribe("UnGrabProp", function(self, prop)
	-- UnGrabProp was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
Prop	`prop`	No description provided

`ViewModeChange`

当角色改变其视角模式时

Character.Subscribe("ViewModeChange", function(self, old_state, new_state)
	-- ViewModeChange was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
ViewMode	`old_state`	No description provided
ViewMode	`new_state`	No description provided

`WeaponAimModeChange`

当武器瞄准模式发生改变时调用

Character.Subscribe("WeaponAimModeChange", function(self, old_state, new_state)
	-- WeaponAimModeChange was called
end)

Arguments

Type	Argument	Description
Character	`self`	No description provided
AimMode	`old_state`	No description provided
AimMode	`new_state`	No description provided

Male & Female Customization

The following items can be used to customize Male & Female (nanos-world::SK_Male & nanos-world::SK_Female) default meshes from nanos world.

Morph Targets	Mat. Scalar Params	Mat. Color Params	Mat. Texture Params
`nose1`	`BaseColorPower`	`LipstickTint`	`Texture`
`nose2`	`Muscular`	`BrowsTint`	`LipstickMask`
`brows`	`Specular`	`BlushTint`	`BrowsMask`
`mouth`	`Roughness`	`EyeShadowTint`	`BlushMask`
`fat`	`Scatter`	`UnderwearTint`	`EyeShadowMask`
`nose3`	`DetailAmount`	`HairTint`	`Normal`
`chin`	`DetailScale`	`Tint`	`NormalMuscular`
`face`	`UnderwearRoughness`		`UnderwearMask`
`nose4`	`UnderwearSpecular`		`SR`
`skinny`	`HairScatter`		`HairTexture`
`jaw`	`HairAlphaPower`		`HairSpecular`
`brows2`	`HairSpecularMultiplier`		`HairRoughness`
`angry`	`HairRoughnessMultiplier`		`HairTangent`
`smirk`	`HairPixelDepth`
`smirk2`
`smirk3`
`smile`
`nose6`
`jaw_forward`
`lips`
`lips2`
`mouth_wide`
`eyes1`
`eyes2`
`eyes3`
`eyes4`
`eyes_retraction`
`lips3`
`eyes5`
`nose7`
`forehead`
`bodyfat`

Character's Skeleton Bone Names

信息

Ugly list I know.

root
- pelvis
  - spine_01
    - spine_02
      - spine_03
        
        clavicle_l
        
        upperarm_l
        
        lowerarm_l
        
        hand_l
        
        index_01_l
        
        index_02_l
        
        index_03_l
        
        middle_01_l
        
        middle_02_l
        
        middle_03_l
        
        pinky_01_l
        
        pinky_02_l
        
        pinky_03_l
        
        ring_01_l
        
        ring_02_l
        
        ring_03_l
        
        thumb_01_l
        
        thumb_02_l
        
        thumb_03_l
        
        weapon_l
        
        clavicle_r
        
        upperarm_r
        
        lowerarm_r
        
        hand_r
        
        index_01_r
        
        index_02_r
        
        index_03_r
        
        middle_01_r
        
        middle_02_r
        
        middle_03_r
        
        pinky_01_r
        
        pinky_02_r
        
        pinky_03_r
        
        ring_01_r
        
        ring_02_r
        
        ring_03_r
        
        thumb_01_r
        
        thumb_02_r
        
        thumb_03_r
        
        weapon_r
        
        neck_01
        
        head
        
        lefteye
        
        righteye
        
        leftlidup
        
        leftlidlow
        
        rightlidup
        
        rightlitlow
  - thigh_l
    - calf_l
      - foot_l
        
        ball_l
  - thigh_r
    - calf_r
      - foot_r
        
        ball_r

🎒 示例​

🛠 构造函数​

Default Constructor​

Parameters

🗿 静态函数​

🦠 函数​

ClearMorphTargets​

Drop​

EnterVehicle​

Parameters

GetAllMorphTargetNames​

Returns

GetCameraMode​

Returns

GetCanAim​

Returns

GetCanDrop​

Returns

GetCanGrabProps​

Returns

GetCanPickupPickables​

Returns

GetCanPunch​

Returns

GetCanSprint​

Returns

GetCanUsePickables​

Returns

GetFallDamageTaken​

Returns

GetFallingMode​

Returns

GetGaitMode​

Returns

GetGrabbedProp​

Returns

GetImpactDamageTaken​

Returns

GetJumpZVelocity​

Returns

GetMorphTarget​

Parameters

Returns

GetPicked​

Returns

GetPunchDamage​

Returns

GetSpeedMultiplier​

Returns

GetStanceMode​

Returns

GetSwimmingMode​

Returns

GetTeam​

Returns

GetVehicle​

Returns

GetVehicleSeat​

Returns

GetViewMode​

Returns

GetWeaponAimMode​

Returns

GrabProp​

Parameters

IsInputEnabled​

Returns

IsInRagdollMode​

Returns

IsInvulnerable​

Returns

LeaveVehicle​

LookAt​

Parameters

PickUp​

Parameters

PlayAnimation​

Parameters

ResetPhysicalAnimationSettings​

SetAccelerationSettings​

🎒 示例

🛠 构造函数

Default Constructor

🗿 静态函数

🦠 函数

`ClearMorphTargets`

`Drop`

`EnterVehicle`

`GetAllMorphTargetNames`

`GetCameraMode`

`GetCanAim`

`GetCanDrop`

`GetCanGrabProps`

`GetCanPickupPickables`

`GetCanPunch`

`GetCanSprint`

`GetCanUsePickables`

`GetFallDamageTaken`

`GetFallingMode`

`GetGaitMode`

`GetGrabbedProp`

`GetImpactDamageTaken`

`GetJumpZVelocity`

`GetMorphTarget`

`GetPicked`

`GetPunchDamage`

`GetSpeedMultiplier`

`GetStanceMode`

`GetSwimmingMode`

`GetTeam`

`GetVehicle`

`GetVehicleSeat`

`GetViewMode`

`GetWeaponAimMode`

`GrabProp`

`IsInputEnabled`

`IsInRagdollMode`

`IsInvulnerable`

`LeaveVehicle`

`LookAt`

`PickUp`

`PlayAnimation`

`ResetPhysicalAnimationSettings`

`SetAccelerationSettings`

`SetAirControl`

`SetAnimationIdleWalkRunCrouching`

`SetAnimationIdleWalkRunProning`

`SetAnimationIdleWalkRunStanding`

`SetAnimationsTransitionCrouchingProning`

`SetAnimationsTransitionStandingCrouching`

`SetCameraMode`

`SetCanAim`

`SetCanDeployParachute`

`SetCanDive`

`SetCanDrop`

`SetCanGrabProps`

`SetCanPickupPickables`

`SetCanPunch`

`SetCanSprint`

`SetCanUsePickables`

`SetDeathSound`

`SetFallDamageTaken`

`SetFootstepVolumeMultiplier`

`SetFOVMultiplier`

`SetGaitMode`

`SetHighFallingTime`

`SetImpactDamageTaken`

`SetInputEnabled`

`SetInvulnerable`

`SetMesh`

`SetMorphTarget`

`SetPainSound`

`SetParachuteTexture`

`SetPhysicalAnimationSettings`

`SetPhysicsAsset`

`SetPunchDamage`

`SetRadialDamageToRagdoll`

`SetRagdollMode`