— — — — —
— — — — —
— — — — —
— — — — —
Sidebar
set_gameplay_property
Set Gameplay Property
Sets a gameplay property to the specified value. This function allows you to modify certain mechanics at game time, specifically those found in the “Gameplay” section of the Game Configuration dialog. Refer to the table at the bottom for a list of supported property names and an explanation of their usage.
Signature:
set_gameplay_property(property_name, property_value)
| Argument | Description | Type | Required |
|---|---|---|---|
| property_name | Name of the property to change (see table below for supported properties). | String | Yes |
| property_value | New value for the property. | String, Number, Boolean | Yes |
The following properties are available to change using this function:
| Property | Description | Type |
|---|---|---|
| movement_control_type | Determines whether the player's movement is relative to the camera or uses the tank control method. Value must be “relative” or “tank”. | String |
| gravity | Determines the downward force of gravity in voxels/sec². Default value is 196. Free movement only. | Number |
| air_control | Determines how freely the player can move while in the air. Must be a decimal value from 0 to 1 (e.g. a value of 0.5 indicates that the player can move at 50% of their speed while in the air). Free movement only. | Number |
| jump_enabled | Determines if jumping is enabled. Free movement only. | Boolean |
| jump_vertical_velocity | Determines the player's initial upward velocity in voxels per second when jumping. Jumping must be enabled for this value to have an effect. | Number |
| jump_count | Determines how many times the player can jump in succession (e.g. a value of 2 would allow double jumping). Jumping must be enabled for this value to have an effect. | Number |
| free_attack_system | Possible values are “default” (player character will attack in the direction they're facing) and “cursor” (player character will attack in the direction of the mouse cursor). | String |
| camera_fov | Camera's FOV (field of view) in degrees. Value can be from 1 to 179. | Number |
| fall_damage_enabled | Determines if fall damage is enabled. Free movement only. | Boolean |
| fall_damage_min_velocity | Determines the minimum downward velocity required (in voxels/sec) before fall damage is dealt to the player. Fall damage must be enabled for this value to have an effect. | Number |
| fall_damage_base_damage | Determines the base damage that will be dealt to the player when hitting the ground at the minimum velocity. Fall damage must be enabled for this value to have an effect. | Number |
| fall_damage_excess_damage | Determines additional damage (per voxel/sec over the minimum velocity) that will be dealt to the player when hitting the ground. Fall damage must be enabled for this value to have an effect. | Number |
| fall_damage_max_velocity | Determines the velocity (in voxels/sec) at which no additional fall damage will be added, therefore capping the total possible damage. Fall damage must be enabled for this value to have an effect. | Number |
| fall_damage_max_critical | If enabled, the player will be automatically killed when hitting the ground at or above the maximum velocity. Fall damage must be enabled for this value to have an effect. | Boolean |
Example:
Results:
Use the Set Gameplay Property function to give the player the power to double jump when picking up or equipping jump boots in a free movement game.
Editor Node:
set_gameplay_property.txt · Last modified: 2024/09/02 20:24 by justin
