💣 Grenade

手榴弹是可拾取物，角色可以抓取并投掷。投掷后 X 秒它会发生爆炸，对周围造成伤害。

Server Only🔁Auto-Distributed🧑‍💻API Source

👪Inheritance

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

---

🎒 示例

Server/Index.lua

local new_grenade = Grenade(
	Vector(-900, 185, 215),
	Rotator(0, 90, 90),
	"nanos-world::SM_Grenade_G67",
	"nanos-world::P_Grenade_Special",
	"nanos-world::A_Explosion_Large"
)

🛠 构造函数

Default Constructor

No description provided

local my_grenade = Grenade(location, rotation, static_mesh_asset?, explosion_particles?, explosion_sound?, collision_type?, gravity_enabled?, spawn_mode?)

Parameters

Type	Name	Default	Description
Vector	location	Required parameter	生成的世界坐标位置
Rotator	rotation	Required parameter	生成的世界坐标旋转
StaticMesh Reference	static_mesh_asset	nanos-world::SM_Grenade_G67	要使用的静态网格体资产
Particle Reference	explosion_particles	nanos-world::P_Grenade_Special	爆炸时生成的粒子
Sound Reference	explosion_sound	nanos-world::A_Explosion_Large	爆炸时播放的声音
CollisionType	collision_type	CollisionType.Auto	此 Actor 的碰撞配置文件
boolean	gravity_enabled	true	重力是否影响此 Actor
SpawnMode	spawn_mode	SpawnMode.Immediate	传入 SpawnMode.AfterConstructor 或 SpawnMode.Manual 可避免立即将实体发送至客户端，在需要配置多项设置时使用此选项可提升性能。最后必须调用 FinishSpawn()

提示

nanos world 提供了一个名为 nanos-world::P_Grenade_Special 的特殊 Particle*，它会根据爆炸表面以及是否在水下来生成不同的粒子效果。

*此“Particle”仅为一个特殊标识符，且只能用于手榴弹！

🗿 静态函数

Inherited Entity Static Functions

Grenade 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

Grenade 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

Grenade 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
	string	GetAttachedToSocket	获取此 Actor 所附加到的骨骼或插槽名称
	table	GetBounds	获取此 Actor 的包围盒，便于计算其在世界中的尺寸
	CollisionType	GetCollision	获取该 Actor 的碰撞类型
	integer	GetDimension	获取该 Actor 的维度
	float	GetDistanceFromCamera	获取该 Actor 距离相机的距离
	Vector	GetForce	获取该 Actor 的持续外力（由 SetForce() 设置）
	float	GetLifeSpan	获取此 Actor 被销毁前剩余的时间（秒）
	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 的维度。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

Grenade 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 Pickable Functions

Grenade inherits from Base Pickable Class, sharing it's methods and functions:
Base Pickablescripting-reference/classes/base-classes/pickable

	Returns	Name	Description
		AddSkeletalMeshAttached	附加一个骨骼网格体作为该实体的骨骼主姿态
		AddStaticMeshAttached	附加一个静态网格体到此实体
	table of string	GetAllSkeletalMeshAttached	获取附加到此实体的所有骨骼网格体
	table of string	GetAllStaticMeshAttached	获取附加到此实体的所有静态网格体
	Character or nil	GetHandler	获取当前正手持该可拾取物的角色（如果存在）
	HandlingMode	GetHandlingMode	获取该可拾取物的手持模式
	SkeletalMesh Reference	GetMesh	获取该可拾取物使用的资产名称
		PullUse	拉取该可拾取物的使用状态（如果这是武器，将开始开火）
		ReleaseUse	释放该可拾取物的使用状态（如果这是武器，将停止开火）
		RemoveAllSkeletalMeshesAttached	移除所有已附加的骨骼网格体
		RemoveAllStaticMeshesAttached	移除所有已附加的静态网格体
		RemoveSkeletalMeshAttached	根据自定义 ID 移除此可拾取物上已存在的骨骼网格体（如果存在）
		RemoveStaticMeshAttached	根据自定义 ID 移除此可拾取物上已存在的静态网格体（如果存在）
		SetAttachmentSettings	设置此可拾取物的附加设置（即拾取时如何附加到角色上）
		SetBuoyancyPontoons	设置水体模拟所使用的浮筒
		SetBuoyancySettings	设置该实体在水中的行为
		SetCanUse	设置玩家在手持该可拾取物时是否可以使用它
		SetCrosshairMaterial	设置该可拾取物的准星材质
		SetPickable	设置玩家是否可以从地面上拾取该可拾取物
		SetStaticMeshAttachedTransform	设置已附加静态网格体的位置和旋转

	Returns	Name	Description
		Explode	强制此手榴弹爆炸
	float	GetBaseDamage	获取在内半径范围内生效的最大伤害
	float	GetDamageFalloff	获取用于在基础伤害和最小伤害之间进行插值的衰减指数
	float	GetDamageInnerRadius	获取完全应用基础伤害的半径
	float	GetDamageOuterRadius	获取伤害达到最小伤害时的半径
	float	GetMinimumDamage	获取在外半径处生效的最小伤害
	float	GetThrowForce	获取投掷时施加的冲量
	float	GetTimeToExplode	获取投掷后距离爆炸的时间
		SetDamage	设置此手榴弹的伤害参数
		SetThrowForce	设置投掷时施加的冲量
		SetTimeToExplode	设置投掷后距离爆炸的时间

