cca plugin

Implements hook AddCombinePDAButons

Called when a PDA player card is created; adds the status, residence, job, points and jail buttons.

Each button opens a prompt and passes the answer to the matching Handle... hook through plugin.Call. Points and jail buttons are flagged Combine only, and CWU players can only pick the Unverified and Citizen statuses.

Parameters

• pda Panel The cwCombinePlayerCard panel

Registers how a type of civil record entry is displayed.

cca.AddLogType('jail', {
  color = Color(240, 130, 130),
  important = true
})

Parameters

• type String Name of the entry type, as passed to cca.AppendLog
• data Map Display options: color (Color of the entry) and important (Boolean, highlights the entry)

See also

• cca.GetLogType

Adds an entry to a player's civil record.

The record is stored in the CCA_Logs character data and networked to clients as the CCA_Logs net var; only its newest 50 entries are kept. On the server a valid appender is told to refresh their PDA. Does nothing when player is not valid.

cca.AppendLog(officer, citizen, L('PDA_Log_Jail'), 'jail')

Parameters

• appender Player The player who writes the entry; entries without a valid player are signed by Overwatch
• player Player The player whose record gets the entry
• entry String Text of the entry
• type String Entry type, registered with cca.AddLogType

Returns the display options of a civil record entry type.

Parameters

• type String Name of the entry type

Returns

• Map The type's options, or those of the default type when it is not registered

Implements hook HandleCitizenStatusButton

Called when a citizen status is picked on a PDA player card; asks the server to set it.

Parameters

• panel Panel The cwCombinePlayerCard panel; its player field is the target
• id String The status: Unverified, Citizen, AntiCitizen or NoData

Implements hook HandleCrimePointsIssue

Called when crime points are issued on a PDA player card; asks the server to add them.

Parameters

• panel Panel The cwCombinePlayerCard panel; its player field is the target
• value Number The points to add

Implements hook HandleCrimePointsSubstract

Called when crime points are removed on a PDA player card; asks the server to remove them.

Parameters

• panel Panel The cwCombinePlayerCard panel; its player field is the target
• value Number The change, as a negative number

Implements hook HandleJailButton

Called when jailing is confirmed on a PDA player card; asks the server to jail the target.

Parameters

• panel Panel The cwCombinePlayerCard panel; its player field is the target

Implements hook HandleJobChangeButton

Called when a new job is entered on a PDA player card; asks the server to set it.

Parameters

• panel Panel The cwCombinePlayerCard panel; its player field is the target
• value String The new job

Implements hook HandleJobPointsIssue

Called when work points are issued on a PDA player card; asks the server to add them.

Parameters

• panel Panel The cwCombinePlayerCard panel; its player field is the target
• value Number The points to add

Implements hook HandleLoyaltyPointsIssue

Called when loyalty points are issued on a PDA player card; asks the server to add them.

Parameters

• panel Panel The cwCombinePlayerCard panel; its player field is the target
• value Number The points to add

Implements hook HandleLoyaltyPointsSubstract

Called when loyalty points are removed on a PDA player card; asks the server to remove them.

Parameters

• panel Panel The cwCombinePlayerCard panel; its player field is the target
• value Number The change, as a negative number

Implements hook HandleResidenceChangeButton

Called when a new residence is entered on a PDA player card; asks the server to set it.

Parameters

• panel Panel The cwCombinePlayerCard panel; its player field is the target
• value String The new residence address

Implements hook HandleUnjailButton

Called when unjailing is confirmed on a PDA player card; asks the server to release the target.

Parameters

• panel Panel The cwCombinePlayerCard panel; its player field is the target

Implements hook MenuItemsAdd

Called when the main menu items are added; adds the Combine PDA for Combine and CWU players.

Parameters

• menuItems Map The menu item list, with an Add method

Implements hook PlayerCharacterLoaded

Called when a player's character has loaded; networks the character's civil record.

Parameters

• player Player The player whose character loaded

Drops the oldest entries of a civil record until it holds no more than 50.

Parameters

• logs List The record, oldest entry first; changed in place

Returns

• List The same record