comment - X4 schema type - X4 Modding Wiki

Meaning#

comment: Explanatory text in an XML attribute. It does not become a game message or a logging command.

An XSD type constrains XML, rather than declaring a Lua return or the payload type of event.param. A valid schema value does not prove a successful game effect.

Schema structure#

libraries/common.xsd

Property	Value
Construction	`restriction`
Base type	`xs:string`

restriction narrows a base type; union accepts one of its branches; list describes whitespace-separated items. Enumeration values in one restriction are alternatives. Pattern syntax is XML Schema regex, not Lua patterns or JavaScript RegExp. Constraints inherited from the base type still apply.

Example and result#

XML

<set_value name="$Count" exact="3" comment="Example counter" />

What happens: The comment describes author intent; it does not display text to the player.

Object and group variables must already exist in the correct MD / AI context. These are learning fragments, not a complete runnable mission.

Used by#

Element	Attribute	Schema
`abort_build`	`comment`	`libraries/common.xsd`
`abort_scripts`	`comment`	`libraries/common.xsd`
`add_actor_to_room`	`comment`	`libraries/common.xsd`
`add_ammo`	`comment`	`libraries/common.xsd`
`add_build_to_construct_ship`	`comment`	`libraries/common.xsd`
`add_build_to_expand_station`	`comment`	`libraries/common.xsd`
`add_build_to_modify_ship`	`comment`	`libraries/common.xsd`
`add_cargo`	`comment`	`libraries/common.xsd`
`add_effect`	`comment`	`libraries/common.xsd`
`add_encyclopedia_entry`	`comment`	`libraries/common.xsd`
`add_inventory`	`comment`	`libraries/common.xsd`
`add_licence`	`comment`	`libraries/common.xsd`
`add_long_range_scan_effect`	`comment`	`libraries/common.xsd`
`add_player_choice`	`comment`	`libraries/common.xsd`
`add_player_discount`	`comment`	`libraries/common.xsd`
`add_to_group`	`comment`	`libraries/common.xsd`
`add_units`	`comment`	`libraries/common.xsd`
`append_list_elements`	`comment`	`libraries/common.xsd`
`append_to_list`	`comment`	`libraries/common.xsd`
`apply_loadout`	`comment`	`libraries/common.xsd`
`assign_control_entity`	`comment`	`libraries/common.xsd`
`assign_hired_actor`	`comment`	`libraries/common.xsd`
`break`	`comment`	`libraries/common.xsd`
`can_safely_extend_build_plot`	`comment`	`libraries/common.xsd`
`cancel_all_orders`	`comment`	`libraries/common.xsd`
`cancel_conversation`	`comment`	`libraries/common.xsd`
`cancel_cue`	`comment`	`libraries/md.xsd`
`cancel_order`	`comment`	`libraries/common.xsd`
`check_any`	`comment`	`libraries/aiscripts.xsd`
`check_any`	`comment`	`libraries/md.xsd`
`check_value`	`comment`	`libraries/common.xsd`
`clear_actor_lookat`	`comment`	`libraries/common.xsd`
`clear_actor_roomslot`	`comment`	`libraries/common.xsd`
`clear_group`	`comment`	`libraries/common.xsd`
`collect_drop`	`comment`	`libraries/common.xsd`
`continue`	`comment`	`libraries/common.xsd`
`create_build_storage`	`comment`	`libraries/common.xsd`
`create_control_entity`	`comment`	`libraries/common.xsd`
`create_cue_actor`	`comment`	`libraries/md.xsd`
`create_dynamic_interior`	`comment`	`libraries/common.xsd`
`create_formation`	`comment`	`libraries/common.xsd`
`create_group`	`comment`	`libraries/common.xsd`
`create_loadout`	`comment`	`libraries/common.xsd`
`create_lockbox`	`comment`	`libraries/common.xsd`
`create_npc_template`	`comment`	`libraries/common.xsd`
`create_object`	`comment`	`libraries/common.xsd`
`create_order`	`comment`	`libraries/common.xsd`
`create_position`	`comment`	`libraries/common.xsd`
`create_ship`	`comment`	`libraries/common.xsd`
`create_signal_leak`	`comment`	`libraries/common.xsd`
`create_station`	`comment`	`libraries/common.xsd`
`create_trade_computer`	`comment`	`libraries/common.xsd`
`create_trade_offer`	`comment`	`libraries/common.xsd`
`create_trade_order`	`comment`	`libraries/common.xsd`
`debug_text`	`comment`	`libraries/common.xsd`
`delay`	`comment`	`libraries/md.xsd`
`destroy_object`	`comment`	`libraries/common.xsd`
`disable_collision_response`	`comment`	`libraries/common.xsd`
`disable_travel_mode`	`comment`	`libraries/common.xsd`
`dismiss_control_entity`	`comment`	`libraries/common.xsd`
`do_all`	`comment`	`libraries/aiscripts.xsd`
`do_all`	`comment`	`libraries/md.xsd`
`do_else`	`comment`	`libraries/aiscripts.xsd`
`do_else`	`comment`	`libraries/md.xsd`
`do_elseif`	`comment`	`libraries/aiscripts.xsd`
`do_elseif`	`comment`	`libraries/md.xsd`
`do_for_each`	`comment`	`libraries/aiscripts.xsd`
`do_for_each`	`comment`	`libraries/md.xsd`
`do_if`	`comment`	`libraries/aiscripts.xsd`
`do_if`	`comment`	`libraries/md.xsd`
`do_while`	`comment`	`libraries/aiscripts.xsd`
`do_while`	`comment`	`libraries/md.xsd`
`downgrade_software`	`comment`	`libraries/common.xsd`
`drop_cargo`	`comment`	`libraries/common.xsd`
`edit_order_param`	`comment`	`libraries/common.xsd`
`enable_collision_response`	`comment`	`libraries/common.xsd`
`end_boarding_operation`	`comment`	`libraries/common.xsd`
`engine`	`comment`	`libraries/gamestarts.xsd`
`event_boarding_operation_created`	`comment`	`libraries/common.xsd`
`event_build_added`	`comment`	`libraries/common.xsd`
`event_build_cancelled`	`comment`	`libraries/common.xsd`
`event_build_finished`	`comment`	`libraries/common.xsd`
`event_character_animation_finished`	`comment`	`libraries/common.xsd`
`event_character_animation_started`	`comment`	`libraries/common.xsd`
`event_conversation_finished`	`comment`	`libraries/common.xsd`
`event_conversation_next_section`	`comment`	`libraries/common.xsd`
`event_conversation_returned_to_section`	`comment`	`libraries/common.xsd`
`event_conversation_started`	`comment`	`libraries/common.xsd`
`event_countermeasure_launched`	`comment`	`libraries/common.xsd`
`event_cue_signalled`	`comment`	`libraries/md.xsd`
`event_cutscene_started`	`comment`	`libraries/common.xsd`
`event_cutscene_stopped`	`comment`	`libraries/common.xsd`
`event_game_loaded`	`comment`	`libraries/common.xsd`
`event_game_saved`	`comment`	`libraries/common.xsd`
`event_long_range_scan_sent`	`comment`	`libraries/common.xsd`
`event_object_changed_true_owner`	`comment`	`libraries/common.xsd`
`event_object_collided`	`comment`	`libraries/common.xsd`
`event_object_destroyed`	`comment`	`libraries/common.xsd`
`event_object_dock_too_far`	`comment`	`libraries/common.xsd`
`event_object_docked`	`comment`	`libraries/common.xsd`
`event_object_docking_aborted`	`comment`	`libraries/common.xsd`
`event_object_docking_denied`	`comment`	`libraries/common.xsd`
`event_object_docking_impossible`	`comment`	`libraries/common.xsd`
`event_object_docking_queued`	`comment`	`libraries/common.xsd`
`event_object_order_cancelled`	`comment`	`libraries/common.xsd`
`event_object_order_finished`	`comment`	`libraries/common.xsd`
`event_object_order_ready`	`comment`	`libraries/common.xsd`
`event_object_signalled`	`comment`	`libraries/common.xsd`
`event_object_undocked_from`	`comment`	`libraries/common.xsd`
`event_object_undocking_started`	`comment`	`libraries/common.xsd`
`event_player_interaction`	`comment`	`libraries/common.xsd`
`event_trade_completed`	`comment`	`libraries/common.xsd`
`event_ui_triggered`	`comment`	`libraries/common.xsd`
`event_weapon_fired`	`comment`	`libraries/common.xsd`
`extend_build_plot`	`comment`	`libraries/common.xsd`
`find_asteroid_with_yield_in_sector`	`comment`	`libraries/common.xsd`
`find_buy_offer`	`comment`	`libraries/common.xsd`
`find_closest_resource`	`comment`	`libraries/common.xsd`
`find_cluster`	`comment`	`libraries/common.xsd`
`find_dockingbay`	`comment`	`libraries/common.xsd`
`find_inventoryconsole_slot`	`comment`	`libraries/common.xsd`
`find_inventoryworkbench_slot`	`comment`	`libraries/common.xsd`
`find_npc_slot`	`comment`	`libraries/common.xsd`
`find_object`	`comment`	`libraries/common.xsd`
`find_object_component`	`comment`	`libraries/common.xsd`
`find_player_transporter_slot`	`comment`	`libraries/common.xsd`
`find_resource_area`	`comment`	`libraries/common.xsd`
`find_room`	`comment`	`libraries/common.xsd`
`find_sector`	`comment`	`libraries/common.xsd`
`find_sector_in_range`	`comment`	`libraries/common.xsd`
`find_sell_offer`	`comment`	`libraries/common.xsd`
`find_ship`	`comment`	`libraries/common.xsd`
`find_ship_by_true_owner`	`comment`	`libraries/common.xsd`
`find_station`	`comment`	`libraries/common.xsd`
`find_station_by_true_owner`	`comment`	`libraries/common.xsd`
`fire_turret`	`comment`	`libraries/common.xsd`
`force_start_travel_mode`	`comment`	`libraries/common.xsd`
`get_control_entities`	`comment`	`libraries/common.xsd`
`get_floor_position`	`comment`	`libraries/common.xsd`
`get_loadout`	`comment`	`libraries/common.xsd`
`get_ship_definition`	`comment`	`libraries/common.xsd`
`get_zone_at_position`	`comment`	`libraries/common.xsd`
`include_interrupt_actions`	`comment`	`libraries/aiscripts.xsd`
`install_software`	`comment`	`libraries/common.xsd`
`interaction`	`comment`	`libraries/md.xsd`
`launch_countermeasures`	`comment`	`libraries/common.xsd`
`launch_drone`	`comment`	`libraries/common.xsd`
`launch_lasertower`	`comment`	`libraries/common.xsd`
`launch_mine`	`comment`	`libraries/common.xsd`
`launch_navbeacon`	`comment`	`libraries/common.xsd`
`launch_resourceprobe`	`comment`	`libraries/common.xsd`
`launch_satellite`	`comment`	`libraries/common.xsd`
`leave_control_position`	`comment`	`libraries/md.xsd`
`leave_formation`	`comment`	`libraries/common.xsd`
`level`	`comment`	`libraries/common.xsd`
`level`	`comment`	`libraries/diplomacy.xsd`
`level`	`comment`	`libraries/gamestarts.xsd`
`loadout`	`comment`	`libraries/gamestarts.xsd`
`lock_all_firstperson_input`	`comment`	`libraries/md.xsd`
`lock_all_flight_input`	`comment`	`libraries/md.xsd`
`lock_all_shooting_input`	`comment`	`libraries/md.xsd`
`match_content`	`comment`	`libraries/common.xsd`
`match_distance`	`comment`	`libraries/common.xsd`
`match_dock`	`comment`	`libraries/common.xsd`
`match_relation_to`	`comment`	`libraries/common.xsd`
`move_order`	`comment`	`libraries/common.xsd`
`name`	`comment`	`libraries/common.xsd`
`open_conversation_menu`	`comment`	`libraries/common.xsd`
`owner`	`comment`	`libraries/common.xsd`
`patch`	`comment`	`libraries/aiscripts.xsd`
`patch`	`comment`	`libraries/md.xsd`
`pause_spacesuit_oxygen`	`comment`	`libraries/common.xsd`
`pilot`	`comment`	`libraries/common.xsd`
`pilot`	`comment`	`libraries/gamestarts.xsd`
`play_cutscene`	`comment`	`libraries/common.xsd`
`play_sound`	`comment`	`libraries/common.xsd`
`position`	`comment`	`libraries/aiscripts.xsd`
`position`	`comment`	`libraries/common.xsd`
`position`	`comment`	`libraries/gamestarts.xsd`
`price`	`comment`	`libraries/common.xsd`
`quality`	`comment`	`libraries/common.xsd`
`quantity`	`comment`	`libraries/common.xsd`
`raise_lua_event`	`comment`	`libraries/common.xsd`
`reassign_existing_people`	`comment`	`libraries/common.xsd`
`refposition`	`comment`	`libraries/common.xsd`
`reinitialise_control_entities`	`comment`	`libraries/common.xsd`
`release_detached_subordinate_group`	`comment`	`libraries/common.xsd`
`remove_ammo`	`comment`	`libraries/common.xsd`
`remove_build`	`comment`	`libraries/common.xsd`
`remove_cargo`	`comment`	`libraries/common.xsd`
`remove_cue_actor`	`comment`	`libraries/md.xsd`
`remove_docking_request`	`comment`	`libraries/common.xsd`
`remove_dynamic_interior`	`comment`	`libraries/common.xsd`
`remove_effect`	`comment`	`libraries/common.xsd`
`remove_from_group`	`comment`	`libraries/common.xsd`
`remove_from_list`	`comment`	`libraries/common.xsd`
`remove_inventory`	`comment`	`libraries/common.xsd`
`remove_licence`	`comment`	`libraries/common.xsd`
`remove_npc_template`	`comment`	`libraries/common.xsd`
`remove_object_account`	`comment`	`libraries/common.xsd`
`remove_object_commander`	`comment`	`libraries/common.xsd`
`remove_player_discount`	`comment`	`libraries/common.xsd`
`remove_trade_offer`	`comment`	`libraries/common.xsd`
`remove_undocking_request`	`comment`	`libraries/common.xsd`
`remove_units`	`comment`	`libraries/common.xsd`
`remove_value`	`comment`	`libraries/common.xsd`
`request_docking`	`comment`	`libraries/common.xsd`
`reserve_build_plot`	`comment`	`libraries/common.xsd`
`reset_cue`	`comment`	`libraries/md.xsd`
`return`	`comment`	`libraries/common.xsd`
`reward_player`	`comment`	`libraries/common.xsd`
`rotation`	`comment`	`libraries/aiscripts.xsd`
`rotation`	`comment`	`libraries/common.xsd`
`rotation`	`comment`	`libraries/gamestarts.xsd`
`run_actions`	`comment`	`libraries/md.xsd`
`run_script`	`comment`	`libraries/aiscripts.xsd`
`safepos`	`comment`	`libraries/common.xsd`
`select`	`comment`	`libraries/common.xsd`
`set_actor_lookat`	`comment`	`libraries/common.xsd`
`set_ammo`	`comment`	`libraries/common.xsd`
`set_build_plot`	`comment`	`libraries/common.xsd`
`set_cockpit_tint`	`comment`	`libraries/common.xsd`
`set_conversation_return_section`	`comment`	`libraries/common.xsd`
`set_entity_role`	`comment`	`libraries/common.xsd`
`set_entity_traits`	`comment`	`libraries/common.xsd`
`set_entity_type`	`comment`	`libraries/common.xsd`
`set_faction_identity`	`comment`	`libraries/common.xsd`
`set_faction_relation`	`comment`	`libraries/common.xsd`
`set_faction_relation_locked`	`comment`	`libraries/common.xsd`
`set_known`	`comment`	`libraries/common.xsd`
`set_npc_template_role`	`comment`	`libraries/common.xsd`
`set_object_account`	`comment`	`libraries/common.xsd`
`set_object_active`	`comment`	`libraries/common.xsd`
`set_object_commander`	`comment`	`libraries/common.xsd`
`set_object_fleet_name`	`comment`	`libraries/common.xsd`
`set_object_hull`	`comment`	`libraries/common.xsd`
`set_object_max_budget`	`comment`	`libraries/common.xsd`
`set_object_min_budget`	`comment`	`libraries/common.xsd`
`set_object_min_hull`	`comment`	`libraries/common.xsd`
`set_object_name`	`comment`	`libraries/common.xsd`
`set_object_shield`	`comment`	`libraries/common.xsd`
`set_object_velocity`	`comment`	`libraries/common.xsd`
`set_owner`	`comment`	`libraries/common.xsd`
`set_player_entity_position`	`comment`	`libraries/common.xsd`
`set_production_paused`	`comment`	`libraries/common.xsd`
`set_room_locked`	`comment`	`libraries/common.xsd`
`set_skill`	`comment`	`libraries/common.xsd`
`set_spacesuit_oxygen`	`comment`	`libraries/common.xsd`
`set_subordinate_group_assignment`	`comment`	`libraries/common.xsd`
`set_turret_targets`	`comment`	`libraries/common.xsd`
`set_value`	`comment`	`libraries/common.xsd`
`signal_cue`	`comment`	`libraries/md.xsd`
`signal_cue_instantly`	`comment`	`libraries/md.xsd`
`signal_objects`	`comment`	`libraries/common.xsd`
`spawn_docked`	`comment`	`libraries/common.xsd`
`speak`	`comment`	`libraries/common.xsd`
`start_actor_sequence`	`comment`	`libraries/common.xsd`
`start_conversation`	`comment`	`libraries/common.xsd`
`start_script`	`comment`	`libraries/common.xsd`
`stop_cutscene`	`comment`	`libraries/common.xsd`
`teleport_player`	`comment`	`libraries/common.xsd`
`transfer_money`	`comment`	`libraries/common.xsd`
`trigger_animation`	`comment`	`libraries/common.xsd`
`undock`	`comment`	`libraries/common.xsd`
`uninstall_software`	`comment`	`libraries/common.xsd`
`unlock_all_firstperson_input`	`comment`	`libraries/md.xsd`
`unlock_all_flight_input`	`comment`	`libraries/md.xsd`
`unlock_all_shooting_input`	`comment`	`libraries/md.xsd`
`unpause_spacesuit_oxygen`	`comment`	`libraries/common.xsd`
`variation`	`comment`	`libraries/common.xsd`
`wait`	`comment`	`libraries/aiscripts.xsd`
`warp`	`comment`	`libraries/common.xsd`
`weapon`	`comment`	`libraries/gamestarts.xsd`

All schema types · Lua / MD value types

Meaning#

Schema structure#

Example and result#

Used by#

Sources and verification

Read next