Skip to content
OzDeaDMeaT edited this page Feb 19, 2015 · 5 revisions

Below is a list of CMM functions and a brief outline of what they do:

/* Name: CMM_PLAYER_STARTUP Author: OzDeaDMeaT Description: Initialization for Players in CMM enabled missions Must spawn: YES Usage Example: player spawn CMM_PLAYER_STARTUP;

Parameters:
    Index		Type		Variable		Notes
	0 			OBJECT		_player			Player Object

Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_ENTRYTITLE Author: OzDeaDMeaT Description: Player Mission Entry Title sequence Must spawn: NO Usage Example: call CMM_ENTRYTITLE;

Parameters:
    Index		Type		Variable		Notes

Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_TITLEDAYS Author: OzDeaDMeaT Description: Title for day number change. Shows date and Day Count Must spawn: NO Usage Example: call CMM_TITLEDAYS;

Parameters:
    Index		Type		Variable		Notes

Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_MOVEMARKER Author: OzDeaDMeaT Description: Moves Markers around based on particular object location. (Primarily used for Zeus Objects) Must spawn: YES Usage Example: ["STRING",OBJECT,ANY] spawn CMM_MOVEMARKER;

Parameters:
    Index		Type		Variable		Notes
	0			STRING		_marker			Marker Name
	1			OBJECT		_Object			Object for marker to track
	2			ANY			_LOCAL			Sets markers as local markers only
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_SERVERMARKERPROCESS Author: OzDeaDMeaT Description: Server Marker Process for updating Active Players and Day Marker Must spawn: YES Usage Example: spawn CMM_SERVERMARKERPROCESS;

Parameters:
    Index		Type		Variable		Notes
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_FORMATDATE Author: OzDeaDMeaT Description: Moves Markers around based on particular object location. (Primarily used for Zeus Objects) Must spawn: YES Usage Example: [YEAR,MONTH,DAY,HOUR,MINUTE] spawn CMM_MOVEMARKER;

Parameters:
    Index				Type				Variable				Notes
	0					INTEGER				_Year					Year
	1					INTEGER				_Month					Month
	2					INTEGER				_Day					Day
	3					INTEGER				_Hours					Hours
	4					INTEGER				_Minutes				Minutes
	
Return:
						STRING				_FormattedTime			Nicely formatted Text for date description

/ / Name: CMM_COUNTDAYS Author: Heeeere's Johnny!, adapted from an idea by OzDeaDMeaT Description: Calculates the difference in days between two given dates, taking in account leap years. Must spawn: No Usage Example: STARTDATE],[ENDDATE spawn CMM_COUNTDAYS;

Parameters:
    0 ARRAY     dateStart	start date in format [year, month, day]
    1 ARRAY     dateEnd		end date in format [year, month, day]

Return:
    INTEGER		daysTotal	difference in days between the given dates

/ / Name: CMM_GETPARTDMG Author: OzDeaDMeaT Description: Reports Object Parts Damage in Array Format Must spawn: NO Usage Example: OBJECT call CMM_GETPARTDMG;

Parameters:
    Index				Type				Variable				Notes
	0					OBJECT				_this					Object to collect damage information on
	
Return:
						ARRAY				_array					Array = [[PART1,DMG],[PART2,DMG]]

/ / Name: CMM_SETPARTDMG Author: OzDeaDMeaT Description: Sets Object Parts Damage from Array Must spawn: NO Usage Example: [Vehicle,[CMM_GETPARTDMGArray]] call CMM_SETPARTDMG

Parameters:
    Index				Type				Variable				Notes
	0					OBJECT				_obj					Object to set damage information on
	1					ARRAYS				_array					Array from CMM_GETPARTDMG
	
Return:
						BOOL				true					Returns true when function is complete

/ / Name: CMM_MAGCARGOLOAD Author: OzDeaDMeaT Description: Loads magazines into crates or Vehicles Must spawn: NO Usage Example: [,MAGName],[Quantity] call CMM_MAGCARGOLOAD

Parameters:
    Index				Type				Variable				Notes
	0					OBJECT				_crate					Object to add magazine cargo to
	1					ARRAY										[CLASSNAME,AMOUNT]
	
Return:
						BOOL				true					Returns true when function is complete

/ / Name: CMM_WPNCARGOLOAD Author: OzDeaDMeaT Description: Sets weapon cargo from array Must spawn: NO Usage Example: [,WeaponName],[QuantityArray] call CMM_WPNCARGOLOAD

Parameters:
    Index				Type				Variable				Notes
	0					OBJECT				_crate					Object to add weapon cargo to
	1					ARRAY										[CLASSNAME,AMOUNT]
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_ITMCARGOLOAD Author: OzDeaDMeaT Description: Sets item cargo from array Must spawn: NO Usage: [,ItemName],[Quantity] call CMM_ITMCARGOLOAD

Parameters:
    Index				Type				Variable				Notes
	0					OBJECT				_crate					Object to add item cargo to
	1					ARRAY										[CLASSNAME,AMOUNT]
	
Return:
						BOOL				true					Returns true when function is complete

/ / Name: CMM_BKPCARGOLOAD Author: OzDeaDMeaT Description: Sets Backpack cargo from array Must spawn: NO Usage: [,ItemName],[Quantity] call CMM_BKPCARGOLOAD

Parameters:
    Index				Type				Variable				Notes
	0					OBJECT				_crate					Object to add backpack cargo to
	1					ARRAY										[CLASSNAME,AMOUNT]
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_VEHICLEADD Author: OzDeaDMeaT Description: Adds vehicle to Vehicle backup array Must spawn: NO Usage: vehicle call CMM_VEHICLEADD

Parameters:
    Index				Type				Variable				Notes
	0					OBJECT				_this					Vehicle Object
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_OBJECTADD Author: OzDeaDMeaT Description: Adds object to Object backup array Must spawn: NO Usage: object call CMM_OBJECTADD

Parameters:
    Index		Type		Variable		Notes
	0 			OBJECT		_this			Object to add to array

Return:
				BOOL		_check			Returns true when function is complete

/ / Name: CMM_VEHICLEREMOVE Author: OzDeaDMeaT Description: Removes vehicle from backup array Must spawn: NO Usage: object call CMM_VEHICLEREMOVE

Parameters:
    Index		Type		Variable		Notes
	0 			Object		_this			Object to remove from array

Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_OBJECTREMOVE Author: OzDeaDMeaT Description: Removes Object from backup array Must spawn: NO Usage: object call CMM_OBJECTREMOVE

Parameters:
    Index		Type		Variable		Notes
	0 			Object		_this			Object to remove from array

Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_MARKERADD Author: OzDeaDMeaT Description: Adds Markers to backup markers backup array Must spawn: NO Usage: Marker call CMM_MARKERADD

Parameters:
    Index		Type		Variable		Notes
	0 			STRING		_this			Marker to remove from backup array	

Return:
				BOOL		_check			Returns true when function is complete

/ / Name: CMM_MARKERREMOVE Author: OzDeaDMeaT Description: Removes Markers from backup markers array Must spawn: NO Usage: Marker call CMM_MARKERREMOVE

Parameters:
    Index		Type		Variable		Notes
	0 			String			_this				Marker to remove from backup array

Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_DEDUPARRAY Author: OzDeaDMeaT Description: Removes duplicate entries in array Must spawn: NO Usage Example: call CMM_GETCFGVEHICLE

Parameters:
    Index		Type		Variable		Notes
	1			ARRAY		_array			Array of Items
	
Return:
				ARRAY		_unduplicated	Returns an array without duplicates

/ / Name: CMM_GETCFGVEHICLE Author: OzDeaDMeaT Description: Adds Zeus Curator marker object to Backup DB Must spawn: NO Usage Example: call CMM_GETCFGVEHICLE

Parameters:
    Index		Type		Variable		Notes
	1			STRING		_mkr			Vehicle Object
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_CURATORMARKERPLACED Author: OzDeaDMeaT Description: Adds Zeus Curator marker object to Backup DB Must spawn: NO Usage Example: object call CMM_CURATORMARKERPLACED

Parameters:
    Index		Type		Variable		Notes
	1			STRING		_mkr			Vehicle Object
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_CURATORMARKERREMOVE Author: OzDeaDMeaT Description: Zeus Curator marker removed, removes marker from Backup DB Must spawn: NO Usage Example: Marker call CMM_CURATORMARKERREMOVE

Parameters:
    Index		Type		Variable		Notes
	1			STRING		_mkr			Marker
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_CURATOROBJECTPLACED Author: OzDeaDMeaT Description: Zeus Curator object removed removes object from Backup DB Must spawn: NO Usage Example: object call CMM_CURATOROBJECTREMOVE

Parameters:
    Index		Type		Variable		Notes
	1			OBJECT		_veh			Vehicle Object
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_CURATOROBJECTREMOVE Author: OzDeaDMeaT Description: Zeus Curator object removed removes object from Backup DB Must spawn: NO Usage Example: object call CMM_CURATOROBJECTREMOVE

Parameters:
    Index		Type		Variable		Notes
	1			OBJECT		_veh			Vehicle Object
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_CRATEADD Author: OzDeaDMeaT Description: Removes crate from backup array Must spawn: NO Usage Example: crate call CMM_CRATEREMOVE

Parameters:
    Index		Type		Variable		Notes
	0			OBJECT		_this			Crate Object
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_CRATEREMOVE Author: OzDeaDMeaT Description: Removes crate from backup array Must spawn: NO Usage Example: crate call CMM_CRATEREMOVE

Parameters:
    Index		Type		Variable		Notes
	0			OBJECT		_this			Crate Object
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_JIP_ADDCRATEACTION Author: OzDeaDMeaT Description: Adds Actions to Crates for players Joining in Progress Must spawn: NO Usage Example: call CMM_JIP_ADDCRATEACTION

Parameters:
    Index		Type		Variable		Notes
	
Return:
				ARRAY		_output			Returns Array of equipment / weapons

/ / Name: CMM_ADDCRATEACTION Author: OzDeaDMeaT Description: Adds Actions to Crate Must spawn: NO Usage Example: crate call CMM_ADDCRATEACTION

Parameters:
    Index		Type		Variable		Notes
	0			OBJECT		_crate			_crate Object
	
Return:
				ARRAY		_output			Returns Array of equipment / weapons

/ / Name: CMM_PLAYERGEARARRAY Author: OzDeaDMeaT Description: Formats array of current players loadout Must spawn: NO Usage Example: [crate,player] call CMM_PLAYERGEARARRAY (excludes uniform and assigned items)

Parameters:
    Index		Type		Variable		Notes
	0			OBJECT		_player			Player Object
	
Return:
				ARRAY		_output			Returns Array of equipment / weapons

/ / Name: CMM_STRIPPLAYER Author: OzDeaDMeaT Description: Removes weapons and items from player leaving Assigned Items (excludes Assigned Item weapons - e.g. Binoculars) Must spawn: NO Usage Example: player call CMM_STRIPPLAYER;

Parameters:
    Index		Type		Variable		Notes
	0			OBJECT		_player			Player Object
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_RETURNEQUIPMENT Author: OzDeaDMeaT Description: This Function dumps all inventory of a player including weapons (This includes binoculars Item Slot) Must spawn: YES Usage Example: [ammobox1,Unit123] call CMM_RETURNEQUIPMENT;

Parameters:
    Index		Type		Variable		Notes
	0			OBJECT		_crate			Crate Object
	1			OBJECT		_unit			Player Object
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_GETGEAR Author: OzDeaDMeaT Description: Retrieves loadout from profileNameSpace Must spawn: NO Usage Example: [ammobox1,Unit123] call CMM_GETGEAR;

Parameters:
    Index		Type		Variable		Notes
	0			OBJECT		_arsenal		Crate Object
	1			OBJECT		_unit			Player Object
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_SETGEAR Author: OzDeaDMeaT Description: Saves loadout to profileNameSpace Must spawn: NO Usage Example: [ammobox1,Unit123] call CMM_SETAPPEARANCE;

Parameters:
    Index		Type		Variable		Notes
	0			OBJECT		_arsenal		Crate Object
	1			OBJECT		_unit			Player Object
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_SETAPPEARANCE Author: OzDeaDMeaT Description: Opens Arsenal Crate to allow player to change Appearance Must spawn: NO Usage Example: [ammobox1,Unit123] call CMM_SETAPPEARANCE;

Parameters:
    Index		Type		Variable		Notes
	0			OBJECT		_arsenal		Crate Object
	1			OBJECT		_unit			Player Object
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_SETPLAYERRANK Author: OzDeaDMeaT Description: Sets Player Rank Must spawn: NO Usage Example: [player,"RankName"] call CMM_SETPLAYERRANK;

Parameters:
    Index		Type		Variable		Notes
	0			OBJECT		_player			Player Object
	1			STRING		_rankName		Rank Name for new Player Object Rank
	
Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_CHECKRANK Author: OzDeaDMeaT Description: Shows Player Statistics Must spawn: NO Usage Example: call CMM_SHOWMYSCORE;

Parameters:
    Index		Type		Variable		Notes

Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_SHOWMYSCORE Author: OzDeaDMeaT Description: Shows Player Statistics Must spawn: NO Usage Example: call CMM_SHOWMYSCORE;

Parameters:
    Index		Type		Variable		Notes

Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_SHOWSERVERSCORE Author: OzDeaDMeaT Description: Shows Server Statistics Must spawn: NO Usage Example: call CMM_SHOWSERVERSCORE;

Parameters:
    Index		Type		Variable		Notes

Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_SERVERDEATHCOUNT Author: OzDeaDMeaT Description: Utilized when a player dies. Adds 1 Death and removes 1 Life Must spawn: NO Usage Example: call CMM_SERVERDEATHCOUNT;

Parameters:
    Index		Type		Variable		Notes

Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_ADDDEATH Author: OzDeaDMeaT Description: Adds a Death from the Current Mission Deaths Must spawn: NO Usage Example: call CMM_ADDDEATH;

Parameters:
    Index		Type		Variable		Notes

Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_REMOVEDEATH Author: OzDeaDMeaT Description: Removes a Death from the Current Mission Deaths Must spawn: NO Usage Example: call CMM_REMOVEDEATH;

Parameters:
    Index		Type		Variable		Notes

Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_ADDLIFE Author: OzDeaDMeaT Description: Adds a Life from the Life Pool Must spawn: NO Usage Example: call CMM_ADDLIFE;

Parameters:
    Index		Type		Variable		Notes

Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_REMOVELIFE Author: OzDeaDMeaT Description: Removes a Life from the Life Pool Must spawn: NO Usage Example: call CMM_REMOVELIFE;

Parameters:
    Index		Type		Variable		Notes

Return:
				BOOL		true			Returns true when function is complete

/ / Name: CMM_MOVEZEUS Author: OzDeaDMeaT Description: Moves Objects to location of Return Object Must spawn: NO Usage Example: player call CMM_MOVEZEUS;

Parameters:
    Index		Type		Variable		Notes
	0 			OBJECT		_zeusPlayer		Object

Return:
				BOOL		true			Returns true when function is complete

*/

Clone this wiki locally