isSpatial.lua 560 B

12345678910111213141516171819202122232425
  1. return {
  2. tag = 'sourceEffects',
  3. summary = 'Check if the Source is spatial.',
  4. description = [[
  5. Returns whether the Source was created with the `spatial` flag. Non-spatial sources are routed
  6. directly to the speakers and can not use effects.
  7. ]],
  8. arguments = {},
  9. returns = {
  10. spatial = {
  11. type = 'boolean',
  12. description = 'Whether the source is spatial.'
  13. }
  14. },
  15. variants = {
  16. {
  17. arguments = {},
  18. returns = { 'spatial' }
  19. }
  20. },
  21. related = {
  22. 'Source:isEffectEnabled',
  23. 'Source:setEffectEnabled'
  24. }
  25. }