Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
ScriptAction Class Reference

#include <Scripts.h>

Inherits MemoryPoolObject.

Public Types

enum  ScriptActionType {
  DEBUG_MESSAGE_BOX , SET_FLAG , SET_COUNTER , VICTORY ,
  DEFEAT , NO_OP , SET_TIMER , PLAY_SOUND_EFFECT ,
  ENABLE_SCRIPT , DISABLE_SCRIPT , CALL_SUBROUTINE , PLAY_SOUND_EFFECT_AT ,
  DAMAGE_MEMBERS_OF_TEAM , MOVE_TEAM_TO , MOVE_CAMERA_TO , INCREMENT_COUNTER ,
  DECREMENT_COUNTER , MOVE_CAMERA_ALONG_WAYPOINT_PATH , ROTATE_CAMERA , RESET_CAMERA ,
  SET_MILLISECOND_TIMER , CAMERA_MOD_FREEZE_TIME , SET_VISUAL_SPEED_MULTIPLIER , CREATE_OBJECT ,
  SUSPEND_BACKGROUND_SOUNDS , RESUME_BACKGROUND_SOUNDS , CAMERA_MOD_SET_FINAL_ZOOM , CAMERA_MOD_SET_FINAL_PITCH ,
  CAMERA_MOD_FREEZE_ANGLE , CAMERA_MOD_SET_FINAL_SPEED_MULTIPLIER , CAMERA_MOD_SET_ROLLING_AVERAGE , CAMERA_MOD_FINAL_LOOK_TOWARD ,
  CAMERA_MOD_LOOK_TOWARD , TEAM_ATTACK_TEAM , CREATE_REINFORCEMENT_TEAM , MOVE_CAMERA_TO_SELECTION ,
  TEAM_FOLLOW_WAYPOINTS , TEAM_SET_STATE , MOVE_NAMED_UNIT_TO , NAMED_ATTACK_NAMED ,
  CREATE_NAMED_ON_TEAM_AT_WAYPOINT , CREATE_UNNAMED_ON_TEAM_AT_WAYPOINT , NAMED_APPLY_ATTACK_PRIORITY_SET , TEAM_APPLY_ATTACK_PRIORITY_SET ,
  SET_BASE_CONSTRUCTION_SPEED , NAMED_SET_ATTITUDE , TEAM_SET_ATTITUDE , NAMED_ATTACK_AREA ,
  NAMED_ATTACK_TEAM , TEAM_ATTACK_AREA , TEAM_ATTACK_NAMED , TEAM_LOAD_TRANSPORTS ,
  NAMED_ENTER_NAMED , TEAM_ENTER_NAMED , NAMED_EXIT_ALL , TEAM_EXIT_ALL ,
  NAMED_FOLLOW_WAYPOINTS , NAMED_GUARD , TEAM_GUARD , NAMED_HUNT ,
  TEAM_HUNT , PLAYER_SELL_EVERYTHING , PLAYER_DISABLE_BASE_CONSTRUCTION , PLAYER_DISABLE_FACTORIES ,
  PLAYER_DISABLE_UNIT_CONSTRUCTION , PLAYER_ENABLE_BASE_CONSTRUCTION , PLAYER_ENABLE_FACTORIES , PLAYER_ENABLE_UNIT_CONSTRUCTION ,
  CAMERA_MOVE_HOME , BUILD_TEAM , NAMED_DAMAGE , NAMED_DELETE ,
  TEAM_DELETE , NAMED_KILL , TEAM_KILL , PLAYER_KILL ,
  DISPLAY_TEXT , CAMEO_FLASH , NAMED_FLASH , TEAM_FLASH ,
  MOVIE_PLAY_FULLSCREEN , MOVIE_PLAY_RADAR , SOUND_PLAY_NAMED , SPEECH_PLAY ,
  PLAYER_TRANSFER_OWNERSHIP_PLAYER , NAMED_TRANSFER_OWNERSHIP_PLAYER , PLAYER_RELATES_PLAYER , RADAR_CREATE_EVENT ,
  RADAR_DISABLE , RADAR_ENABLE , MAP_REVEAL_AT_WAYPOINT , TEAM_AVAILABLE_FOR_RECRUITMENT ,
  TEAM_COLLECT_NEARBY_FOR_TEAM , TEAM_MERGE_INTO_TEAM , DISABLE_INPUT , ENABLE_INPUT ,
  PLAYER_HUNT , SOUND_AMBIENT_PAUSE , SOUND_AMBIENT_RESUME , MUSIC_SET_TRACK ,
  SET_TREE_SWAY , DEBUG_STRING , MAP_REVEAL_ALL , TEAM_GARRISON_SPECIFIC_BUILDING ,
  EXIT_SPECIFIC_BUILDING , TEAM_GARRISON_NEAREST_BUILDING , TEAM_EXIT_ALL_BUILDINGS , NAMED_GARRISON_SPECIFIC_BUILDING ,
  NAMED_GARRISON_NEAREST_BUILDING , NAMED_EXIT_BUILDING , PLAYER_GARRISON_ALL_BUILDINGS , PLAYER_EXIT_ALL_BUILDINGS ,
  TEAM_WANDER , TEAM_PANIC , SETUP_CAMERA , CAMERA_LETTERBOX_BEGIN ,
  CAMERA_LETTERBOX_END , ZOOM_CAMERA , PITCH_CAMERA , CAMERA_FOLLOW_NAMED ,
  OVERSIZE_TERRAIN , CAMERA_FADE_ADD , CAMERA_FADE_SUBTRACT , CAMERA_FADE_SATURATE ,
  CAMERA_FADE_MULTIPLY , CAMERA_BW_MODE_BEGIN , CAMERA_BW_MODE_END , DRAW_SKYBOX_BEGIN ,
  DRAW_SKYBOX_END , SET_ATTACK_PRIORITY_THING , SET_ATTACK_PRIORITY_KIND_OF , SET_DEFAULT_ATTACK_PRIORITY ,
  CAMERA_STOP_FOLLOW , CAMERA_MOTION_BLUR , CAMERA_MOTION_BLUR_JUMP , CAMERA_MOTION_BLUR_FOLLOW ,
  CAMERA_MOTION_BLUR_END_FOLLOW , FREEZE_TIME , UNFREEZE_TIME , SHOW_MILITARY_CAPTION ,
  CAMERA_SET_AUDIBLE_DISTANCE , SET_STOPPING_DISTANCE , NAMED_SET_STOPPING_DISTANCE , SET_FPS_LIMIT ,
  MUSIC_SET_VOLUME , MAP_SHROUD_AT_WAYPOINT , MAP_SHROUD_ALL , SET_RANDOM_TIMER ,
  SET_RANDOM_MSEC_TIMER , STOP_TIMER , RESTART_TIMER , ADD_TO_MSEC_TIMER ,
  SUB_FROM_MSEC_TIMER , TEAM_TRANSFER_TO_PLAYER , PLAYER_SET_MONEY , PLAYER_GIVE_MONEY ,
  DISABLE_SPECIAL_POWER_DISPLAY , ENABLE_SPECIAL_POWER_DISPLAY , NAMED_HIDE_SPECIAL_POWER_DISPLAY , NAMED_SHOW_SPECIAL_POWER_DISPLAY ,
  DISPLAY_COUNTDOWN_TIMER , HIDE_COUNTDOWN_TIMER , ENABLE_COUNTDOWN_TIMER_DISPLAY , DISABLE_COUNTDOWN_TIMER_DISPLAY ,
  NAMED_STOP_SPECIAL_POWER_COUNTDOWN , NAMED_START_SPECIAL_POWER_COUNTDOWN , NAMED_SET_SPECIAL_POWER_COUNTDOWN , NAMED_ADD_SPECIAL_POWER_COUNTDOWN ,
  NAMED_FIRE_SPECIAL_POWER_AT_WAYPOINT , NAMED_FIRE_SPECIAL_POWER_AT_NAMED , REFRESH_RADAR , CAMERA_TETHER_NAMED ,
  CAMERA_STOP_TETHER_NAMED , CAMERA_SET_DEFAULT , NAMED_STOP , TEAM_STOP ,
  TEAM_STOP_AND_DISBAND , RECRUIT_TEAM , TEAM_SET_OVERRIDE_RELATION_TO_TEAM , TEAM_REMOVE_OVERRIDE_RELATION_TO_TEAM ,
  TEAM_REMOVE_ALL_OVERRIDE_RELATIONS , CAMERA_LOOK_TOWARD_OBJECT , NAMED_FIRE_WEAPON_FOLLOWING_WAYPOINT_PATH , TEAM_SET_OVERRIDE_RELATION_TO_PLAYER ,
  TEAM_REMOVE_OVERRIDE_RELATION_TO_PLAYER , PLAYER_SET_OVERRIDE_RELATION_TO_TEAM , PLAYER_REMOVE_OVERRIDE_RELATION_TO_TEAM , UNIT_EXECUTE_SEQUENTIAL_SCRIPT ,
  UNIT_EXECUTE_SEQUENTIAL_SCRIPT_LOOPING , UNIT_STOP_SEQUENTIAL_SCRIPT , TEAM_EXECUTE_SEQUENTIAL_SCRIPT , TEAM_EXECUTE_SEQUENTIAL_SCRIPT_LOOPING ,
  TEAM_STOP_SEQUENTIAL_SCRIPT , UNIT_GUARD_FOR_FRAMECOUNT , UNIT_IDLE_FOR_FRAMECOUNT , TEAM_GUARD_FOR_FRAMECOUNT ,
  TEAM_IDLE_FOR_FRAMECOUNT , WATER_CHANGE_HEIGHT , NAMED_USE_COMMANDBUTTON_ABILITY_ON_NAMED , NAMED_USE_COMMANDBUTTON_ABILITY_AT_WAYPOINT ,
  WATER_CHANGE_HEIGHT_OVER_TIME , MAP_SWITCH_BORDER , TEAM_GUARD_POSITION , TEAM_GUARD_OBJECT ,
  TEAM_GUARD_AREA , OBJECT_FORCE_SELECT , CAMERA_LOOK_TOWARD_WAYPOINT , UNIT_DESTROY_ALL_CONTAINED ,
  RADAR_FORCE_ENABLE , RADAR_REVERT_TO_NORMAL , SCREEN_SHAKE , TECHTREE_MODIFY_BUILDABILITY_OBJECT ,
  WAREHOUSE_SET_VALUE , OBJECT_CREATE_RADAR_EVENT , TEAM_CREATE_RADAR_EVENT , DISPLAY_CINEMATIC_TEXT ,
  DEBUG_CRASH_BOX , SOUND_DISABLE_TYPE , SOUND_ENABLE_TYPE , SOUND_ENABLE_ALL ,
  AUDIO_OVERRIDE_VOLUME_TYPE , AUDIO_RESTORE_VOLUME_TYPE , AUDIO_RESTORE_VOLUME_ALL_TYPE , INGAME_POPUP_MESSAGE ,
  SET_CAVE_INDEX , NAMED_SET_HELD , NAMED_SET_TOPPLE_DIRECTION , UNIT_MOVE_TOWARDS_NEAREST_OBJECT_TYPE ,
  TEAM_MOVE_TOWARDS_NEAREST_OBJECT_TYPE , MAP_REVEAL_ALL_PERM , MAP_REVEAL_ALL_UNDO_PERM , NAMED_SET_REPULSOR ,
  TEAM_SET_REPULSOR , TEAM_WANDER_IN_PLACE , TEAM_INCREASE_PRIORITY , TEAM_DECREASE_PRIORITY ,
  DISPLAY_COUNTER , HIDE_COUNTER , TEAM_USE_COMMANDBUTTON_ABILITY_ON_NAMED , TEAM_USE_COMMANDBUTTON_ABILITY_AT_WAYPOINT ,
  NAMED_USE_COMMANDBUTTON_ABILITY , TEAM_USE_COMMANDBUTTON_ABILITY , NAMED_FLASH_WHITE , TEAM_FLASH_WHITE ,
  SKIRMISH_BUILD_BUILDING , SKIRMISH_FOLLOW_APPROACH_PATH , IDLE_ALL_UNITS , RESUME_SUPPLY_TRUCKING ,
  NAMED_CUSTOM_COLOR , SKIRMISH_MOVE_TO_APPROACH_PATH , SKIRMISH_BUILD_BASE_DEFENSE_FRONT , SKIRMISH_FIRE_SPECIAL_POWER_AT_MOST_COST ,
  NAMED_RECEIVE_UPGRADE , PLAYER_REPAIR_NAMED_STRUCTURE , SKIRMISH_BUILD_BASE_DEFENSE_FLANK , SKIRMISH_BUILD_STRUCTURE_FRONT ,
  SKIRMISH_BUILD_STRUCTURE_FLANK , SKIRMISH_ATTACK_NEAREST_GROUP_WITH_VALUE , SKIRMISH_PERFORM_COMMANDBUTTON_ON_MOST_VALUABLE_OBJECT , SKIRMISH_WAIT_FOR_COMMANDBUTTON_AVAILABLE_ALL ,
  SKIRMISH_WAIT_FOR_COMMANDBUTTON_AVAILABLE_PARTIAL , TEAM_SPIN_FOR_FRAMECOUNT , TEAM_ALL_USE_COMMANDBUTTON_ON_NAMED , TEAM_ALL_USE_COMMANDBUTTON_ON_NEAREST_ENEMY_UNIT ,
  TEAM_ALL_USE_COMMANDBUTTON_ON_NEAREST_GARRISONED_BUILDING , TEAM_ALL_USE_COMMANDBUTTON_ON_NEAREST_KINDOF , TEAM_ALL_USE_COMMANDBUTTON_ON_NEAREST_ENEMY_BUILDING , TEAM_ALL_USE_COMMANDBUTTON_ON_NEAREST_ENEMY_BUILDING_CLASS ,
  TEAM_ALL_USE_COMMANDBUTTON_ON_NEAREST_OBJECTTYPE , TEAM_PARTIAL_USE_COMMANDBUTTON , TEAM_CAPTURE_NEAREST_UNOWNED_FACTION_UNIT , PLAYER_CREATE_TEAM_FROM_CAPTURED_UNITS ,
  PLAYER_ADD_SKILLPOINTS , PLAYER_ADD_RANKLEVEL , PLAYER_SET_RANKLEVEL , PLAYER_SET_RANKLEVELLIMIT ,
  PLAYER_GRANT_SCIENCE , PLAYER_PURCHASE_SCIENCE , TEAM_HUNT_WITH_COMMAND_BUTTON , TEAM_WAIT_FOR_NOT_CONTAINED_ALL ,
  TEAM_WAIT_FOR_NOT_CONTAINED_PARTIAL , TEAM_FOLLOW_WAYPOINTS_EXACT , NAMED_FOLLOW_WAYPOINTS_EXACT , TEAM_SET_EMOTICON ,
  NAMED_SET_EMOTICON , AI_PLAYER_BUILD_SUPPLY_CENTER , AI_PLAYER_BUILD_UPGRADE , OBJECTLIST_ADDOBJECTTYPE ,
  OBJECTLIST_REMOVEOBJECTTYPE , MAP_REVEAL_PERMANENTLY_AT_WAYPOINT , MAP_UNDO_REVEAL_PERMANENTLY_AT_WAYPOINT , NAMED_SET_STEALTH_ENABLED ,
  TEAM_SET_STEALTH_ENABLED , EVA_SET_ENABLED_DISABLED , OPTIONS_SET_OCCLUSION_MODE , LOCALDEFEAT ,
  OPTIONS_SET_DRAWICON_UI_MODE , OPTIONS_SET_PARTICLE_CAP_MODE , PLAYER_SCIENCE_AVAILABILITY , UNIT_AFFECT_OBJECT_PANEL_FLAGS ,
  TEAM_AFFECT_OBJECT_PANEL_FLAGS , PLAYER_SELECT_SKILLSET , SCRIPTING_OVERRIDE_HULK_LIFETIME , NAMED_FACE_NAMED ,
  NAMED_FACE_WAYPOINT , TEAM_FACE_NAMED , TEAM_FACE_WAYPOINT , COMMANDBAR_REMOVE_BUTTON_OBJECTTYPE ,
  COMMANDBAR_ADD_BUTTON_OBJECTTYPE_SLOT , UNIT_SPAWN_NAMED_LOCATION_ORIENTATION , PLAYER_AFFECT_RECEIVING_EXPERIENCE , PLAYER_EXCLUDE_FROM_SCORE_SCREEN ,
  TEAM_GUARD_SUPPLY_CENTER , ENABLE_SCORING , DISABLE_SCORING , SOUND_SET_VOLUME ,
  SPEECH_SET_VOLUME , DISABLE_BORDER_SHROUD , ENABLE_BORDER_SHROUD , OBJECT_ALLOW_BONUSES ,
  SOUND_REMOVE_ALL_DISABLED , SOUND_REMOVE_TYPE , TEAM_GUARD_IN_TUNNEL_NETWORK , QUICKVICTORY ,
  SET_INFANTRY_LIGHTING_OVERRIDE , RESET_INFANTRY_LIGHTING_OVERRIDE , TEAM_DELETE_LIVING , RESIZE_VIEW_GUARDBAND ,
  DELETE_ALL_UNMANNED , CHOOSE_VICTIM_ALWAYS_USES_NORMAL , CAMERA_ENABLE_SLAVE_MODE , CAMERA_DISABLE_SLAVE_MODE ,
  CAMERA_ADD_SHAKER_AT , SET_TRAIN_HELD , NAMED_SET_EVAC_LEFT_OR_RIGHT , ENABLE_OBJECT_SOUND ,
  DISABLE_OBJECT_SOUND , NAMED_USE_COMMANDBUTTON_ABILITY_USING_WAYPOINT_PATH , NAMED_SET_UNMANNED_STATUS , TEAM_SET_UNMANNED_STATUS ,
  NAMED_SET_BOOBYTRAPPED , TEAM_SET_BOOBYTRAPPED , SHOW_WEATHER , AI_PLAYER_BUILD_TYPE_NEAREST_TEAM ,
  NUM_ITEMS
}
 

