Category:Lua Callbacks

From Fortress Forever Wiki
Jump to navigationJump to search


Mapping for FF
The Basics

Setting up Hammer
Getting Started With Lua
Releasing a map

FF-specific Entities

Lua location system

Map Templates
FF Lua Documentation

Entity Typing
Entity Collections

Commands
Callbacks

Callbacks are user-defined functions which are activated by events in the game. The lua script can change the outcome of these events, or simply use the event as a cue to run some other code. Access to events is typically in the following format:

item = entity:new({
   data0 = 0,
   data1 = 0,
})

function item:eventname( parameters )
  --What to do when this method is called
  --return anything, if necessary
end

Different methods may provide data by passing on a number of parameters. The types of these parameters, returned values and examples of usage can be found on their respective pages.

Entity Outputs

The lua system can catch any entity output from [Source's I/O system] and run lua code. For example, func_breakable:onbreak() can be used to detect when an item breaks.