cp.config.shutdownCallback

Shutdown Callback Module.

---

API Overview

Methods - API calls which can only be made on an object returned by a constructor

• callbackFn
• get
• getAll
• id
• new

---

API Documentation

Methods

callbackFn

Signature	cp.config.shutdownCallback:callbackFn() -> function
Type	Method
Description	Returns the callbackFn of the current Shutdown Callback
Parameters	None
Returns	The callbackFn of the current Shutdown Callback
Notes	None
Examples	None
Source	src/extensions/cp/config/init.lua line 403

---

get

Signature	cp.config.shutdownCallback:get(id) -> table
Type	Method
Description	Creates a new Shutdown Callback.
Parameters	id - The unique ID for the callback you want to return.
Returns	table containing the callback
Notes	None
Examples	None
Source	src/extensions/cp/config/init.lua line 364

---

getAll

Signature	cp.config.shutdownCallback:getAll() -> table
Type	Method
Description	Returns all of the created Shutdown Callbacks
Parameters	None
Returns	table containing all of the created callbacks
Notes	None
Examples	None
Source	src/extensions/cp/config/init.lua line 377

---

id

Signature	cp.config.shutdownCallback:id() -> string
Type	Method
Description	Returns the ID of the current Shutdown Callback
Parameters	None
Returns	The ID of the current Shutdown Callback as a string
Notes	None
Examples	None
Source	src/extensions/cp/config/init.lua line 390

---

new

Signature	cp.config.shutdownCallback:new(id, callbackFn) -> table
Type	Method
Description	Creates a new Shutdown Callback.
Parameters	id - The unique ID for this callback. callbackFn - The callback function
Returns	table that has been created
Notes	None
Examples	None
Source	src/extensions/cp/config/init.lua line 337

---

---