Public Member Functions

 ScriptAction (ScriptActionType type)
 
ScriptActionduplicate (void) const
 
ScriptActionduplicateAndQualify (const AsciiString &qualifier, const AsciiString &playerTemplateName, const AsciiString &newPlayerName) const
 
void setActionType (ScriptActionType type)
 
void setNextAction (ScriptAction *pAct)
 
void setWarnings (Bool warnings)
 
ScriptActionType getActionType (void)
 
ScriptActiongetNext (void)
 
AsciiString getUiText (void)
 
ParametergetParameter (Int ndx)
 
Bool hasWarnings (void) const
 
Int getNumParameters (void)
 
Int getUiStrings (AsciiString strings[MAX_PARMS])
 
- Public Member Functions inherited from MemoryPoolObject
void deleteInstance ()
 

Static Public Member Functions

static void WriteActionDataChunk (DataChunkOutput &chunkWriter, ScriptAction *pAct)
 
static Bool ParseActionDataChunk (DataChunkInput &file, DataChunkInfo *info, void *userData)
 
static void WriteActionFalseDataChunk (DataChunkOutput &chunkWriter, ScriptAction *pAct)
 
static Bool ParseActionFalseDataChunk (DataChunkInput &file, DataChunkInfo *info, void *userData)
 

Protected Member Functions

 ScriptAction ()
 Protected constructor for read.
 
