Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Choose Variables from Dropdowns #986

Merged
merged 1 commit into from
Oct 27, 2024
Merged

Choose Variables from Dropdowns #986

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion livesplit-core
Open in desktop
Submodule livesplit-core updated 1 files
+17 −3 capi/src/text_component.rs
15 changes: 15 additions & 0 deletions src/ui/LSOCommandSink.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ interface Callbacks {
handleEvent(event: Event): void,
runChanged(): void,
runNotModifiedAnymore(): void,
encounteredCustomVariable(name: string): void,
}


Expand Down Expand Up @@ -361,6 +362,7 @@ export class LSOCommandSink {
const result = Event.CustomVariableSet;

this.callbacks.handleEvent(result);
this.callbacks.encounteredCustomVariable(name);

return result;
}
Expand Down Expand Up @@ -440,6 +442,19 @@ export class LSOCommandSink {
return comparisons;
}

public getAllCustomVariables(): Set<string> {
const customVariables = new Set<string>();
using customVariablesIter = this.getRun().metadata().customVariables();
while (true) {
const element = customVariablesIter.next();
if (element === null) {
break;
}
customVariables.add(element.name());
}
return customVariables;
}

public currentTimingMethod(): TimingMethod {
return this.timer.currentTimingMethod();
}
Expand Down
25 changes: 25 additions & 0 deletions src/ui/LayoutEditor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ export interface Props {
layoutHeight: number,
generalSettings: GeneralSettings,
allComparisons: string[],
allVariables: Set<string>,
isDesktop: boolean,
commandSink: LSOCommandSink,
renderer: WebRenderer,
Expand Down Expand Up @@ -105,6 +106,7 @@ export class LayoutEditor extends React.Component<Props, State> {
state={this.state.editor.component_settings}
editorUrlCache={this.props.layoutEditorUrlCache}
allComparisons={this.props.allComparisons}
allVariables={this.props.allVariables}
setValue={(index, value) => {
this.props.editor.setComponentSettingsValue(index, value);
this.update();
Expand All @@ -117,6 +119,7 @@ export class LayoutEditor extends React.Component<Props, State> {
state={this.state.editor.general_settings}
editorUrlCache={this.props.layoutEditorUrlCache}
allComparisons={this.props.allComparisons}
allVariables={this.props.allVariables}
setValue={(index, value) => {
this.props.editor.setGeneralSettingsValue(
index,
Expand Down Expand Up @@ -234,6 +237,21 @@ export class LayoutEditor extends React.Component<Props, State> {
Shows the total amount of time that the current category has been played for.
</span>
</MenuItem>
{
this.props.allVariables.size > 0 && <MenuItem divider />
}
{
this.props.allVariables.size > 0 && Array.from(this.props.allVariables).map((name) => {
return (
<MenuItem className="tooltip" key={name} onClick={(_) => this.addVariable(name)}>
{name}
<span className="tooltip-text">
Creates a text component that shows the value of the custom variable "{name}".
</span>
</MenuItem>
);
})
}
<MenuItem divider />
<MenuItem className="tooltip" onClick={(_) => this.addComponent(LiveSplit.BlankSpaceComponent)}>
Blank Space
Expand Down Expand Up @@ -381,6 +399,13 @@ export class LayoutEditor extends React.Component<Props, State> {
this.update(true);
}

private addVariable(name: string) {
const textComponent = LiveSplit.TextComponent.new();
textComponent.useVariable(name, true);
this.props.editor.addComponent(textComponent.intoGeneric());
this.update(true);
}

private removeComponent() {
this.props.editor.removeComponent();
this.update();
Expand Down
20 changes: 20 additions & 0 deletions src/ui/LiveSplit.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ export interface State {
currentPhase: TimerPhase,
currentSplitIndex: number,
allComparisons: string[],
allVariables: Set<string>,
splitsModified: boolean,
layoutModified: boolean,
}
Expand Down Expand Up @@ -219,6 +220,7 @@ export class LiveSplit extends React.Component<Props, State> {
currentPhase: commandSink.currentPhase(),
currentSplitIndex: commandSink.currentSplitIndex(),
allComparisons: commandSink.getAllComparisons(),
allVariables: commandSink.getAllCustomVariables(),
splitsModified: commandSink.hasBeenModified(),
layoutModified: false,
};
Expand Down Expand Up @@ -321,6 +323,7 @@ export class LiveSplit extends React.Component<Props, State> {
callbacks={this}
runEditorUrlCache={this.state.runEditorUrlCache}
allComparisons={this.state.allComparisons}
allVariables={this.state.allVariables}
generalSettings={this.state.generalSettings}
/>;
} else if (this.state.menu.kind === MenuKind.LayoutEditor) {
Expand All @@ -333,6 +336,7 @@ export class LiveSplit extends React.Component<Props, State> {
layoutHeight={this.state.layoutHeight}
generalSettings={this.state.generalSettings}
allComparisons={this.state.allComparisons}
allVariables={this.state.allVariables}
isDesktop={this.state.isDesktop}
commandSink={this.state.commandSink}
renderer={this.state.renderer}
Expand All @@ -347,6 +351,7 @@ export class LiveSplit extends React.Component<Props, State> {
commandSink={this.state.commandSink}
serverConnection={this.state.serverConnection}
allComparisons={this.state.allComparisons}
allVariables={this.state.allVariables}
/>;
} else if (this.state.menu.kind === MenuKind.About) {
view = <About callbacks={this} />;
Expand Down Expand Up @@ -899,12 +904,27 @@ export class LiveSplit extends React.Component<Props, State> {
this.currentSplitChanged();
this.comparisonListChanged();
this.splitsModifiedChanged();

if (this.state != null) {
this.setState({
allVariables: this.state.commandSink.getAllCustomVariables(),
});
}
}

runNotModifiedAnymore(): void {
this.splitsModifiedChanged();
}

encounteredCustomVariable(name: string): void {
if (this.state.allVariables.has(name)) {
return;
}
this.setState({
allVariables: new Set([...this.state.allVariables, name]),
});
}

private currentComparisonChanged(): void {
if (this.state != null) {
const currentComparison = this.state.commandSink.currentComparison();
Expand Down
4 changes: 4 additions & 0 deletions src/ui/MainSettings.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ export interface Props {
serverConnection: Option<LiveSplitServer>,
commandSink: LSOCommandSink,
allComparisons: string[],
allVariables: Set<string>,
}

export interface State {
Expand Down Expand Up @@ -138,6 +139,7 @@ export class MainSettings extends React.Component<Props, State> {
state={this.state.settings}
editorUrlCache={this.props.urlCache}
allComparisons={this.props.allComparisons}
allVariables={this.props.allVariables}
setValue={(index, value) => {
if (!this.props.hotkeyConfig.setValue(index, value)) {
toast.error("The hotkey is already in use.");
Expand All @@ -155,6 +157,7 @@ export class MainSettings extends React.Component<Props, State> {
}}
editorUrlCache={this.props.urlCache}
allComparisons={this.props.allComparisons}
allVariables={this.props.allVariables}
setValue={(index, value) => {
switch (index) {
case 0:
Expand Down Expand Up @@ -259,6 +262,7 @@ export class MainSettings extends React.Component<Props, State> {
}}
editorUrlCache={this.props.urlCache}
allComparisons={this.props.allComparisons}
allVariables={this.props.allVariables}
setValue={(index, value) => {
switch (index) {
case 0:
Expand Down
2 changes: 2 additions & 0 deletions src/ui/RunEditor.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ export interface Props {
callbacks: Callbacks,
runEditorUrlCache: UrlCache,
allComparisons: string[],
allVariables: Set<string>,
generalSettings: GeneralSettings,
}
export interface State {
Expand Down Expand Up @@ -870,6 +871,7 @@ export class RunEditor extends React.Component<Props, State> {
state={{ fields }}
editorUrlCache={this.props.runEditorUrlCache}
allComparisons={this.props.allComparisons}
allVariables={this.props.allVariables}
setValue={(index, value) => {
function unwrapString(value: ExtendedSettingsDescriptionValueJson): string {
if ("String" in value) {
Expand Down
61 changes: 48 additions & 13 deletions src/ui/Settings.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ export interface Props<T> {
factory: SettingValueFactory<T>,
editorUrlCache: UrlCache,
allComparisons: string[],
allVariables: Set<string>,
}

export interface ExtendedSettingsDescriptionJson {
Expand Down Expand Up @@ -246,19 +247,53 @@ export class SettingsComponent<T> extends React.Component<Props<T>> {
</div>
);
} else if ("String" in value) {
component = (
<div className="settings-value-box">
<input
value={value.String}
onChange={(e) => {
this.props.setValue(
valueIndex,
factory.fromString(e.target.value),
);
}}
/>
</div>
);
// FIXME: This is a hack that we need for now until the way
// settings are represented is refactored.
if (typeof (field.text) === "string" && /^Variable/.test(field.text)) {
if (this.props.allVariables.size === 0) {
component = <div className="settings-value-box">
<span className="tooltip" style={{ textAlign: "center" }} >
No variables available
<span className="tooltip-text">
Custom variables can be defined in the Variables tab when
editing splits. Additional custom variables can be provided
automatically by auto splitters.
</span>
</span>
</div>;
} else {
component = <div className="settings-value-box">
<select
value={value.String ?? ""}
onChange={(e) => {
this.props.setValue(
valueIndex,
factory.fromString(e.target.value),
);
}}
>
<option value="" />
{Array.from(this.props.allVariables).map((variable) =>
<option>{variable}</option>
)}
</select>
</div>;
}
} else {
component = (
<div className="settings-value-box">
<input
value={value.String}
onChange={(e) => {
this.props.setValue(
valueIndex,
factory.fromString(e.target.value),
);
}}
/>
</div>
);
}
} else if ("OptionalString" in value) {
// FIXME: This is a hack that we need for now until the way
// settings are represented is refactored.
Expand Down