---

Moderate

Explode

强制此手榴弹爆炸

my_grenade:Explode()

See also Explode.

---

Optimal

GetBaseDamage

获取在内半径范围内生效的最大伤害

local base_damage = my_grenade:GetBaseDamage()

Returns

Type	Description
float	基础伤害

See also SetDamage.

---

Optimal

GetDamageFalloff

获取用于在基础伤害和最小伤害之间进行插值的衰减指数

local damage_falloff = my_grenade:GetDamageFalloff()

Returns

Type	Description
float	伤害衰减

See also SetDamage.

---

Optimal

GetDamageInnerRadius

获取完全应用基础伤害的半径

local damage_inner_radius = my_grenade:GetDamageInnerRadius()

Returns

Type	Description
float	内半径

See also SetDamage.

---

Optimal

GetDamageOuterRadius

获取伤害达到最小伤害时的半径

local damage_outer_radius = my_grenade:GetDamageOuterRadius()

Returns

Type	Description
float	外半径

See also SetDamage.

---

Optimal

GetMinimumDamage

获取在外半径处生效的最小伤害

local minimum_damage = my_grenade:GetMinimumDamage()

Returns

Type	Description
float	最小伤害

See also SetDamage.

---

Optimal

GetThrowForce

获取投掷时施加的冲量

local throw_force = my_grenade:GetThrowForce()

Returns

Type	Description
float	投掷作用力

See also SetThrowForce.

---

Optimal

GetTimeToExplode

获取投掷后距离爆炸的时间

local time = my_grenade:GetTimeToExplode()

Returns

Type	Description
float	距离爆炸的秒数

See also SetTimeToExplode.

---

Optimal

SetDamage

设置此手榴弹的伤害参数

my_grenade:SetDamage(base_damage?, minimum_damage?, damage_inner_radius?, damage_outer_radius?, damage_falloff?)

Parameters

Type	Parameter	Default	Description
integer	base_damage?	90	内半径范围内的最大伤害
integer	minimum_damage?	0	外半径边缘的最小伤害
integer	damage_inner_radius?	200	伤害为 100% 的半径范围
integer	damage_outer_radius?	1000	通过衰减插值计算伤害的半径范围
float	damage_falloff?	1	最大伤害与最小伤害之间的线性插值函数

See also GetBaseDamage, GetDamageFalloff, GetDamageInnerRadius, GetDamageOuterRadius, GetMinimumDamage.

---

Moderate

SetThrowForce

设置投掷时施加的冲量

my_grenade:SetThrowForce(throw_force)

Parameters

Type	Parameter	Default	Description
integer	throw_force	Required parameter	投掷时施加的新冲量

See also GetThrowForce.

---

Optimal

SetTimeToExplode

设置投掷后距离爆炸的时间

my_grenade:SetTimeToExplode(time)

Parameters

Type	Parameter	Default	Description
float	time	Required parameter	时间（秒）

See also GetTimeToExplode.

🚀 事件

Inherited Entity Events

Grenade 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

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

	Name	Description
	DimensionChange	当 Actor 改变其维度时触发
	EnterWater	当 Actor 进入水体时触发
	LeaveWater	当 Actor 离开水体时触发
	NetworkAuthorityChange	当 Actor 更改其网络主控玩家时触发
	NetworkAuthorityChange	当本地玩家获得或失去对此 Actor 的网络主控时触发

Inherited Pickable Events

Grenade inherits from Base Pickable Class, sharing it's events:
Base Pickablescripting-reference/classes/base-classes/pickable

	Name	Description
	Drop	当角色丢弃该可拾取物时
	Hit	当该可拾取物撞击到某种物体时触发
	Interact	当角色与该可拾取物交互时触发（即尝试将其拾取）
	PickUp	当 Character 拾取该物品时触发
	PullUse	当角色按下该可拾取物的使用键时触发（即在装备此物品时单击鼠标左键）
	ReleaseUse	当角色松开该可拾取物的使用键时触发（即在装备此物品时松开鼠标左键）

	Name	Description
	Explode	当手榴弹爆炸时触发
	Throw	当手榴弹被投掷时触发

---

Explode

当手榴弹爆炸时触发

Grenade.Subscribe("Explode", function(self)
	-- Explode was called
end)

Arguments

Type	Argument	Description
Grenade	self	爆炸的手榴弹

See also Explode.

---

Throw

当手榴弹被投掷时触发

Grenade.Subscribe("Throw", function(self, handler)
	-- Throw was called
end)

Arguments

Type	Argument	Description
Grenade	self	爆炸的手榴弹
Character	handler	投掷它的角色