Template:Lua global function signature/doc

About the Template

Show the lua global function signature defined by Template:Lua global function parameters and Template:Lua global function returns.

Usage

{{Lua global function signature}}

Example

{{Lua global function parameters
| function_name = PhysicsAddBodyImage
| param_name_1 = entity_id
| param_name_2 = image_file
| param_name_3 = material
| param_name_4 = offset_x
| param_name_5 = offset_y
| param_name_6 = centered
| param_name_7 = is_circle
| param_name_8 = material_image_file
| param_type_4 = number
| param_type_5 = number
| param_type_6 = bool
| param_type_7 = bool
| param_default_4 = 0
| param_default_5 = 0
| param_default_6 = false
| param_default_7 = false
}}
{{Lua global function returns
| return_name_1 = succ
| return_type_1 = bool
| return_name_2 = image
}}
{{Lua global function signature}}

Results in:

bool succ, image = PhysicsAddBodyImage(entity_id, image_file, material, number offset_x = 0, number offset_y = 0, bool centered = false, bool is_circle = false, material_image_file)

---

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.