CyberM.vfx

Runs inside the game process. Reads and presentation are local; anything that changes shared state has to go through the server.

client runtime6 functionsMarkdown

catalog

GAME

CyberM.vfx.catalog()

Returns the curated stable world-VFX aliases and cooked paths.

Catalog access does not start an effect. Raw cooked paths remain build-dependent even when present.

Returns

  • table mapping alias to effect path, or nil
  • reason

Registered in ResourceHost.cpp as LuaVfxCatalog (line 6814).

clear

GAME

CyberM.vfx.clear()

Stops every VFX owned by the calling resource.

Requires world.effects; SFX and other resource owners are unaffected.

Returns

  • true on success, otherwise false
  • reason

Registered in ResourceHost.cpp as LuaEffectClear (line 6809).

list

GAME

CyberM.vfx.list()

Lists active VFX owned by the calling resource.

Requires world.effects.

Returns

  • array of { id, kind, name, entity, remaining }, or nil
  • reason

Registered in ResourceHost.cpp as LuaEffectList (line 6812).

play

GAME

CyberM.vfx.play(effect, options)

Starts a resource-owned world VFX at a fixed transform.

Requires world.effects. options requires position and accepts orientation, duration, and ignoreTimeDilation. The effect is released automatically with its owner.

Parameters

  • effectstringrequired
  • optionstablerequired

Returns

  • effect handle string, or nil
  • reason

Registered in ResourceHost.cpp as LuaVfxPlay (line 6805).

playEntity

GAME

CyberM.vfx.playEntity(effect, [options])

Starts a resource-owned authored VFX on an entity.

Requires world.effects. Options accept entity, instance, persistOnDetach, breakAllLoops, breakAllOnDestroy, and duration; omitting entity targets the local player.

Parameters

  • effectstringrequired
  • optionstableoptional

Returns

  • effect handle string, or nil
  • reason

Registered in ResourceHost.cpp as LuaVfxPlayEntity (line 6806).

stop

GAME

CyberM.vfx.stop(id)

Stops one VFX handle owned by the calling resource.

Requires world.effects.

Parameters

  • idstringrequired

Returns

  • true on success, otherwise false
  • reason

Registered in ResourceHost.cpp as LuaEffectStop (line 6807).

For agents and LLMs: this page as Markdown · llms.txt · llms-full.txt