Skip to content

class World (client-side)

Available since version: 0.2.0

This class represents game world.

Properties

string fileName

Available since version: 0.2.0

Represents full name of world file (with extension), placed into _Work/Data/Worlds.

string name

Available since version: 0.2.0

Represents name of world.

const zlistsort& vobs

Available since version: 0.2.0

Represents list of vobs available in selected world.

bool showWaynet

Available since version: 0.2.0

Enables debug information about waynet in selected world.

bool showZonesDebugInfo

Available since version: 0.2.0

Enables debug information about zones in selected world.

Methods

searchVobByName

Available since version: 0.2.0

This method will search for vob by it's object name in selected world.

userdata searchVobByName(string objectName)

Parameters:

  • string objectName: the name of the vob object.

Returns userdata:

address the address of found vob.

searchVobListByName

Available since version: 0.2.0

This method will search for vobs with given object name in selected world.

array[userdata] searchVobListByName(string objectName)

Parameters:

  • string objectName: the name of the vob object.

Returns array[userdata]:

addresses the array of found vobs.

traceRayFirstHit

Available since version: 0.2.0

This method will cast a ray from origin point in direction, against all colliders specified by the flags and returns first intersection result.

null|TraceRayReport traceRayFirstHit(Vec3 origin, Vec3 direction, int flags)

Parameters:

  • Vec3 origin: the starting point of ray in world coordinates.
  • Vec3 direction: the direction of the ray.
  • int flags: the flags defining which colliders can ray intersect (e.g: poly, vob, npc, bbox). For more information see TraceRay Constants.

Returns null|TraceRayReport:

report containing results of ray intersection, or null on failure. For more information see TraceRayReport.

traceRayNearestHit

Available since version: 0.2.0

This method will cast a ray from origin point in direction, against all colliders specified by the flags and returns nearest intersection result.

null|TraceRayReport traceRayNearestHit(Vec3 origin, Vec3 direction, int flags)

Parameters:

  • Vec3 origin: the starting point of ray in world coordinates.
  • Vec3 direction: the direction of the ray.
  • int flags: the flags defining which colliders can ray intersect (e.g: poly, vob, npc, bbox). For more information see TraceRay Constants.

Returns null|TraceRayReport:

report containing results of ray intersection, or null on failure. For more information see TraceRayReport.