unreal.SourceControlState

class unreal.SourceControlState(filename='', is_valid=False, is_unknown=False, can_check_in=False, can_check_out=False, is_checked_out=False, is_current=False, is_source_controlled=False, is_added=False, is_deleted=False, is_ignored=False, can_edit=False, can_delete=False, is_modified=False, can_add=False, is_conflicted=False, can_revert=False, is_checked_out_other=False, checked_out_other='')

Bases: unreal.StructBase

Snapshot of source control state of for a file USourceControlHelpers::QueryFileState():

C++ Source:

  • Module: SourceControl
  • File: SourceControlHelpers.h

Editor Properties: (see get_editor_property/set_editor_property)

  • can_add (bool): [Read-Only] Determine if this file can be added to source control (i.e. is part of the directory structure currently under source control)
  • can_check_in (bool): [Read-Only] Determine if this file can be checked in.
  • can_check_out (bool): [Read-Only] Determine if this file can be checked out
  • can_delete (bool): [Read-Only] Determine if source control allows this file to be deleted.
  • can_edit (bool): [Read-Only] Determine if source control allows this file to be edited
  • can_revert (bool): [Read-Only] Determine if this file can be reverted, i.e. discard changes and the file will no longer be checked-out.
  • checked_out_other (str): [Read-Only] Get name of other user who this file already checked out or “” if no other user has it checked out
  • filename (str): [Read-Only] Get the local filename that this state represents
  • is_added (bool): [Read-Only] Determine if this file is marked for add if already checked in then not considered mid add:
  • is_checked_out (bool): [Read-Only] Determine if this file is checked out
  • is_checked_out_other (bool): [Read-Only] Determine if this file is checked out by someone else
  • is_conflicted (bool): [Read-Only] Determine if this file is in a conflicted state
  • is_current (bool): [Read-Only] Determine if this file is up-to-date with the version in source control
  • is_deleted (bool): [Read-Only] Determine if this file is marked for delete
  • is_ignored (bool): [Read-Only] Determine if this file is ignored by source control
  • is_modified (bool): [Read-Only] Determine if this file is modified compared to the version in source control.
  • is_source_controlled (bool): [Read-Only] Determine if this file is under source control
  • is_unknown (bool): [Read-Only] Determine if we know anything about the source control state of this file
  • is_valid (bool): [Read-Only] Indicates whether this source control state has valid information (true) or not (false)
can_add

(bool) – [Read-Only] Determine if this file can be added to source control (i.e. is part of the directory structure currently under source control)

can_check_in

(bool) – [Read-Only] Determine if this file can be checked in.

can_check_out

(bool) – [Read-Only] Determine if this file can be checked out

can_delete

(bool) – [Read-Only] Determine if source control allows this file to be deleted.

can_edit

(bool) – [Read-Only] Determine if source control allows this file to be edited

can_revert

(bool) – [Read-Only] Determine if this file can be reverted, i.e. discard changes and the file will no longer be checked-out.

checked_out_other

(str) – [Read-Only] Get name of other user who this file already checked out or “” if no other user has it checked out

filename

(str) – [Read-Only] Get the local filename that this state represents

is_added

(bool) – [Read-Only] Determine if this file is marked for add if already checked in then not considered mid add:

is_checked_out

(bool) – [Read-Only] Determine if this file is checked out

is_checked_out_other

(bool) – [Read-Only] Determine if this file is checked out by someone else

is_conflicted

(bool) – [Read-Only] Determine if this file is in a conflicted state

is_current

(bool) – [Read-Only] Determine if this file is up-to-date with the version in source control

is_deleted

(bool) – [Read-Only] Determine if this file is marked for delete

is_ignored

(bool) – [Read-Only] Determine if this file is ignored by source control

is_modified

(bool) – [Read-Only] Determine if this file is modified compared to the version in source control.

is_source_controlled

(bool) – [Read-Only] Determine if this file is under source control

is_unknown

(bool) – [Read-Only] Determine if we know anything about the source control state of this file

is_valid

(bool) – [Read-Only] Indicates whether this source control state has valid information (true) or not (false)