- Protected Member Functions inherited from MemoryPoolObject
virtual ~MemoryPoolObject ()
 
void * operator new (size_t s)
 
void operator delete (void *p)
 
virtual MemoryPoolgetObjectMemoryPool ()=0
 

Static Protected Member Functions

static ScriptActionParseAction (DataChunkInput &file, DataChunkInfo *info, void *userData)
 

Protected Attributes

ScriptActionType m_actionType
 
Int m_numParms
 
Parameterm_parms [MAX_PARMS]
 
ScriptActionm_nextAction
 
Bool m_hasWarnings
 Runtime flag used by the editor only.
 

Detailed Description

Definition at line 197 of file Scripts.h.

Member Enumeration Documentation

◆ ScriptActionType

Enumerator
DEBUG_MESSAGE_BOX 

Show a message box.

SET_FLAG 

Set a flag true of false.

SET_COUNTER 

Set a counter to an integer.

VICTORY 

Announce victory.

DEFEAT 

Announce defeat.

NO_OP 

No op.

SET_TIMER 

Start a frame timer.

PLAY_SOUND_EFFECT 

Play sound.

ENABLE_SCRIPT 

Enable script.

DISABLE_SCRIPT 

Disable script.

CALL_SUBROUTINE 

Call a subroutine.

PLAY_SOUND_EFFECT_AT 

