gimm350-VRClassProject-Godot/addons/godot-xr-tools/audio/surface_audio_type.gd

42 lines
1.1 KiB
GDScript

@tool
@icon("res://addons/godot-xr-tools/editor/icons/body.svg")
class_name XRToolsSurfaceAudioType
extends Resource
## XRTools Surface Type Resource
##
## This resource defines a type of surface, and the audio streams to play when
## the user steps on it
## Surface name
@export var name : String = ""
## Optional audio stream to play when the player jumps on this surface
@export var jump_sound : AudioStream
## Optional audio stream to play when the player lands on this surface
@export var hit_sound : AudioStream
## Audio streams to play when the player walks on this surface
@export var walk_sounds :Array[AudioStream] = []
## Walking sound minimum pitch (to randomize steps)
@export_range(0.5, 1.0) var walk_pitch_minimum : float = 0.8
## Walking sound maximum pitch (to randomize steps)
@export_range(1.0, 2.0) var walk_pitch_maximum : float = 1.2
# This method checks for configuration issues.
func _get_configuration_warnings() -> PackedStringArray:
var warnings := PackedStringArray()
# Verify the camera
if name == "":
warnings.append("Surface audio type must have a name")
# Return warnings
return warnings