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 see: 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 note: 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)

property can_add

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

Type

(bool)

property can_check_in

[Read-Only] Determine if this file can be checked in.

Type

(bool)

property can_check_out

[Read-Only] Determine if this file can be checked out

Type

(bool)

property can_delete

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

Type

(bool)

property can_edit

[Read-Only] Determine if source control allows this file to be edited

Type

(bool)

property can_revert

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

Type

(bool)

property checked_out_other

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

Type

(str)

property filename

[Read-Only] Get the local filename that this state represents

Type

(str)

property is_added

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

Type

(bool)

property is_checked_out

[Read-Only] Determine if this file is checked out

Type

(bool)

property is_checked_out_other

[Read-Only] Determine if this file is checked out by someone else

Type

(bool)

property is_conflicted

[Read-Only] Determine if this file is in a conflicted state

Type

(bool)

property is_current

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

Type

(bool)

property is_deleted

[Read-Only] Determine if this file is marked for delete

Type

(bool)

property is_ignored

[Read-Only] Determine if this file is ignored by source control

Type

(bool)

property is_modified

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

Type

(bool)

property is_source_controlled

[Read-Only] Determine if this file is under source control

Type

(bool)

property is_unknown

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

Type

(bool)

property is_valid

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

Type

(bool)