Play sound at location.

DAMAGE_MEMBERS_OF_TEAM 

Damage team members (boom.)

MOVE_TEAM_TO 

Move to.

MOVE_CAMERA_TO 

Move camera to.

INCREMENT_COUNTER 

Add to a counter.

DECREMENT_COUNTER 

subtract from a counter.

MOVE_CAMERA_ALONG_WAYPOINT_PATH 

Move camera along path.

ROTATE_CAMERA 

Rotate camera.

RESET_CAMERA 

Reset camera.

SET_MILLISECOND_TIMER 

Start a time based timer.

CAMERA_MOD_FREEZE_TIME 

Freeze time during a camera movement.

SET_VISUAL_SPEED_MULTIPLIER 

Drop frames so that time "goes" faster..

CREATE_OBJECT 

Create an object.

SUSPEND_BACKGROUND_SOUNDS 

Stop backgropund music & sounds.

RESUME_BACKGROUND_SOUNDS 

Resume backgropund music & sounds.

CAMERA_MOD_SET_FINAL_ZOOM 

Sets the final zoom for a camera movement.

CAMERA_MOD_SET_FINAL_PITCH 

Sets the final pitch for a camera movement.

CAMERA_MOD_FREEZE_ANGLE 

Freeze camera angle during a camera movement.

CAMERA_MOD_SET_FINAL_SPEED_MULTIPLIER 

Sets the final time multiplier for a camera movement.

CAMERA_MOD_SET_ROLLING_AVERAGE 

Sets the number of frames to average changes (angle, positoin) to smooth out a camera movement.

CAMERA_MOD_FINAL_LOOK_TOWARD 

Sets the look toward point for the end of a camera movement.

CAMERA_MOD_LOOK_TOWARD 

Sets the look toward point during a camera movement.

TEAM_ATTACK_TEAM 

Tell team to attack other team.

CREATE_REINFORCEMENT_TEAM 

Create a team of reinforcements.

MOVE_CAMERA_TO_SELECTION 

Move the target to the selected item.

TEAM_FOLLOW_WAYPOINTS 

Tell the team to begin following a path, starting at given waypoint.

TEAM_SET_STATE 

Set a team to a particular state.

MOVE_NAMED_UNIT_TO 

Move a named unit to a position.

NAMED_ATTACK_NAMED 

Make a named unit attack another named unit.

CREATE_NAMED_ON_TEAM_AT_WAYPOINT 

Create a named unit on a team at a waypoint.

CREATE_UNNAMED_ON_TEAM_AT_WAYPOINT 

Create a unnamed unit on a team at a waypoint.

NAMED_APPLY_ATTACK_PRIORITY_SET 

Applies an attack priority set to a named unit.

TEAM_APPLY_ATTACK_PRIORITY_SET 

Applies an attack priority set to a team.

SET_BASE_CONSTRUCTION_SPEED 

Impl JKMCD.

NAMED_SET_ATTITUDE 

Impl JKMCD.

TEAM_SET_ATTITUDE 

Impl JKMCD.

NAMED_ATTACK_AREA 

Set a unit to attack an area.

NAMED_ATTACK_TEAM 

Impl JKMCD.

TEAM_ATTACK_AREA 

Set a team to attack an area.

TEAM_ATTACK_NAMED 

Set a team to attack a unit.

TEAM_LOAD_TRANSPORTS 

Set a team to auto-load transports.

NAMED_ENTER_NAMED 

Set a unit to enter a transport.

TEAM_ENTER_NAMED 

Set a team to enter a transport.

NAMED_EXIT_ALL 

Set a unit to exit its transport.

TEAM_EXIT_ALL 

Set a team to exit all transports.

NAMED_FOLLOW_WAYPOINTS 

Set a unit to follow a waypoint path.

NAMED_GUARD 

Set a unit to guard it's current location.

TEAM_GUARD 

Set a team to guard it's current location.

NAMED_HUNT 

Set a unit to hunt.

TEAM_HUNT 

Set a team to hunt.

PLAYER_SELL_EVERYTHING 

Set a player to sell everything.

PLAYER_DISABLE_BASE_CONSTRUCTION 

Disallow a player from building anymore base buildings.

PLAYER_DISABLE_FACTORIES 

Disallow a player from building from factories.

PLAYER_DISABLE_UNIT_CONSTRUCTION 

Disallow a player from building units.

PLAYER_ENABLE_BASE_CONSTRUCTION 

Allow a player to build bases.

PLAYER_ENABLE_FACTORIES 

Allow a player to build from his factories.

PLAYER_ENABLE_UNIT_CONSTRUCTION 

Allow a player to build units.

CAMERA_MOVE_HOME 

Impl JKMCD.

BUILD_TEAM 

Build a team from a teamtemplate.

NAMED_DAMAGE 

Damage a unit.

NAMED_DELETE 

Delete a unit.

TEAM_DELETE 

Delete a team.

NAMED_KILL 

Kill a unit.

TEAM_KILL 

Kill a team.

PLAYER_KILL 

Kill a player.

DISPLAY_TEXT 

Display a localized string.

CAMEO_FLASH 

Flashes a command button.

NAMED_FLASH 

Flashes a specific unit.

TEAM_FLASH 

Flashes a specific team.

MOVIE_PLAY_FULLSCREEN 

Play a movie in fullscreen.

MOVIE_PLAY_RADAR 

Play a movie in the radar.

SOUND_PLAY_NAMED 

Play a sound as though it comes from a unit.

SPEECH_PLAY 

Play a speech.

PLAYER_TRANSFER_OWNERSHIP_PLAYER 

Transfer ownership of all units to another player.

NAMED_TRANSFER_OWNERSHIP_PLAYER 

Transfer ownership of a single unit to another player.

PLAYER_RELATES_PLAYER 

Update player-player relations.

RADAR_CREATE_EVENT 

Impl JKMCD.

RADAR_DISABLE 

Disable the radar.

RADAR_ENABLE 

Enable the radar.

MAP_REVEAL_AT_WAYPOINT 

Reveal the map within a radius of waypoint.

TEAM_AVAILABLE_FOR_RECRUITMENT 

Impl JKMCD.

TEAM_COLLECT_NEARBY_FOR_TEAM 

Impl JKMCD.

TEAM_MERGE_INTO_TEAM 

Merge a team into another team.

DISABLE_INPUT 

Disable user input.

ENABLE_INPUT 

Re-enable user input.

PLAYER_HUNT 

Set an entire player's team to hunt.

SOUND_AMBIENT_PAUSE 

Pause all ambient sounds.

SOUND_AMBIENT_RESUME 

Resume all ambient sounds.

MUSIC_SET_TRACK 

Set the current music track, allowing for fade-in and fade-out.

SET_TREE_SWAY 

Set the trees' sway.

DEBUG_STRING 

Output a debug string without stopping.

