Difference between revisions of "Flutter Lua API"

From Off Grid Wiki
Jump to navigation Jump to search
m
 
Line 72: Line 72:
 
This file is auto generated, please don't edit manually!
 
This file is auto generated, please don't edit manually!
  
'''Docs last hacked together on''': 15/11/2019 14:59
+
'''Docs last hacked together on''': 23/07/2020 11:58
 
[[Category:Modding]][[Category:LuaAPI]]
 
[[Category:Modding]][[Category:LuaAPI]]

Latest revision as of 12:34, 23 July 2020

Flutter

Description

The Flutter API allows modders to send Flutter messages

Tables

FlutterMessage

Table definition

Name Type Default Optional Description
message string No Content string for the message
hashTags table No custom hash tags for the message
tags table No metadata tags
metadata table No metadata values

Functions

SendMessageFromCharacter

Flutter.SendMessageFromCharacter(message, internalName)

Expected parameter types

Name Type
message Lua Type
internalName string

Description: Sends a custom FlutterMessage from NPC in current level

Returns: Nothing

SendRandomMessageFromCharacter

Flutter.SendRandomMessageFromCharacter(internalName)

Expected parameter types

Name Type
internalName string

Description: Sends a generated Flutter message from NPC in current level

Returns: Nothing

SendRandomMessage

Flutter.SendRandomMessage()

Description: Sends a generated Flutter message from generated random character

Returns: Nothing

SetFlutterEnabled

Flutter.SetFlutterEnabled(enabled)

Expected parameter types

Name Type
enabled bool

Description: Set Flutter app enabled or disabled.

Returns: Nothing


This file is auto generated, please don't edit manually!

Docs last hacked together on: 23/07/2020 11:58