Grenade.json

{
	"name": "Grenade",
	"description": "Grenades are Pickables which Characters can grab and throw. It explodes after X seconds after thrown, causing damage around.",
	"authority": "server",
	"inheritance": [
		"Entity",
		"Actor",
		"Paintable",
		"Pickable"
	],
	"constructors": [
		{
			"description": "Default Constructor",
			"parameters": [
				{
					"type": "Vector",
					"name": "location"
				},
				{
					"type": "Rotator",
					"name": "rotation"
				},
				{
					"type": "StaticMeshPath",
					"name": "static_mesh_asset",
					"default": "nanos-world::SM_Grenade_G67"
				},
				{
					"type": "ParticlePath",
					"name": "explosion_particles",
					"default": "nanos-world::P_Grenade_Special"
				},
				{
					"type": "SoundPath",
					"name": "explosion_sound",
					"default": "nanos-world::A_Explosion_Large"
				},
				{
					"type": "CollisionType",
					"name": "collision_type",
					"default": "CollisionType.Auto"
				},
				{
					"type": "boolean",
					"name": "gravity_enabled",
					"default": "true"
				}
			]
		}
	],
	"functions": [
		{
			"authority": "server",
			"name": "Explode",
			"description": "Forces this grenade to Explode",
			"relations": {
				"events": [
					"Explode"
				]
			}
		},
		{
			"authority": "server",
			"name": "SetDamage",
			"description": "Sets Damage parameters of this Grenade",
			"parameters": [
				{
					"type": "integer",
					"name": "base_damage",
					"default": "90",
					"description": "Max damage when inner radius"
				},
				{
					"type": "integer",
					"name": "minimum_damage",
					"default": "0",
					"description": "Min damage when outer radius"
				},
				{
					"type": "integer",
					"name": "damage_inner_radius",
					"default": "200",
					"description": "Radius which damage will be 100%"
				},
				{
					"type": "integer",
					"name": "damage_outer_radius",
					"default": "1000",
					"description": "Radius which damage will be interpoled through falloff"
				},
				{
					"type": "float",
					"name": "damage_falloff",
					"default": "1",
					"description": "Lerp function between Max and Min damage"
				}
			],
			"relations": {
				"functions": [
					"GetBaseDamage",
					"GetDamageFalloff",
					"GetDamageInnerRadius",
					"GetDamageOuterRadius",
					"GetMinimumDamage"
				]
			}
		},
		{
			"authority": "server",
			"name": "SetTimeToExplode",
			"description": "Set Time until Explosion after thrown",
			"parameters": [
				{
					"type": "float",
					"name": "time",
					"description": "Time in seconds"
				}
			]
		},
		{
			"authority": "server",
			"name": "SetThrowForce",
			"description": "Set Impulse applied when throwing",
			"parameters": [
				{
					"type": "integer",
					"name": "throw_force"
				}
			]
		},
		{
			"authority": "both",
			"name": "GetBaseDamage",
			"description": "Damage at Inner Radius",
			"return": [
				{
					"type": "float",
					"name": "base_damage"
				}
			],
			"relations": {
				"functions": [
					"SetDamage"
				]
			}
		},
		{
			"authority": "both",
			"name": "GetDamageFalloff",
			"description": "Radius which BaseDamage will apply proportionally",
			"return": [
				{
					"type": "float",
					"name": "damage_falloff"
				}
			],
			"relations": {
				"functions": [
					"SetDamage"
				]
			}
		},
		{
			"authority": "both",
			"name": "GetDamageInnerRadius",
			"description": "Radius which MinimumDamage will apply",
			"return": [
				{
					"type": "float",
					"name": "damage_inner_radius"
				}
			],
			"relations": {
				"functions": [
					"SetDamage"
				]
			}
		},
		{
			"authority": "both",
			"name": "GetDamageOuterRadius",
			"description": "Radius which BaseDamage will apply",
			"return": [
				{
					"type": "float",
					"name": "damage_outer_radius"
				}
			],
			"relations": {
				"functions": [
					"SetDamage"
				]
			}
		},
		{
			"authority": "both",
			"name": "GetMinimumDamage",
			"description": "Damage at Outer Radius",
			"return": [
				{
					"type": "float",
					"name": "minimum_damage"
				}
			],
			"relations": {
				"functions": [
					"SetDamage"
				]
			}
		},
		{
			"authority": "both",
			"name": "GetTimeToExplode",
			"description": "Time until Explosion",
			"return": [
				{
					"type": "float",
					"name": "time"
				}
			]
		},
		{
			"authority": "both",
			"name": "GetThrowForce",
			"description": "Impulse applied when throwing",
			"return": [
				{
					"type": "float",
					"name": "throw_force"
				}
			]
		}
	],
	"events": [
		{
			"name": "Explode",
			"authority": "both",
			"description": "Triggered when the grenade has exploded",
			"arguments": [
				{
					"name": "self",
					"type": "Grenade",
					"description": "The grenade which exploded"
				}
			],
			"relations": {
				"functions": [
					"Explode"
				]
			}
		},
		{
			"name": "Throw",
			"authority": "both",
			"description": "Triggered when the grenade has been thrown",
			"arguments": [
				{
					"name": "self",
					"type": "Grenade",
					"description": "The grenade which exploded"
				},
				{
					"name": "handler",
					"type": "Character",
					"description": "The Character which has thrown it"
				}
			]
		}
	]
}