Skip to content

WLD - world manipulation functions

Functions related to the world.

Wld_ChangeLevel

Wld_ChangeLevel

Trigger level change.

func void Wld_ChangeLevel( var string world, var string waypoint ) {};
  • world - name of the world
  • waypoint - target waypoint

Wld_FindVob

Wld_FindVob

Return the VOB instance based on its name.

func instance Wld_FindVob( var string vobname ) {};
  • vobname - name of the vob
  • return - zCVob pointer

Wld_PlayEffectVob

Wld_PlayEffectVob

Play a visual effect at specified vob

1
2
3
4
5
6
func void Wld_PlayEffectVob(    var string effect,
                                var instance pvob,
                                var int level,
                                var int damage,
                                var int damage_type,
                                var int damage_speed ) {};
  • effect - effect name
  • pvob - zCVob to play the effect at
  • level - effect level
  • damage - damage amount
  • damage_type - damage type
  • damage_speed - damage interval

Wld_PlayEffectAt

Wld_PlayEffectAt

Play a visual effect at specified world coordinates

1
2
3
4
5
6
func void Wld_PlayEffectAt( var string effect,
                            var instance coord,
                            var int level,
                            var int damage,
                            var int damage_type,
                            var int damage_speed ) {};
  • effect - effect name
  • coord - world coordinates (zVEC3) to play the effect at
  • level - effect level
  • damage - damage amount
  • damage_type - damage type
  • damage_speed - damage interval

Wld_ToggleRain

Wld_ToggleRain

Turns on the rain

func void Wld_ToggleRain( var float weight, var float time ) {};
  • weight - the strength of the rain
  • time - rain duration

Wld_SetWeatherType

Wld_SetWeatherType

Sets the weather type. Types:

0 - snow 1 - rain

func void Wld_SetWeatherType( var int type ) {};
  • type - weather type

Wld_GetWeatherType

Wld_GetWeatherType

Returns the weather type. Types:

0 - snow 1 - rain

func int Wld_GetWeatherType() {};
  • return - weather type