MAP_REVEAL_ALL 

Reveal the entire map.

TEAM_GARRISON_SPECIFIC_BUILDING 

Garrison a specific building.

EXIT_SPECIFIC_BUILDING 

Empty a specific building.

TEAM_GARRISON_NEAREST_BUILDING 

Garrison a nearby building.

TEAM_EXIT_ALL_BUILDINGS 

Empty all buildings of units.

NAMED_GARRISON_SPECIFIC_BUILDING 

Send a unit to garrison a specific building.

NAMED_GARRISON_NEAREST_BUILDING 

Send a unit to garrison the nearest building.

NAMED_EXIT_BUILDING 

Tell a unit to exit the building its currently in.

PLAYER_GARRISON_ALL_BUILDINGS 

Garrison as many buildings as possible (filling each one up)

PLAYER_EXIT_ALL_BUILDINGS 

Tell all buildings to empty themselves for this player.

TEAM_WANDER 

Tell a team to wander.

TEAM_PANIC 

Tell a team to panic.

SETUP_CAMERA 

Set up an initial camera position.

CAMERA_LETTERBOX_BEGIN 

Set the camera into letterbox mode.

CAMERA_LETTERBOX_END 

End the Letterbox mode.

ZOOM_CAMERA 

Set camera zoom.

PITCH_CAMERA 

Set camera pitch.

CAMERA_FOLLOW_NAMED 

Camera follow named.

OVERSIZE_TERRAIN 
CAMERA_FADE_ADD 

Fade using an add blend.

CAMERA_FADE_SUBTRACT 

Fade using a subtract blend.

CAMERA_FADE_SATURATE 

Fade using a saturate blend.

CAMERA_FADE_MULTIPLY 

Fade using a multiply blend.

CAMERA_BW_MODE_BEGIN 

switch camera to black & white mode.

CAMERA_BW_MODE_END 

switch camera back to color mode.

DRAW_SKYBOX_BEGIN 

draw skybox

DRAW_SKYBOX_END 

stop skybox

SET_ATTACK_PRIORITY_THING 

Sets the attack priority for a single thing in a set.

SET_ATTACK_PRIORITY_KIND_OF 

Sets the attack priority for all of a kind in a set.

SET_DEFAULT_ATTACK_PRIORITY 

Sets the default attack priority for a set.

CAMERA_STOP_FOLLOW 

Ends a camera follow named.

CAMERA_MOTION_BLUR 

Starts a camera motion blur zoom.

CAMERA_MOTION_BLUR_JUMP 

Starts a camera motion blur in & out with jump.

CAMERA_MOTION_BLUR_FOLLOW 

Starts a motion blur follow scrolling effect.

CAMERA_MOTION_BLUR_END_FOLLOW 

Ends a motion blur follow scrolling effect.

FREEZE_TIME 

Freeze time.

UNFREEZE_TIME 

Unfreeze time.

SHOW_MILITARY_CAPTION 

Display military-style briefing text.

CAMERA_SET_AUDIBLE_DISTANCE 

Sets the range for the audible distance.

SET_STOPPING_DISTANCE 

Sets the stopping distance for a team.

NAMED_SET_STOPPING_DISTANCE 

Sets the stopping distance for a named object.

SET_FPS_LIMIT 

Sets the max frames-per-second.

MUSIC_SET_VOLUME 

Adjust the track volume.

MAP_SHROUD_AT_WAYPOINT 

Shroud the map at this waypoint.

MAP_SHROUD_ALL 

Shroud the entire map.

SET_RANDOM_TIMER 

Start a random frame based timer.

SET_RANDOM_MSEC_TIMER 

Start a random time based timer.

STOP_TIMER 

Stop a timer. Remembers time stopped.

RESTART_TIMER 

Restarts a stopped timer. Remembers time stopped.

ADD_TO_MSEC_TIMER 

Adds time to a timer.

SUB_FROM_MSEC_TIMER 

Subtracts time from a timer.

TEAM_TRANSFER_TO_PLAYER 

Transfers a team to a player, maintaining team-ness.

PLAYER_SET_MONEY 

Set a player's cash reserves to a specific value.

PLAYER_GIVE_MONEY 

// Add/subtract cash from a player's reserves.

DISABLE_SPECIAL_POWER_DISPLAY 

hides the special power countdown display

ENABLE_SPECIAL_POWER_DISPLAY 

shows the special power countdown display

NAMED_HIDE_SPECIAL_POWER_DISPLAY 

hides the special power countdown display for an object

NAMED_SHOW_SPECIAL_POWER_DISPLAY 

shows the special power countdown display for an object

DISPLAY_COUNTDOWN_TIMER 

shows a countdown timer

HIDE_COUNTDOWN_TIMER 

hides a countdown timer

ENABLE_COUNTDOWN_TIMER_DISPLAY 

enables countdown timer display

DISABLE_COUNTDOWN_TIMER_DISPLAY 

disables countdown timer display

NAMED_STOP_SPECIAL_POWER_COUNTDOWN 

pauses the countdown for a special power

NAMED_START_SPECIAL_POWER_COUNTDOWN 

resumes the countdown for a special power

NAMED_SET_SPECIAL_POWER_COUNTDOWN 

set special power countdown for an object

NAMED_ADD_SPECIAL_POWER_COUNTDOWN 

add/subtract time from a special power countdown

NAMED_FIRE_SPECIAL_POWER_AT_WAYPOINT 

fire a special power

NAMED_FIRE_SPECIAL_POWER_AT_NAMED 

fire a special power

REFRESH_RADAR 

Force the radar to recalculate the terrain.

CAMERA_TETHER_NAMED 

Tether the camera location to a named unit.

CAMERA_STOP_TETHER_NAMED 

Break tether.

CAMERA_SET_DEFAULT 

Set default angle, pitch, zoom, etc for camera.

NAMED_STOP 

Make a named unit stop (go idle)

TEAM_STOP 

Make a team stop (go idle)

TEAM_STOP_AND_DISBAND 

Make a team stop and be merged into the default player team. Also, mark the whole team recruitable.

RECRUIT_TEAM 

Recruit a team?

TEAM_SET_OVERRIDE_RELATION_TO_TEAM 

override a team's relation to another team

TEAM_REMOVE_OVERRIDE_RELATION_TO_TEAM 

remove that override

TEAM_REMOVE_ALL_OVERRIDE_RELATIONS 

remove all overrides

CAMERA_LOOK_TOWARD_OBJECT 

Rotate the camera to be pointing toward a unit.

NAMED_FIRE_WEAPON_FOLLOWING_WAYPOINT_PATH 

Fires a specific weapon that follows waypoint path and detonates at the final waypoint.

TEAM_SET_OVERRIDE_RELATION_TO_PLAYER 

override a team's relation to another player

TEAM_REMOVE_OVERRIDE_RELATION_TO_PLAYER 

remove that override

PLAYER_SET_OVERRIDE_RELATION_TO_TEAM 

override a Player's relation to another team

