Eye of the Nile Docs
Everything you need to know to get started!
Loading...
Searching...
No Matches
TilemapFootstepSFX Class Reference

Detailed Description

Holds the references to the footsteps sounds this tilemap makes. For example, if an area is made of sand, you can put this script on the tilemap collider (must be a tilemap that handles collision) and have entities (with a PlayFootstepSFX script) make sand footstep sounds when walking.

Documentation updated 1/27/2025

Author
Stephen Nuttall

Public Member Functions

EventReference GetDefaultReference ()
 Returns the reference to the footstep sound that will play when the entity is walking on the ground.
 
EventReference GetJumpReference ()
 Returns the reference to the footstep sound that will play when the entity lands from a jump.
 

Private Attributes

EventReference defaultFootstep
 Reference to the footstep sound that will play when the entity is walking on the ground.
 
EventReference jumpFootstep
 Reference to the footstep sound that will play when the entity lands from a jump.
 

Member Function Documentation

◆ GetDefaultReference()

EventReference TilemapFootstepSFX.GetDefaultReference ( )

Returns the reference to the footstep sound that will play when the entity is walking on the ground.

◆ GetJumpReference()

EventReference TilemapFootstepSFX.GetJumpReference ( )

Returns the reference to the footstep sound that will play when the entity lands from a jump.

Member Data Documentation

◆ defaultFootstep

EventReference TilemapFootstepSFX.defaultFootstep
private

Reference to the footstep sound that will play when the entity is walking on the ground.

◆ jumpFootstep

EventReference TilemapFootstepSFX.jumpFootstep
private

Reference to the footstep sound that will play when the entity lands from a jump.


The documentation for this class was generated from the following file: