Module 02_ActorDef

Actor creation utilities

Functions

ResolveRelativePath (path, level) Resolve a path (Returns resolved path string)
LoadActorFunc (path, level) Load an actor template.
LoadActor (path) Load and create an actor template.
LoadFont (a, b) Function to easily create a BitmapText Actor Can be used like LoadFont("Common normal") or LoadFont("Common", "normal")
LoadColorFont (a, b) Same as LoadFont but for ColorBitmapText Actor
WrapInActorFrame (t) Returns an ActorFrame with the numeric table/array t as children

Tables

Def This is used as follows:
params Same as LoadActor but sets everything in params as "Thread Variables" accessed via Var("name")


Functions

ResolveRelativePath (path, level)
Resolve a path (Returns resolved path string)

Parameters:

  • path string
  • level number integer, call stack level for error()
LoadActorFunc (path, level)
Load an actor template.

Parameters:

  • path string
  • level number integer, call stack level for error()
LoadActor (path)
Load and create an actor template.

Parameters:

LoadFont (a, b)
Function to easily create a BitmapText Actor Can be used like LoadFont("Common normal") or LoadFont("Common", "normal")

Parameters:

  • a
  • b
LoadColorFont (a, b)
Same as LoadFont but for ColorBitmapText Actor

Parameters:

  • a
  • b
WrapInActorFrame (t)
Returns an ActorFrame with the numeric table/array t as children

Parameters:

  • t

Tables

Def
This is used as follows:

Usage:

    Def["ActorType"]({}) or Def.ActorType({})
    ex. Def.ActorFrame {}
    Note: The {} here are just syntax sugar for a function call ({})
params
Same as LoadActor but sets everything in params as "Thread Variables" accessed via Var("name") doing Var(key) in the file in path will index this table

Fields:

  • path string path to file without extension
generated by LDoc 1.4.6 Last updated 2023-01-15 03:25:11