PLAYER_REMOVE_OVERRIDE_RELATION_TO_TEAM 

remove that override

UNIT_EXECUTE_SEQUENTIAL_SCRIPT 

Make a unit execute a script sequentially.

UNIT_EXECUTE_SEQUENTIAL_SCRIPT_LOOPING 

Make a unit execute a script sequentially (forever)

UNIT_STOP_SEQUENTIAL_SCRIPT 

Make a unit stop executing its sequential scripts.

TEAM_EXECUTE_SEQUENTIAL_SCRIPT 

Make a team execute a script sequentially.

TEAM_EXECUTE_SEQUENTIAL_SCRIPT_LOOPING 

Make a team execute a script sequentially (forever)

TEAM_STOP_SEQUENTIAL_SCRIPT 

Make a team stop executing its sequential scripts.

UNIT_GUARD_FOR_FRAMECOUNT 

Make a specific unit guard for a framecount.

UNIT_IDLE_FOR_FRAMECOUNT 

Make a specific unit stop idle for a framecount.

TEAM_GUARD_FOR_FRAMECOUNT 

Make a team guard for a framecount.

TEAM_IDLE_FOR_FRAMECOUNT 

Make a team stop idle for a framecount.

WATER_CHANGE_HEIGHT 

Adjust the water level.

NAMED_USE_COMMANDBUTTON_ABILITY_ON_NAMED 

Make a unit use an ability on another unit.

NAMED_USE_COMMANDBUTTON_ABILITY_AT_WAYPOINT 

Make a unit use an ability on a waypoint.

WATER_CHANGE_HEIGHT_OVER_TIME 

Adjust the water level over a period of time.

MAP_SWITCH_BORDER 

Switch to border color <Blah>

TEAM_GUARD_POSITION 
TEAM_GUARD_OBJECT 
TEAM_GUARD_AREA 
OBJECT_FORCE_SELECT 

Force selection of the first object type on the player's team.

CAMERA_LOOK_TOWARD_WAYPOINT 

Rotate the camera to be pointing toward a waypoint.

UNIT_DESTROY_ALL_CONTAINED 

Destroy all units contained by the named unit.

RADAR_FORCE_ENABLE 

Force the radar to be on regardless of player status.

RADAR_REVERT_TO_NORMAL 

Undo forcing the radar to be on.

SCREEN_SHAKE 

Shake the entire screen.

TECHTREE_MODIFY_BUILDABILITY_OBJECT 

Modify how "buildable" something is.

WAREHOUSE_SET_VALUE 

Set a Warehouse to have this much money.

OBJECT_CREATE_RADAR_EVENT 

Create a radar event at this object.

TEAM_CREATE_RADAR_EVENT 

Create a radar event at this team.

DISPLAY_CINEMATIC_TEXT 

Displays a string in the bottom letterbox.

DEBUG_CRASH_BOX 

Debug/Internal builds only: do a crash box.

SOUND_DISABLE_TYPE 
SOUND_ENABLE_TYPE 
SOUND_ENABLE_ALL 
AUDIO_OVERRIDE_VOLUME_TYPE 
AUDIO_RESTORE_VOLUME_TYPE 
AUDIO_RESTORE_VOLUME_ALL_TYPE 
INGAME_POPUP_MESSAGE 

Popup an ingame popup message box.

SET_CAVE_INDEX 

Set the index of which set of caves a cave is connected to.

NAMED_SET_HELD 

Sets a named object to be "held" in place or not.

NAMED_SET_TOPPLE_DIRECTION 

Set the topple direction of the specified direction.

UNIT_MOVE_TOWARDS_NEAREST_OBJECT_TYPE 

Move a named unit towards the nearest object of type type.

TEAM_MOVE_TOWARDS_NEAREST_OBJECT_TYPE 

For each member of the team, move towards the nearest object of type.

MAP_REVEAL_ALL_PERM 
MAP_REVEAL_ALL_UNDO_PERM 
NAMED_SET_REPULSOR 

Set a unit as a repulsor (scares) civilians.

TEAM_SET_REPULSOR 

Set a team as a repulsor (scares) civilians.

TEAM_WANDER_IN_PLACE 

Set a team to wander around their current position.

TEAM_INCREASE_PRIORITY 

Increment a team's ai priority by it's success amount.

TEAM_DECREASE_PRIORITY 

Decrease a team's ai prioiryt by it's failure amount.

DISPLAY_COUNTER 

shows a counter

HIDE_COUNTER 

hides a counter

TEAM_USE_COMMANDBUTTON_ABILITY_ON_NAMED 

Make a team use an ability on another unit.

TEAM_USE_COMMANDBUTTON_ABILITY_AT_WAYPOINT 

Make a team use an ability on a waypoint.

NAMED_USE_COMMANDBUTTON_ABILITY 

Make a unit use an ability.

TEAM_USE_COMMANDBUTTON_ABILITY 

Make a team use an ability.

NAMED_FLASH_WHITE 

Flashes a specific unit.

TEAM_FLASH_WHITE 

Flashes a specific team.

SKIRMISH_BUILD_BUILDING 

Start building a building.

SKIRMISH_FOLLOW_APPROACH_PATH 

Follow a particular route to the enemy.

IDLE_ALL_UNITS 

cancel any current actions for one player (or all players)

RESUME_SUPPLY_TRUCKING 

Re-enable supply trucking for idle trucks for one player (or all players)

NAMED_CUSTOM_COLOR 

set a specific unit to use a special indicator color (not his controlling player's)

SKIRMISH_MOVE_TO_APPROACH_PATH 

Follow a particular route to the enemy.

SKIRMISH_BUILD_BASE_DEFENSE_FRONT 

Build some base defense on the front.

SKIRMISH_FIRE_SPECIAL_POWER_AT_MOST_COST 

Fire a power or superweapon at the enemy's most costly concentration of structures & units..

NAMED_RECEIVE_UPGRADE 

Unit receives an upgrade.

PLAYER_REPAIR_NAMED_STRUCTURE 

Send a dozer to repair a structure.

SKIRMISH_BUILD_BASE_DEFENSE_FLANK 

Build some base defense on the flank.

SKIRMISH_BUILD_STRUCTURE_FRONT 

Build some structure on the front.

SKIRMISH_BUILD_STRUCTURE_FLANK 

Build some structure on the flank.

SKIRMISH_ATTACK_NEAREST_GROUP_WITH_VALUE 

Send a team to attack the nearest group with value comparison.

SKIRMISH_PERFORM_COMMANDBUTTON_ON_MOST_VALUABLE_OBJECT 

Send a single unit/ all available to perform a command button action on the most valuable target.

SKIRMISH_WAIT_FOR_COMMANDBUTTON_AVAILABLE_ALL 

In a sequential script, stay on this step until the specified command button is ready for all units.

SKIRMISH_WAIT_FOR_COMMANDBUTTON_AVAILABLE_PARTIAL 

In a sequential script, stay on this step until the specified command button is ready for one unit on the team.

TEAM_SPIN_FOR_FRAMECOUNT 

Tell the team to continue its current task without advancing for this number of frames.

TEAM_ALL_USE_COMMANDBUTTON_ON_NAMED 

Tell the team to use the commandbutton on a named enemy.

TEAM_ALL_USE_COMMANDBUTTON_ON_NEAREST_ENEMY_UNIT 

Tell the team to use the commandbutton on the nearest enemy unit.

TEAM_ALL_USE_COMMANDBUTTON_ON_NEAREST_GARRISONED_BUILDING 

Tell the team to use the commandbutton on the nearest enemy garrisoned building.

TEAM_ALL_USE_COMMANDBUTTON_ON_NEAREST_KINDOF 

Tell the team to use the commandbutton on the nearest enemy that has kindof set.

TEAM_ALL_USE_COMMANDBUTTON_ON_NEAREST_ENEMY_BUILDING 

Tell the team to use the commandbutton on the nearest enemy building.

TEAM_ALL_USE_COMMANDBUTTON_ON_NEAREST_ENEMY_BUILDING_CLASS 

Tell the team to use the commandbutton on the nearest enemy building class.

TEAM_ALL_USE_COMMANDBUTTON_ON_NEAREST_OBJECTTYPE 

Tell the team to use the commandbutton on the nearest enemy object of type.

TEAM_PARTIAL_USE_COMMANDBUTTON 

Tell some percentage of the team to use the commandbutton on.

TEAM_CAPTURE_NEAREST_UNOWNED_FACTION_UNIT 

Tell the team to capture the nearest unowned faction unit (unit whose pilot has been killed by Jarmen Kell)

PLAYER_CREATE_TEAM_FROM_CAPTURED_UNITS 

Tell the player to create a new named team from all the units who have been captured.

PLAYER_ADD_SKILLPOINTS 

add/subtract skill points to the player.

PLAYER_ADD_RANKLEVEL 

add/subtract ranklevel for the player.

PLAYER_SET_RANKLEVEL 

set the player's ranklevel to an explicit level.

PLAYER_SET_RANKLEVELLIMIT 

set the RankLevelLimit for the current map.

PLAYER_GRANT_SCIENCE 

grant a Science to the player, regardless of prereqs, etc

PLAYER_PURCHASE_SCIENCE 

the Player purchases the specified Science (if he has enough points, prereqs, etc)

TEAM_HUNT_WITH_COMMAND_BUTTON 

Hunt using a command button ability.

TEAM_WAIT_FOR_NOT_CONTAINED_ALL 

In a sequential script, stay on this step until the entire team is no longer contained.

TEAM_WAIT_FOR_NOT_CONTAINED_PARTIAL 

In a sequential script, stay on this step until at least one member of the team is no longer contained.

TEAM_FOLLOW_WAYPOINTS_EXACT 

Follows waypoints exactly.

NAMED_FOLLOW_WAYPOINTS_EXACT 

Follows waypoints exactly.

TEAM_SET_EMOTICON 

Adds specified emoticon to each unit in team (-1 permanent, 0 get rid of, 1+ duration in ms)

NAMED_SET_EMOTICON 

Adds specified emoticon to named unit (-1 permanent, 0 get rid of, 1+ duration in ms)

AI_PLAYER_BUILD_SUPPLY_CENTER 

Tell the ai player to build a supply center.

AI_PLAYER_BUILD_UPGRADE 

Tell the ai player to build an upgrade.

OBJECTLIST_ADDOBJECTTYPE 

Add the associated object to the named list.

OBJECTLIST_REMOVEOBJECTTYPE 

Remove the associated object to the named list.

MAP_REVEAL_PERMANENTLY_AT_WAYPOINT 

Reveal an area at a waypoint.

MAP_UNDO_REVEAL_PERMANENTLY_AT_WAYPOINT 

Undo a previous permanent reveal.

NAMED_SET_STEALTH_ENABLED 

Enables/disables stealth capability for a specific unit.

TEAM_SET_STEALTH_ENABLED 

Enables/disables stealth capability for a team.

EVA_SET_ENABLED_DISABLED 

Sets EVA to continue to evaluate messages or not.

OPTIONS_SET_OCCLUSION_MODE 

Enables behind building functionality.

LOCALDEFEAT 

Announce local player's defeat.

OPTIONS_SET_DRAWICON_UI_MODE 

Enables/disables all emoticons.

OPTIONS_SET_PARTICLE_CAP_MODE 

Enables/disables particle cap.

PLAYER_SCIENCE_AVAILABILITY 

Determines the availability of a specific science.

UNIT_AFFECT_OBJECT_PANEL_FLAGS 

Affects the various flags on the object panel for an individual unit.

TEAM_AFFECT_OBJECT_PANEL_FLAGS 

Affects the various flags on the object panel for all units on a team.

PLAYER_SELECT_SKILLSET 

Select the skillset for an AI player.

SCRIPTING_OVERRIDE_HULK_LIFETIME 

Overrides the lifetime of hulks (for cinematic purposes).

NAMED_FACE_NAMED 

Orders unit to face the position of the other named object.

NAMED_FACE_WAYPOINT 

Orders unit to face a waypoint.

TEAM_FACE_NAMED 

Orders all members of a team to face a specific unit.

TEAM_FACE_WAYPOINT 

Orders all members of a team to face a waypoint.

COMMANDBAR_REMOVE_BUTTON_OBJECTTYPE 

Remove a button from a command bar for an objecttype.

COMMANDBAR_ADD_BUTTON_OBJECTTYPE_SLOT 

Add a button to the command bar for an objecttype, in a specific slot.

UNIT_SPAWN_NAMED_LOCATION_ORIENTATION 

Create a named unit at the specified location, altitude, and orientation.

PLAYER_AFFECT_RECEIVING_EXPERIENCE 

Adjust whether or not a player is receieving experience for kills.

PLAYER_EXCLUDE_FROM_SCORE_SCREEN 

This player should be listed in the score screen. Should only be used in campaign games.

TEAM_GUARD_SUPPLY_CENTER 

Have an ai team guard the nearest available supply center..

ENABLE_SCORING 

Turn on scoring of kills, units destroyed, etc.

DISABLE_SCORING 

Turn off scoring of kills, units destroyed, etc.

SOUND_SET_VOLUME 

Adjust the volume of the sounds.

SPEECH_SET_VOLUME 

Adjust the volume of the speech.

DISABLE_BORDER_SHROUD 

Clear the shroud that draws off the map border.

ENABLE_BORDER_SHROUD 

Restore the shroud that draws off the map border (normally on)

OBJECT_ALLOW_BONUSES 

Change whether or not the bonuses are applied to objects.

SOUND_REMOVE_ALL_DISABLED 

Remove any and all disabled sounds from the sound channels.

SOUND_REMOVE_TYPE 

Remove sound of type.

TEAM_GUARD_IN_TUNNEL_NETWORK 

Team enters nearest tunnel network & guards.

QUICKVICTORY 

End map in victory immediately.

SET_INFANTRY_LIGHTING_OVERRIDE 

Overrides the natural lighting on infantry for closeups.

RESET_INFANTRY_LIGHTING_OVERRIDE 

And then goes back to the GlobalData defaults.

TEAM_DELETE_LIVING 

Delete only the living members of this team.

RESIZE_VIEW_GUARDBAND 

Allow bigger objects to be perceived as onscreen near the edge.

DELETE_ALL_UNMANNED 

Delete all unmanned (sniped) vehicles.

CHOOSE_VICTIM_ALWAYS_USES_NORMAL 

choose victim always uses normal AI behavior, ignoring game difficulty

CAMERA_ENABLE_SLAVE_MODE 
CAMERA_DISABLE_SLAVE_MODE 
CAMERA_ADD_SHAKER_AT 

WST added 10.12.2002 (MBL)

SET_TRAIN_HELD 

LORENZEN – Forbids trains from departing stations while true.

NAMED_SET_EVAC_LEFT_OR_RIGHT 

LORENZEN – Which side of the garrisoned unit (LIKELY A TRAIN) do you want units to evacuate from?

ENABLE_OBJECT_SOUND 

Enables the ambient sound on an object or fire the one-shot "ambient" sound on an object.

DISABLE_OBJECT_SOUND 

Disable the ambient sound on an object or kill the one-shot "ambient" sound on an object.

NAMED_USE_COMMANDBUTTON_ABILITY_USING_WAYPOINT_PATH 

Added for particle cannon to have beam follow waypoint path.

NAMED_SET_UNMANNED_STATUS 

Make unit unmanned or manned.

TEAM_SET_UNMANNED_STATUS 

Make all units on team unmanned or manned.

NAMED_SET_BOOBYTRAPPED 

Add boobytrap to unit.

TEAM_SET_BOOBYTRAPPED 

Add boobytrap to all units on team.

SHOW_WEATHER 

show map defined weather.

AI_PLAYER_BUILD_TYPE_NEAREST_TEAM 

Tell the ai player to build an object nearest team.

NUM_ITEMS 

Definition at line 203 of file Scripts.h.

Constructor & Destructor Documentation

◆ ScriptAction() [1/2]

ScriptAction::ScriptAction ( ScriptActionType type)

Definition at line 2285 of file Scripts.cpp.

◆ ScriptAction() [2/2]

ScriptAction::ScriptAction ( )
protected

Protected constructor for read.

Definition at line 2274 of file Scripts.cpp.

Member Function Documentation

◆ duplicate()

ScriptAction * ScriptAction::duplicate ( void ) const

Definition at line 2312 of file Scripts.cpp.

◆ duplicateAndQualify()

ScriptAction * ScriptAction::duplicateAndQualify ( const AsciiString & qualifier,
const AsciiString & playerTemplateName,
const AsciiString & newPlayerName ) const

Definition at line 2336 of file Scripts.cpp.

◆ getActionType()

ScriptActionType ScriptAction::getActionType ( void )
inline

Definition at line 575 of file Scripts.h.

◆ getNext()

ScriptAction * ScriptAction::getNext ( void )
inline

Definition at line 576 of file Scripts.h.

◆ getNumParameters()

Int ScriptAction::getNumParameters ( void )
inline

Definition at line 586 of file Scripts.h.

◆ getParameter()

Parameter * ScriptAction::getParameter ( Int ndx)
inline

Definition at line 578 of file Scripts.h.

◆ getUiStrings()

Int ScriptAction::getUiStrings ( AsciiString strings[MAX_PARMS])

Definition at line 2384 of file Scripts.cpp.

◆ getUiText()

AsciiString ScriptAction::getUiText ( void )

Definition at line 2390 of file Scripts.cpp.

◆ hasWarnings()

Bool ScriptAction::hasWarnings ( void ) const
inline

Definition at line 585 of file Scripts.h.

◆ ParseAction()

ScriptAction * ScriptAction::ParseAction ( DataChunkInput & file,
DataChunkInfo * info,
void * userData )
staticprotected

ScriptAction::ParseAction - read an action chunk in a script list. Format is the newer CHUNKY format. See ScriptAction::WriteActionDataChunk for the writer. Input: DataChunkInput

Definition at line 2449 of file Scripts.cpp.

◆ ParseActionDataChunk()

Bool ScriptAction::ParseActionDataChunk ( DataChunkInput & file,
DataChunkInfo * info,
void * userData )
static

ScriptAction::ParseActionDataChunk - read an action chunk in a script list. Format is the newer CHUNKY format. See ScriptAction::WriteActionDataChunk for the writer. Input: DataChunkInput

Definition at line 2625 of file Scripts.cpp.

◆ ParseActionFalseDataChunk()

Bool ScriptAction::ParseActionFalseDataChunk ( DataChunkInput & file,
DataChunkInfo * info,
void * userData )
static

ScriptAction::ParseActionFalseDataChunk - read a false action chunk in a script list. Format is the newer CHUNKY format. See ScriptAction::WriteActionDataChunk for the writer. Input: DataChunkInput

Definition at line 2686 of file Scripts.cpp.

◆ setActionType()

void ScriptAction::setActionType ( ScriptActionType type)

Definition at line 2296 of file Scripts.cpp.

◆ setNextAction()

void ScriptAction::setNextAction ( ScriptAction * pAct)
inline

Definition at line 573 of file Scripts.h.

◆ setWarnings()

void ScriptAction::setWarnings ( Bool warnings)
inline

Definition at line 574 of file Scripts.h.

◆ WriteActionDataChunk()

void ScriptAction::WriteActionDataChunk ( DataChunkOutput & chunkWriter,
ScriptAction * pScriptAction )
static

ScriptAction::WriteActionDataChunk - Writes an Action chunk. Format is the newer CHUNKY format. Input: DataChunkInput

Definition at line 2419 of file Scripts.cpp.

◆ WriteActionFalseDataChunk()

void ScriptAction::WriteActionFalseDataChunk ( DataChunkOutput & chunkWriter,
ScriptAction * pScriptAction )
static

ScriptAction::WriteActionFalseDataChunk - Writes a false Action chunk. Format is the newer CHUNKY format. Input: DataChunkInput

Definition at line 2656 of file Scripts.cpp.

Member Data Documentation

◆ m_actionType

ScriptActionType ScriptAction::m_actionType
protected

Definition at line 563 of file Scripts.h.

◆ m_hasWarnings

Bool ScriptAction::m_hasWarnings
protected

Runtime flag used by the editor only.

Definition at line 567 of file Scripts.h.

◆ m_nextAction

ScriptAction* ScriptAction::m_nextAction
protected

Definition at line 566 of file Scripts.h.

◆ m_numParms

Int ScriptAction::m_numParms
protected

Definition at line 564 of file Scripts.h.

◆ m_parms

Parameter* ScriptAction::m_parms[MAX_PARMS]
protected

Definition at line 565 of file Scripts.h.


The documentation for this class was generated from the following files: